Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* Support Endpoints
* Customer support articles, chatbot, and tickets endpoints
*/
import type { ApiEndpoint } from '@/types/api-docs';
export const supportEndpoints: ApiEndpoint[] = [
{
id: 'support-articles-list',
method: 'GET',
path: '/api/support/articles',
summary: 'List help articles',
description: 'Returns paginated list of published support articles',
category: 'support',
requiresAuth: false,
parameters: [
{ name: 'category', type: 'string', required: false, location: 'query', description: 'Filter by category' },
{ name: 'search', type: 'string', required: false, location: 'query', description: 'Search articles' },
{ name: 'page', type: 'number', required: false, location: 'query', description: 'Page number', example: 1 },
{ name: 'limit', type: 'number', required: false, location: 'query', description: 'Items per page', example: 20 },
],
responses: [
{
status: 200,
description: 'List of articles',
example: {
success: true,
data: [{ id: 1, title: 'Getting Started', slug: 'getting-started', category: 'general' }],
pagination: { page: 1, limit: 20, total: 50 },
},
},
],
},
{
id: 'support-articles-categories',
method: 'GET',
path: '/api/support/articles/categories',
summary: 'List article categories',
description: 'Returns all available article categories',
category: 'support',
requiresAuth: false,
responses: [
{
status: 200,
description: 'List of categories',
example: { success: true, data: ['general', 'orders', 'payments', 'shipping'] },
},
],
},
{
id: 'support-articles-get',
method: 'GET',
path: '/api/support/articles/{slug}',
summary: 'Get article by slug',
description: 'Returns a single support article by its URL slug',
category: 'support',
requiresAuth: false,
parameters: [
{ name: 'slug', type: 'string', required: true, location: 'path', description: 'Article URL slug' },
],
responses: [
{ status: 200, description: 'Article details' },
{ status: 404, description: 'Article not found' },
],
},
{
id: 'support-articles-helpful',
method: 'POST',
path: '/api/support/articles/{slug}/helpful',
summary: 'Vote article helpfulness',
description: 'Records whether an article was helpful or not',
category: 'support',
requiresAuth: false,
parameters: [
{ name: 'slug', type: 'string', required: true, location: 'path', description: 'Article URL slug' },
],
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'helpful', type: 'boolean', required: true, description: 'Whether the article was helpful' },
],
example: { helpful: true },
},
responses: [
{ status: 200, description: 'Vote recorded', example: { success: true, message: 'Thank you for your feedback!' } },
{ status: 404, description: 'Article not found' },
],
},
{
id: 'support-chatbot',
method: 'POST',
path: '/api/support/chatbot',
summary: 'Chat with support bot',
description: 'Send a message to the support chatbot and get a response with suggested articles',
category: 'support',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'message', type: 'string', required: false, description: 'User message to chatbot' },
{ name: 'welcome', type: 'boolean', required: false, description: 'Request welcome message' },
],
example: { message: 'How do I track my order?' },
},
responses: [
{
status: 200,
description: 'Chatbot response',
example: {
success: true,
data: {
message: 'You can track your order...',
suggestedArticles: [],
shouldEscalate: false,
},
},
},
],
},
{
id: 'support-tickets-list',
method: 'GET',
path: '/api/support/tickets',
summary: 'List user tickets',
description: 'Returns paginated list of support tickets for the authenticated user',
category: 'support',
requiresAuth: true,
parameters: [
{ name: 'status', type: 'string', required: false, location: 'query', description: 'Filter by status' },
{ name: 'page', type: 'number', required: false, location: 'query', description: 'Page number' },
{ name: 'limit', type: 'number', required: false, location: 'query', description: 'Items per page' },
{ name: 'sortBy', type: 'string', required: false, location: 'query', description: 'Sort field', enum: ['createdAt', 'updatedAt', 'status'] },
{ name: 'sortOrder', type: 'string', required: false, location: 'query', description: 'Sort order', enum: ['asc', 'desc'] },
],
responses: [
{ status: 200, description: 'List of tickets' },
{ status: 401, description: 'Authentication required' },
],
},
{
id: 'support-tickets-create',
method: 'POST',
path: '/api/support/tickets',
summary: 'Create support ticket',
description: 'Creates a new support ticket. Can be created by guests or authenticated users.',
category: 'support',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'customerEmail', type: 'string', required: true, description: 'Customer email address' },
{ name: 'customerName', type: 'string', required: true, description: 'Customer name' },
{ name: 'subject', type: 'string', required: true, description: 'Ticket subject' },
{ name: 'description', type: 'string', required: true, description: 'Ticket description' },
{ name: 'category', type: 'string', required: true, description: 'Ticket category' },
{ name: 'priority', type: 'string', required: false, description: 'Priority level', enum: ['LOW', 'MEDIUM', 'HIGH', 'URGENT'] },
{ name: 'orderId', type: 'number', required: false, description: 'Related order ID' },
{ name: 'productId', type: 'number', required: false, description: 'Related product ID' },
],
example: {
customerEmail: 'customer@example.com',
customerName: 'John Doe',
subject: 'Order not received',
description: 'I placed an order 5 days ago but have not received it.',
category: 'orders',
priority: 'MEDIUM',
},
},
responses: [
{ status: 201, description: 'Ticket created', example: { success: true, data: { ticketNumber: 'TKT-001' } } },
{ status: 400, description: 'Validation error' },
],
},
{
id: 'support-tickets-get',
method: 'GET',
path: '/api/support/tickets/{id}',
summary: 'Get ticket details',
description: 'Returns full details of a support ticket including messages',
category: 'support',
requiresAuth: true,
parameters: [
{ name: 'id', type: 'string', required: true, location: 'path', description: 'Ticket ID' },
],
responses: [
{ status: 200, description: 'Ticket details with messages' },
{ status: 401, description: 'Authentication required' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Ticket not found' },
],
},
{
id: 'support-tickets-messages-list',
method: 'GET',
path: '/api/support/tickets/{id}/messages',
summary: 'Get ticket messages',
description: 'Returns all messages for a support ticket',
category: 'support',
requiresAuth: true,
parameters: [
{ name: 'id', type: 'string', required: true, location: 'path', description: 'Ticket ID' },
],
responses: [
{ status: 200, description: 'List of messages' },
{ status: 401, description: 'Authentication required' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Ticket not found' },
],
},
{
id: 'support-tickets-messages-create',
method: 'POST',
path: '/api/support/tickets/{id}/messages',
summary: 'Add message to ticket',
description: 'Adds a new message to an existing support ticket',
category: 'support',
requiresAuth: true,
parameters: [
{ name: 'id', type: 'string', required: true, location: 'path', description: 'Ticket ID' },
],
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'content', type: 'string', required: true, description: 'Message content' },
],
example: { content: 'Thank you for your response. Here is additional information...' },
},
responses: [
{ status: 201, description: 'Message added' },
{ status: 400, description: 'Cannot add message to closed ticket' },
{ status: 401, description: 'Authentication required' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Ticket not found' },
],
},
{
id: 'support-tickets-close',
method: 'POST',
path: '/api/support/tickets/{id}/close',
summary: 'Close ticket',
description: 'Closes a support ticket. Can only be done by the ticket owner.',
category: 'support',
requiresAuth: true,
parameters: [
{ name: 'id', type: 'string', required: true, location: 'path', description: 'Ticket ID' },
],
responses: [
{ status: 200, description: 'Ticket closed' },
{ status: 400, description: 'Ticket cannot be closed' },
{ status: 401, description: 'Authentication required' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Ticket not found' },
],
},
{
id: 'support-tickets-survey',
method: 'POST',
path: '/api/support/tickets/{id}/survey',
summary: 'Submit satisfaction survey',
description: 'Submits a satisfaction survey for a resolved or closed ticket',
category: 'support',
requiresAuth: true,
parameters: [
{ name: 'id', type: 'string', required: true, location: 'path', description: 'Ticket ID' },
],
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'rating', type: 'number', required: true, description: 'Rating (1-5)' },
{ name: 'feedback', type: 'string', required: false, description: 'Optional feedback' },
{ name: 'wasHelpful', type: 'boolean', required: false, description: 'Was the support helpful' },
{ name: 'wouldRecommend', type: 'boolean', required: false, description: 'Would recommend to others' },
],
example: { rating: 5, feedback: 'Great support!', wasHelpful: true, wouldRecommend: true },
},
responses: [
{ status: 201, description: 'Survey submitted' },
{ status: 400, description: 'Survey already submitted or ticket not resolved' },
{ status: 401, description: 'Authentication required' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Ticket not found' },
],
},
// Live Chat Endpoints
{
id: 'chat-start',
method: 'POST',
path: '/api/chat/start',
summary: 'Start live chat',
description: 'Start a new live chat conversation or continue an existing one',
category: 'support',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'message', type: 'string', required: true, description: 'Initial message' },
{ name: 'visitorId', type: 'string', required: false, description: 'Visitor ID for anonymous users' },
{ name: 'relatedOrderId', type: 'number', required: false, description: 'Related order ID' },
{ name: 'metadata', type: 'object', required: false, description: 'Additional metadata (page, userAgent)' },
],
example: {
message: 'I need help with my order',
metadata: { currentPage: '/orders/123' },
},
},
responses: [
{
status: 200,
description: 'Conversation started',
example: {
success: true,
data: {
conversationId: 'conv_123',
messages: [],
isNewConversation: true,
},
},
},
{ status: 400, description: 'Validation error' },
],
},
{
id: 'chat-message',
method: 'POST',
path: '/api/chat/message',
summary: 'Send chat message',
description: 'Send a message in an existing live chat conversation',
category: 'support',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'conversationId', type: 'string', required: true, description: 'Conversation ID' },
{ name: 'content', type: 'string', required: true, description: 'Message content' },
{ name: 'contentType', type: 'string', required: false, description: 'Content type', enum: ['TEXT', 'IMAGE', 'FILE', 'QUICK_REPLIES'] },
{ name: 'attachments', type: 'array', required: false, description: 'File attachments' },
],
example: {
conversationId: 'conv_123',
content: 'Here is my order number: ORD-456',
},
},
responses: [
{ status: 200, description: 'Message sent', example: { success: true, data: { messages: [] } } },
{ status: 400, description: 'Conversation closed or validation error' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Conversation not found' },
],
},
{
id: 'chat-conversation-get',
method: 'GET',
path: '/api/chat/{conversationId}',
summary: 'Get chat conversation',
description: 'Get a live chat conversation with all messages',
category: 'support',
requiresAuth: false,
parameters: [
{ name: 'conversationId', type: 'string', required: true, location: 'path', description: 'Conversation ID' },
],
responses: [
{ status: 200, description: 'Conversation with messages' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Conversation not found' },
],
},
{
id: 'chat-conversation-feedback',
method: 'PATCH',
path: '/api/chat/{conversationId}',
summary: 'Submit chat feedback',
description: 'Submit feedback and rating for a chat conversation',
category: 'support',
requiresAuth: false,
parameters: [
{ name: 'conversationId', type: 'string', required: true, location: 'path', description: 'Conversation ID' },
],
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'rating', type: 'number', required: false, description: 'Rating (1-5)' },
{ name: 'feedback', type: 'string', required: false, description: 'Feedback text' },
],
example: { rating: 5, feedback: 'Very helpful!' },
},
responses: [
{ status: 200, description: 'Feedback submitted' },
{ status: 403, description: 'Access denied' },
{ status: 404, description: 'Conversation not found' },
],
},
];
|