@blezgo/api-sdk 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/generated.d.ts +193 -193
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +64 -64
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +96 -96
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +120 -120
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +84 -85
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +15 -15
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +100 -100
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +100 -100
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +12 -12
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +95 -95
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +169 -169
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +168 -168
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +38 -38
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +38 -38
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +196 -196
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +9 -9
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +88 -88
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +252 -252
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +58 -58
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +30 -30
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +25 -25
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +658 -658
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +46 -46
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +250 -250
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +70 -70
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +202 -202
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +25 -25
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +9 -9
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +30 -30
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +103 -103
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +94 -95
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +103 -103
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +77 -77
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +99 -99
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +9 -9
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +11 -11
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +131 -131
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +251 -251
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +183 -183
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +379 -379
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +9 -9
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +124 -124
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +59 -59
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +555 -558
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +9 -9
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +227 -227
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +34 -34
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +610 -610
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +286 -286
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +32 -32
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +164 -164
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +51 -51
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +899 -401
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +156 -156
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1028 -1028
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +247 -247
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +419 -419
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +9 -9
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1510 -1510
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +179 -179
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +537 -537
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +79 -79
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +343 -343
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +37 -37
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +33 -33
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +82 -82
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +280 -541
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +183 -183
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -2181,113 +2181,35 @@ export type webhooks = Record<string, never>;
|
|
|
2181
2181
|
export interface components {
|
|
2182
2182
|
schemas: {
|
|
2183
2183
|
/**
|
|
2184
|
-
*
|
|
2185
|
-
* @description Request model for
|
|
2186
|
-
* @example {
|
|
2187
|
-
* "context": {
|
|
2188
|
-
* "agent": {
|
|
2189
|
-
* "email": "jane@example.com",
|
|
2190
|
-
* "name": "Jane Smith"
|
|
2191
|
-
* },
|
|
2192
|
-
* "ticket": {
|
|
2193
|
-
* "customer_name": "John Doe",
|
|
2194
|
-
* "ticket_number": "TKT-12345"
|
|
2195
|
-
* }
|
|
2196
|
-
* }
|
|
2197
|
-
* }
|
|
2198
|
-
*/
|
|
2199
|
-
ApplyCannedResponseRequest: {
|
|
2200
|
-
/**
|
|
2201
|
-
* Context
|
|
2202
|
-
* @description Context data for placeholder replacement (e.g., ticket data, agent data)
|
|
2203
|
-
*/
|
|
2204
|
-
context: {
|
|
2205
|
-
[key: string]: unknown;
|
|
2206
|
-
};
|
|
2207
|
-
};
|
|
2208
|
-
/**
|
|
2209
|
-
* RateSatisfactionRequest
|
|
2210
|
-
* @description Request model for customer satisfaction rating
|
|
2211
|
-
*/
|
|
2212
|
-
RateSatisfactionRequest: {
|
|
2213
|
-
/**
|
|
2214
|
-
* Rating
|
|
2215
|
-
* @description Satisfaction rating 1-5
|
|
2216
|
-
*/
|
|
2217
|
-
rating: number;
|
|
2218
|
-
/**
|
|
2219
|
-
* Comment
|
|
2220
|
-
* @description Additional feedback
|
|
2221
|
-
*/
|
|
2222
|
-
comment?: string | null;
|
|
2223
|
-
};
|
|
2224
|
-
/**
|
|
2225
|
-
* PeriodType
|
|
2226
|
-
* @description Period type for metrics snapshots
|
|
2227
|
-
* @enum {string}
|
|
2228
|
-
*/
|
|
2229
|
-
PeriodType: "daily" | "weekly" | "monthly";
|
|
2230
|
-
/**
|
|
2231
|
-
* CreateTeamRequest
|
|
2232
|
-
* @description Request model for creating a team
|
|
2184
|
+
* UpdateTeamRequest
|
|
2185
|
+
* @description Request model for updating a team
|
|
2233
2186
|
*/
|
|
2234
|
-
|
|
2235
|
-
/**
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
*/
|
|
2239
|
-
team_name: string;
|
|
2240
|
-
/**
|
|
2241
|
-
* Description
|
|
2242
|
-
* @description Team description
|
|
2243
|
-
*/
|
|
2187
|
+
UpdateTeamRequest: {
|
|
2188
|
+
/** Team Name */
|
|
2189
|
+
team_name?: string | null;
|
|
2190
|
+
/** Description */
|
|
2244
2191
|
description?: string | null;
|
|
2245
|
-
/**
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
* @default general
|
|
2249
|
-
*/
|
|
2250
|
-
team_type: string;
|
|
2251
|
-
/**
|
|
2252
|
-
* Team Lead User Id
|
|
2253
|
-
* @description User ID of team leader
|
|
2254
|
-
*/
|
|
2192
|
+
/** Team Type */
|
|
2193
|
+
team_type?: string | null;
|
|
2194
|
+
/** Team Lead User Id */
|
|
2255
2195
|
team_lead_user_id?: number | null;
|
|
2256
2196
|
/** Team Lead Name */
|
|
2257
2197
|
team_lead_name?: string | null;
|
|
2258
2198
|
/** Team Lead Email */
|
|
2259
2199
|
team_lead_email?: string | null;
|
|
2260
|
-
/**
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
*/
|
|
2265
|
-
auto_assign_enabled: boolean;
|
|
2266
|
-
/**
|
|
2267
|
-
* Assignment Strategy
|
|
2268
|
-
* @description round_robin, least_active, skill_based, random
|
|
2269
|
-
* @default round_robin
|
|
2270
|
-
*/
|
|
2271
|
-
assignment_strategy: string;
|
|
2200
|
+
/** Auto Assign Enabled */
|
|
2201
|
+
auto_assign_enabled?: boolean | null;
|
|
2202
|
+
/** Assignment Strategy */
|
|
2203
|
+
assignment_strategy?: string | null;
|
|
2272
2204
|
/** Max Tickets Per Agent */
|
|
2273
2205
|
max_tickets_per_agent?: number | null;
|
|
2274
|
-
/**
|
|
2275
|
-
* Business Hours
|
|
2276
|
-
* @description Business hours schedule
|
|
2277
|
-
*/
|
|
2206
|
+
/** Business Hours */
|
|
2278
2207
|
business_hours?: {
|
|
2279
2208
|
[key: string]: unknown;
|
|
2280
2209
|
} | null;
|
|
2281
|
-
/**
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
* @default UTC
|
|
2285
|
-
*/
|
|
2286
|
-
timezone: string;
|
|
2287
|
-
/**
|
|
2288
|
-
* Routing Rules
|
|
2289
|
-
* @description Routing rules for auto-assignment
|
|
2290
|
-
*/
|
|
2210
|
+
/** Timezone */
|
|
2211
|
+
timezone?: string | null;
|
|
2212
|
+
/** Routing Rules */
|
|
2291
2213
|
routing_rules?: {
|
|
2292
2214
|
[key: string]: unknown;
|
|
2293
2215
|
} | null;
|
|
@@ -2295,24 +2217,19 @@ export interface components {
|
|
|
2295
2217
|
sla_first_response_minutes?: number | null;
|
|
2296
2218
|
/** Sla Resolution Minutes */
|
|
2297
2219
|
sla_resolution_minutes?: number | null;
|
|
2298
|
-
/**
|
|
2299
|
-
|
|
2300
|
-
* @default false
|
|
2301
|
-
*/
|
|
2302
|
-
escalation_enabled: boolean;
|
|
2220
|
+
/** Escalation Enabled */
|
|
2221
|
+
escalation_enabled?: boolean | null;
|
|
2303
2222
|
/** Escalation After Minutes */
|
|
2304
2223
|
escalation_after_minutes?: number | null;
|
|
2305
|
-
/**
|
|
2306
|
-
* Escalation Team Id
|
|
2307
|
-
* @description Team ID to escalate to
|
|
2308
|
-
*/
|
|
2224
|
+
/** Escalation Team Id */
|
|
2309
2225
|
escalation_team_id?: string | null;
|
|
2226
|
+
/** Is Default */
|
|
2227
|
+
is_default?: boolean | null;
|
|
2310
2228
|
/**
|
|
2311
|
-
*
|
|
2312
|
-
* @description
|
|
2313
|
-
* @default false
|
|
2229
|
+
* Status
|
|
2230
|
+
* @description active, inactive, archived
|
|
2314
2231
|
*/
|
|
2315
|
-
|
|
2232
|
+
status?: string | null;
|
|
2316
2233
|
/** Settings */
|
|
2317
2234
|
settings?: {
|
|
2318
2235
|
[key: string]: unknown;
|
|
@@ -2323,209 +2240,75 @@ export interface components {
|
|
|
2323
2240
|
} | null;
|
|
2324
2241
|
};
|
|
2325
2242
|
/**
|
|
2326
|
-
*
|
|
2327
|
-
* @description Request model for
|
|
2328
|
-
* @example {
|
|
2329
|
-
* "color": "#FF5733",
|
|
2330
|
-
* "description": "Technical bug or issue",
|
|
2331
|
-
* "tag_name": "Bug",
|
|
2332
|
-
* "tag_slug": "bug"
|
|
2333
|
-
* }
|
|
2243
|
+
* MarkFollowupRequest
|
|
2244
|
+
* @description Request model for marking follow-up as completed
|
|
2334
2245
|
*/
|
|
2335
|
-
|
|
2336
|
-
/**
|
|
2337
|
-
* Tag Name
|
|
2338
|
-
* @description Tag name
|
|
2339
|
-
*/
|
|
2340
|
-
tag_name: string;
|
|
2341
|
-
/**
|
|
2342
|
-
* Tag Slug
|
|
2343
|
-
* @description URL-friendly slug (lowercase, hyphens only)
|
|
2344
|
-
*/
|
|
2345
|
-
tag_slug: string;
|
|
2346
|
-
/**
|
|
2347
|
-
* Description
|
|
2348
|
-
* @description Tag description
|
|
2349
|
-
*/
|
|
2350
|
-
description?: string | null;
|
|
2246
|
+
MarkFollowupRequest: {
|
|
2351
2247
|
/**
|
|
2352
|
-
*
|
|
2353
|
-
* @description
|
|
2248
|
+
* Followup Notes
|
|
2249
|
+
* @description Follow-up notes
|
|
2354
2250
|
*/
|
|
2355
|
-
|
|
2251
|
+
followup_notes: string;
|
|
2356
2252
|
};
|
|
2357
2253
|
/**
|
|
2358
|
-
*
|
|
2359
|
-
* @description Request model for
|
|
2360
|
-
* @example {
|
|
2361
|
-
* "category": "greeting",
|
|
2362
|
-
* "content": "Hello {{ticket.customer_name}},\\n\\nThank you for contacting support. We received your request and will get back to you shortly.\\n\\nBest regards,\\n{{agent.name}}",
|
|
2363
|
-
* "content_type": "plain",
|
|
2364
|
-
* "is_public": true,
|
|
2365
|
-
* "response_name": "Greeting",
|
|
2366
|
-
* "response_slug": "greeting",
|
|
2367
|
-
* "shortcut": "/greeting",
|
|
2368
|
-
* "status": "active",
|
|
2369
|
-
* "subject": "Thank you for contacting us",
|
|
2370
|
-
* "tags": [
|
|
2371
|
-
* "initial",
|
|
2372
|
-
* "acknowledgment"
|
|
2373
|
-
* ]
|
|
2374
|
-
* }
|
|
2254
|
+
* SubmitRatingRequest
|
|
2255
|
+
* @description Request model for submitting a satisfaction rating
|
|
2375
2256
|
*/
|
|
2376
|
-
|
|
2377
|
-
/**
|
|
2378
|
-
* Response Name
|
|
2379
|
-
* @description Response name/title
|
|
2380
|
-
*/
|
|
2381
|
-
response_name: string;
|
|
2382
|
-
/**
|
|
2383
|
-
* Response Slug
|
|
2384
|
-
* @description URL-friendly slug
|
|
2385
|
-
*/
|
|
2386
|
-
response_slug: string;
|
|
2387
|
-
/**
|
|
2388
|
-
* Subject
|
|
2389
|
-
* @description Email subject (if applicable)
|
|
2390
|
-
*/
|
|
2391
|
-
subject?: string | null;
|
|
2392
|
-
/**
|
|
2393
|
-
* Content
|
|
2394
|
-
* @description Response content (supports placeholders like {{ticket.customer_name}})
|
|
2395
|
-
*/
|
|
2396
|
-
content: string;
|
|
2397
|
-
/**
|
|
2398
|
-
* Content Type
|
|
2399
|
-
* @description Content type (plain, html, markdown)
|
|
2400
|
-
* @default plain
|
|
2401
|
-
*/
|
|
2402
|
-
content_type: string;
|
|
2403
|
-
/**
|
|
2404
|
-
* Category
|
|
2405
|
-
* @description Response category (greeting, closing, solution, etc.)
|
|
2406
|
-
*/
|
|
2407
|
-
category?: string | null;
|
|
2408
|
-
/**
|
|
2409
|
-
* Tags
|
|
2410
|
-
* @description Tags for quick filtering
|
|
2411
|
-
*/
|
|
2412
|
-
tags?: string[] | null;
|
|
2413
|
-
/**
|
|
2414
|
-
* Is Public
|
|
2415
|
-
* @description Available to all agents
|
|
2416
|
-
* @default true
|
|
2417
|
-
*/
|
|
2418
|
-
is_public: boolean;
|
|
2257
|
+
SubmitRatingRequest: {
|
|
2419
2258
|
/**
|
|
2420
|
-
*
|
|
2421
|
-
* @description
|
|
2259
|
+
* Survey Token
|
|
2260
|
+
* @description Survey token
|
|
2422
2261
|
*/
|
|
2423
|
-
|
|
2262
|
+
survey_token: string;
|
|
2424
2263
|
/**
|
|
2425
|
-
*
|
|
2426
|
-
* @description
|
|
2264
|
+
* Rating
|
|
2265
|
+
* @description Rating (1-5 stars)
|
|
2427
2266
|
*/
|
|
2428
|
-
|
|
2267
|
+
rating: number;
|
|
2429
2268
|
/**
|
|
2430
|
-
*
|
|
2431
|
-
* @description
|
|
2269
|
+
* Feedback Text
|
|
2270
|
+
* @description Optional feedback text
|
|
2432
2271
|
*/
|
|
2433
|
-
|
|
2272
|
+
feedback_text?: string | null;
|
|
2434
2273
|
/**
|
|
2435
|
-
*
|
|
2436
|
-
* @description
|
|
2437
|
-
* @default active
|
|
2274
|
+
* Feedback Category
|
|
2275
|
+
* @description Feedback category
|
|
2438
2276
|
*/
|
|
2439
|
-
|
|
2277
|
+
feedback_category?: string | null;
|
|
2440
2278
|
};
|
|
2441
2279
|
/**
|
|
2442
|
-
*
|
|
2443
|
-
* @description Request model for updating
|
|
2444
|
-
* @example {
|
|
2445
|
-
* "status": "active",
|
|
2446
|
-
* "subject_template": "New Support Ticket #{{ticket_number}}",
|
|
2447
|
-
* "template_name": "Updated Ticket Created Template"
|
|
2448
|
-
* }
|
|
2280
|
+
* UpdateMacroRequest
|
|
2281
|
+
* @description Request model for updating a macro
|
|
2449
2282
|
*/
|
|
2450
|
-
|
|
2451
|
-
/**
|
|
2452
|
-
|
|
2283
|
+
UpdateMacroRequest: {
|
|
2284
|
+
/** Macro Name */
|
|
2285
|
+
macro_name?: string | null;
|
|
2286
|
+
/** Macro Slug */
|
|
2287
|
+
macro_slug?: string | null;
|
|
2453
2288
|
/** Description */
|
|
2454
2289
|
description?: string | null;
|
|
2455
|
-
/**
|
|
2456
|
-
|
|
2457
|
-
/** Body Html */
|
|
2458
|
-
body_html?: string | null;
|
|
2459
|
-
/** Body Text */
|
|
2460
|
-
body_text?: string | null;
|
|
2461
|
-
/** Available Variables */
|
|
2462
|
-
available_variables?: string[] | null;
|
|
2463
|
-
/** From Email */
|
|
2464
|
-
from_email?: string | null;
|
|
2465
|
-
/** From Name */
|
|
2466
|
-
from_name?: string | null;
|
|
2467
|
-
/** Reply To */
|
|
2468
|
-
reply_to?: string | null;
|
|
2469
|
-
/** Is Default */
|
|
2470
|
-
is_default?: boolean | null;
|
|
2471
|
-
status?: components["schemas"]["TemplateStatus"] | null;
|
|
2472
|
-
};
|
|
2473
|
-
/**
|
|
2474
|
-
* CreateSavedFilterRequest
|
|
2475
|
-
* @description Request model for creating a saved filter
|
|
2476
|
-
* @example {
|
|
2477
|
-
* "description": "All high priority tickets assigned to me",
|
|
2478
|
-
* "filter_config": {
|
|
2479
|
-
* "priority": [
|
|
2480
|
-
* "high",
|
|
2481
|
-
* "urgent"
|
|
2482
|
-
* ],
|
|
2483
|
-
* "status": [
|
|
2484
|
-
* "open",
|
|
2485
|
-
* "pending"
|
|
2486
|
-
* ]
|
|
2487
|
-
* },
|
|
2488
|
-
* "filter_name": "My High Priority Tickets",
|
|
2489
|
-
* "filter_slug": "my-high-priority",
|
|
2490
|
-
* "is_default": true,
|
|
2491
|
-
* "is_public": false
|
|
2492
|
-
* }
|
|
2493
|
-
*/
|
|
2494
|
-
CreateSavedFilterRequest: {
|
|
2495
|
-
/**
|
|
2496
|
-
* Filter Name
|
|
2497
|
-
* @description Filter name
|
|
2498
|
-
*/
|
|
2499
|
-
filter_name: string;
|
|
2500
|
-
/**
|
|
2501
|
-
* Filter Slug
|
|
2502
|
-
* @description URL-friendly slug
|
|
2503
|
-
*/
|
|
2504
|
-
filter_slug: string;
|
|
2505
|
-
/**
|
|
2506
|
-
* Description
|
|
2507
|
-
* @description Filter description
|
|
2508
|
-
*/
|
|
2509
|
-
description?: string | null;
|
|
2510
|
-
/**
|
|
2511
|
-
* Filter Config
|
|
2512
|
-
* @description Filter configuration (query, filters, sort)
|
|
2513
|
-
*/
|
|
2514
|
-
filter_config: {
|
|
2290
|
+
/** Actions */
|
|
2291
|
+
actions?: {
|
|
2515
2292
|
[key: string]: unknown;
|
|
2516
|
-
};
|
|
2517
|
-
/**
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
is_public
|
|
2523
|
-
/**
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2293
|
+
}[] | null;
|
|
2294
|
+
/** Include Response */
|
|
2295
|
+
include_response?: boolean | null;
|
|
2296
|
+
/** Canned Response Id */
|
|
2297
|
+
canned_response_id?: number | null;
|
|
2298
|
+
/** Is Public */
|
|
2299
|
+
is_public?: boolean | null;
|
|
2300
|
+
/** Team Ids */
|
|
2301
|
+
team_ids?: number[] | null;
|
|
2302
|
+
/** User Ids */
|
|
2303
|
+
user_ids?: number[] | null;
|
|
2304
|
+
/** Display Order */
|
|
2305
|
+
display_order?: number | null;
|
|
2306
|
+
/** Button Color */
|
|
2307
|
+
button_color?: string | null;
|
|
2308
|
+
/** Icon */
|
|
2309
|
+
icon?: string | null;
|
|
2310
|
+
/** Status */
|
|
2311
|
+
status?: string | null;
|
|
2529
2312
|
};
|
|
2530
2313
|
/**
|
|
2531
2314
|
* BulkUpdateStatusRequest
|
|
@@ -2544,347 +2327,244 @@ export interface components {
|
|
|
2544
2327
|
new_status: string;
|
|
2545
2328
|
};
|
|
2546
2329
|
/**
|
|
2547
|
-
*
|
|
2548
|
-
* @description Request model for
|
|
2330
|
+
* UpdateEmailConfigRequest
|
|
2331
|
+
* @description Request model for updating email configuration
|
|
2332
|
+
* @example {
|
|
2333
|
+
* "from_email": "noreply@company.com",
|
|
2334
|
+
* "from_name": "Company Support",
|
|
2335
|
+
* "inbound_email": "support@company.com",
|
|
2336
|
+
* "inbound_enabled": true,
|
|
2337
|
+
* "smtp_enabled": true,
|
|
2338
|
+
* "smtp_host": "smtp.gmail.com",
|
|
2339
|
+
* "smtp_port": 587,
|
|
2340
|
+
* "smtp_use_tls": true
|
|
2341
|
+
* }
|
|
2549
2342
|
*/
|
|
2550
|
-
|
|
2343
|
+
UpdateEmailConfigRequest: {
|
|
2551
2344
|
/**
|
|
2552
|
-
*
|
|
2553
|
-
* @description
|
|
2345
|
+
* Inbound Enabled
|
|
2346
|
+
* @description Enable email-to-ticket
|
|
2554
2347
|
*/
|
|
2555
|
-
|
|
2556
|
-
};
|
|
2557
|
-
/**
|
|
2558
|
-
* UpdateTicketRequest
|
|
2559
|
-
* @description Request model for updating a ticket (customer-facing)
|
|
2560
|
-
*/
|
|
2561
|
-
UpdateTicketRequest: {
|
|
2348
|
+
inbound_enabled?: boolean | null;
|
|
2562
2349
|
/**
|
|
2563
|
-
*
|
|
2564
|
-
* @description
|
|
2350
|
+
* Inbound Email
|
|
2351
|
+
* @description Support email address
|
|
2565
2352
|
*/
|
|
2566
|
-
|
|
2353
|
+
inbound_email?: string | null;
|
|
2567
2354
|
/**
|
|
2568
|
-
*
|
|
2569
|
-
* @description
|
|
2355
|
+
* Auto Create Tickets
|
|
2356
|
+
* @description Auto-create tickets from unknown senders
|
|
2570
2357
|
*/
|
|
2571
|
-
|
|
2358
|
+
auto_create_tickets?: boolean | null;
|
|
2572
2359
|
/**
|
|
2573
|
-
*
|
|
2574
|
-
* @description
|
|
2360
|
+
* Require Verified Emails
|
|
2361
|
+
* @description Require email verification
|
|
2575
2362
|
*/
|
|
2576
|
-
|
|
2363
|
+
require_verified_emails?: boolean | null;
|
|
2577
2364
|
/**
|
|
2578
|
-
*
|
|
2579
|
-
* @description
|
|
2365
|
+
* Strip Signatures
|
|
2366
|
+
* @description Remove signatures from body
|
|
2580
2367
|
*/
|
|
2581
|
-
|
|
2368
|
+
strip_signatures?: boolean | null;
|
|
2582
2369
|
/**
|
|
2583
|
-
*
|
|
2584
|
-
* @description
|
|
2370
|
+
* Strip Quotes
|
|
2371
|
+
* @description Remove quoted text from replies
|
|
2585
2372
|
*/
|
|
2586
|
-
|
|
2587
|
-
};
|
|
2588
|
-
ErrorResponse: {
|
|
2589
|
-
/** @example about:blank */
|
|
2590
|
-
type?: string;
|
|
2591
|
-
/** @example GENERIC_ERROR */
|
|
2592
|
-
code?: string;
|
|
2593
|
-
/** @example Client Error */
|
|
2594
|
-
title?: string;
|
|
2595
|
-
/** @example 400 */
|
|
2596
|
-
status?: number;
|
|
2597
|
-
/** @example An error occurred */
|
|
2598
|
-
detail?: string;
|
|
2599
|
-
/** @example /v1/cart/items */
|
|
2600
|
-
instance?: string;
|
|
2601
|
-
extensions?: components["schemas"]["Extensions"];
|
|
2602
|
-
};
|
|
2603
|
-
/**
|
|
2604
|
-
* GetAgentPerformanceRequest
|
|
2605
|
-
* @description Request model for getting agent performance metrics
|
|
2606
|
-
* @example {
|
|
2607
|
-
* "agent_id": 123,
|
|
2608
|
-
* "date_from": "2025-11-01",
|
|
2609
|
-
* "date_to": "2025-12-01",
|
|
2610
|
-
* "limit": 50,
|
|
2611
|
-
* "page": 1,
|
|
2612
|
-
* "period_type": "daily"
|
|
2613
|
-
* }
|
|
2614
|
-
*/
|
|
2615
|
-
GetAgentPerformanceRequest: {
|
|
2373
|
+
strip_quotes?: boolean | null;
|
|
2616
2374
|
/**
|
|
2617
|
-
*
|
|
2618
|
-
* @description
|
|
2375
|
+
* Outbound Enabled
|
|
2376
|
+
* @description Enable email notifications
|
|
2619
2377
|
*/
|
|
2620
|
-
|
|
2378
|
+
outbound_enabled?: boolean | null;
|
|
2621
2379
|
/**
|
|
2622
|
-
*
|
|
2623
|
-
* @description
|
|
2380
|
+
* From Email
|
|
2381
|
+
* @description Default from email
|
|
2624
2382
|
*/
|
|
2625
|
-
|
|
2383
|
+
from_email?: string | null;
|
|
2626
2384
|
/**
|
|
2627
|
-
*
|
|
2628
|
-
* @
|
|
2385
|
+
* From Name
|
|
2386
|
+
* @description Default from name
|
|
2629
2387
|
*/
|
|
2630
|
-
|
|
2388
|
+
from_name?: string | null;
|
|
2631
2389
|
/**
|
|
2632
|
-
*
|
|
2633
|
-
* @description
|
|
2390
|
+
* Reply To
|
|
2391
|
+
* @description Default reply-to email
|
|
2634
2392
|
*/
|
|
2635
|
-
|
|
2393
|
+
reply_to?: string | null;
|
|
2636
2394
|
/**
|
|
2637
|
-
*
|
|
2638
|
-
* @description
|
|
2395
|
+
* Smtp Enabled
|
|
2396
|
+
* @description Use SMTP provider
|
|
2639
2397
|
*/
|
|
2640
|
-
|
|
2398
|
+
smtp_enabled?: boolean | null;
|
|
2641
2399
|
/**
|
|
2642
|
-
*
|
|
2643
|
-
* @description
|
|
2644
|
-
* @default 1
|
|
2400
|
+
* Smtp Host
|
|
2401
|
+
* @description SMTP host
|
|
2645
2402
|
*/
|
|
2646
|
-
|
|
2403
|
+
smtp_host?: string | null;
|
|
2647
2404
|
/**
|
|
2648
|
-
*
|
|
2649
|
-
* @description
|
|
2650
|
-
* @default 50
|
|
2405
|
+
* Smtp Port
|
|
2406
|
+
* @description SMTP port
|
|
2651
2407
|
*/
|
|
2652
|
-
|
|
2653
|
-
};
|
|
2654
|
-
/**
|
|
2655
|
-
* TemplateType
|
|
2656
|
-
* @description Email template types
|
|
2657
|
-
* @enum {string}
|
|
2658
|
-
*/
|
|
2659
|
-
TemplateType: "ticket_created" | "ticket_updated" | "ticket_assigned" | "ticket_resolved" | "ticket_closed" | "comment_added" | "agent_assigned" | "sla_warning" | "customer_satisfaction";
|
|
2660
|
-
/**
|
|
2661
|
-
* SearchCommentsRequest
|
|
2662
|
-
* @description Request model for searching comments
|
|
2663
|
-
* @example {
|
|
2664
|
-
* "include_internal": false,
|
|
2665
|
-
* "limit": 20,
|
|
2666
|
-
* "page": 1,
|
|
2667
|
-
* "query": "refund",
|
|
2668
|
-
* "ticket_id": "tkt_xxx123"
|
|
2669
|
-
* }
|
|
2670
|
-
*/
|
|
2671
|
-
SearchCommentsRequest: {
|
|
2408
|
+
smtp_port?: number | null;
|
|
2672
2409
|
/**
|
|
2673
|
-
*
|
|
2674
|
-
* @description
|
|
2410
|
+
* Smtp Username
|
|
2411
|
+
* @description SMTP username
|
|
2675
2412
|
*/
|
|
2676
|
-
|
|
2413
|
+
smtp_username?: string | null;
|
|
2677
2414
|
/**
|
|
2678
|
-
*
|
|
2679
|
-
* @description
|
|
2415
|
+
* Smtp Password
|
|
2416
|
+
* @description SMTP password (will be encrypted)
|
|
2680
2417
|
*/
|
|
2681
|
-
|
|
2418
|
+
smtp_password?: string | null;
|
|
2682
2419
|
/**
|
|
2683
|
-
*
|
|
2684
|
-
* @description
|
|
2685
|
-
* @default false
|
|
2420
|
+
* Smtp Use Tls
|
|
2421
|
+
* @description Use TLS/SSL
|
|
2686
2422
|
*/
|
|
2687
|
-
|
|
2423
|
+
smtp_use_tls?: boolean | null;
|
|
2688
2424
|
/**
|
|
2689
|
-
*
|
|
2690
|
-
* @description
|
|
2691
|
-
* @default 1
|
|
2425
|
+
* Ses Enabled
|
|
2426
|
+
* @description Use AWS SES
|
|
2692
2427
|
*/
|
|
2693
|
-
|
|
2428
|
+
ses_enabled?: boolean | null;
|
|
2694
2429
|
/**
|
|
2695
|
-
*
|
|
2696
|
-
* @description
|
|
2697
|
-
* @default 20
|
|
2430
|
+
* Ses Region
|
|
2431
|
+
* @description AWS region
|
|
2698
2432
|
*/
|
|
2699
|
-
|
|
2700
|
-
};
|
|
2701
|
-
/**
|
|
2702
|
-
* CreateHolidayRequest
|
|
2703
|
-
* @description Request model for creating a holiday
|
|
2704
|
-
* @example {
|
|
2705
|
-
* "affects_sla": true,
|
|
2706
|
-
* "holiday_date": "2025-12-25",
|
|
2707
|
-
* "holiday_name": "Christmas Day",
|
|
2708
|
-
* "is_full_day": true,
|
|
2709
|
-
* "is_recurring": true
|
|
2710
|
-
* }
|
|
2711
|
-
*/
|
|
2712
|
-
app__models__support__sla_models__CreateHolidayRequest: {
|
|
2713
|
-
/** Holiday Name */
|
|
2714
|
-
holiday_name: string;
|
|
2433
|
+
ses_region?: string | null;
|
|
2715
2434
|
/**
|
|
2716
|
-
*
|
|
2717
|
-
*
|
|
2718
|
-
* @description Holiday date
|
|
2435
|
+
* Ses Access Key
|
|
2436
|
+
* @description AWS access key (will be encrypted)
|
|
2719
2437
|
*/
|
|
2720
|
-
|
|
2438
|
+
ses_access_key?: string | null;
|
|
2721
2439
|
/**
|
|
2722
|
-
*
|
|
2723
|
-
* @description
|
|
2724
|
-
* @default false
|
|
2440
|
+
* Ses Secret Key
|
|
2441
|
+
* @description AWS secret key (will be encrypted)
|
|
2725
2442
|
*/
|
|
2726
|
-
|
|
2443
|
+
ses_secret_key?: string | null;
|
|
2727
2444
|
/**
|
|
2728
|
-
*
|
|
2729
|
-
* @description
|
|
2730
|
-
* @default true
|
|
2445
|
+
* Enable Threading
|
|
2446
|
+
* @description Enable email threading
|
|
2731
2447
|
*/
|
|
2732
|
-
|
|
2448
|
+
enable_threading?: boolean | null;
|
|
2733
2449
|
/**
|
|
2734
|
-
*
|
|
2735
|
-
* @description
|
|
2736
|
-
* @default true
|
|
2450
|
+
* Include Ticket Id In Subject
|
|
2451
|
+
* @description Add [#TKT-123] to subject
|
|
2737
2452
|
*/
|
|
2738
|
-
|
|
2453
|
+
include_ticket_id_in_subject?: boolean | null;
|
|
2739
2454
|
/**
|
|
2740
|
-
*
|
|
2741
|
-
* @description
|
|
2455
|
+
* Spam Threshold
|
|
2456
|
+
* @description Spam score threshold
|
|
2742
2457
|
*/
|
|
2743
|
-
|
|
2458
|
+
spam_threshold?: number | null;
|
|
2744
2459
|
/**
|
|
2745
|
-
*
|
|
2746
|
-
* @description
|
|
2460
|
+
* Block Spam
|
|
2461
|
+
* @description Block emails marked as spam
|
|
2747
2462
|
*/
|
|
2748
|
-
|
|
2749
|
-
/**
|
|
2750
|
-
|
|
2463
|
+
block_spam?: boolean | null;
|
|
2464
|
+
/**
|
|
2465
|
+
* Notify Customer On Create
|
|
2466
|
+
* @description Notify customer when ticket created
|
|
2467
|
+
*/
|
|
2468
|
+
notify_customer_on_create?: boolean | null;
|
|
2469
|
+
/**
|
|
2470
|
+
* Notify Customer On Update
|
|
2471
|
+
* @description Notify customer on updates
|
|
2472
|
+
*/
|
|
2473
|
+
notify_customer_on_update?: boolean | null;
|
|
2474
|
+
/**
|
|
2475
|
+
* Notify Agent On Assignment
|
|
2476
|
+
* @description Notify agent on assignment
|
|
2477
|
+
*/
|
|
2478
|
+
notify_agent_on_assignment?: boolean | null;
|
|
2751
2479
|
};
|
|
2752
2480
|
/**
|
|
2753
|
-
*
|
|
2754
|
-
* @description Request model for
|
|
2481
|
+
* CreateTicketRequest
|
|
2482
|
+
* @description Request model for creating a new support ticket
|
|
2755
2483
|
*/
|
|
2756
|
-
|
|
2484
|
+
CreateTicketRequest: {
|
|
2757
2485
|
/**
|
|
2758
|
-
*
|
|
2759
|
-
* @description
|
|
2486
|
+
* Subject
|
|
2487
|
+
* @description Ticket subject/title
|
|
2760
2488
|
*/
|
|
2761
|
-
|
|
2489
|
+
subject: string;
|
|
2762
2490
|
/**
|
|
2763
|
-
*
|
|
2764
|
-
* @description
|
|
2491
|
+
* Description
|
|
2492
|
+
* @description Detailed description of the issue
|
|
2765
2493
|
*/
|
|
2766
|
-
|
|
2494
|
+
description: string;
|
|
2767
2495
|
/**
|
|
2768
|
-
*
|
|
2769
|
-
* @description
|
|
2496
|
+
* Category
|
|
2497
|
+
* @description Ticket category (Bug, Feature Request, etc.)
|
|
2770
2498
|
*/
|
|
2771
|
-
|
|
2499
|
+
category?: string | null;
|
|
2772
2500
|
/**
|
|
2773
|
-
*
|
|
2774
|
-
* @description
|
|
2501
|
+
* Priority
|
|
2502
|
+
* @description Priority: low, medium, high, urgent, critical
|
|
2503
|
+
* @default medium
|
|
2775
2504
|
*/
|
|
2776
|
-
|
|
2505
|
+
priority: string | null;
|
|
2777
2506
|
/**
|
|
2778
|
-
*
|
|
2779
|
-
* @description
|
|
2780
|
-
* @default true
|
|
2507
|
+
* Company Id
|
|
2508
|
+
* @description Company ID within organization
|
|
2781
2509
|
*/
|
|
2782
|
-
|
|
2510
|
+
company_id?: number | null;
|
|
2783
2511
|
/**
|
|
2784
|
-
*
|
|
2785
|
-
* @description
|
|
2786
|
-
* @default true
|
|
2512
|
+
* Requester Name
|
|
2513
|
+
* @description Requester name (if not from auth)
|
|
2787
2514
|
*/
|
|
2788
|
-
|
|
2515
|
+
requester_name?: string | null;
|
|
2789
2516
|
/**
|
|
2790
|
-
*
|
|
2791
|
-
* @description
|
|
2792
|
-
* @default true
|
|
2517
|
+
* Requester Email
|
|
2518
|
+
* @description Requester email (if not from auth)
|
|
2793
2519
|
*/
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
macro_slug?: string | null;
|
|
2811
|
-
/** Description */
|
|
2812
|
-
description?: string | null;
|
|
2813
|
-
/** Actions */
|
|
2814
|
-
actions?: {
|
|
2520
|
+
requester_email?: string | null;
|
|
2521
|
+
/**
|
|
2522
|
+
* Requester Mobile
|
|
2523
|
+
* @description Requester phone number
|
|
2524
|
+
*/
|
|
2525
|
+
requester_mobile?: string | null;
|
|
2526
|
+
/**
|
|
2527
|
+
* Tags
|
|
2528
|
+
* @description Tags for categorization
|
|
2529
|
+
*/
|
|
2530
|
+
tags?: string[] | null;
|
|
2531
|
+
/**
|
|
2532
|
+
* Custom Fields
|
|
2533
|
+
* @description Custom field values
|
|
2534
|
+
*/
|
|
2535
|
+
custom_fields?: {
|
|
2815
2536
|
[key: string]: unknown;
|
|
2816
|
-
}
|
|
2817
|
-
/** Include Response */
|
|
2818
|
-
include_response?: boolean | null;
|
|
2819
|
-
/** Canned Response Id */
|
|
2820
|
-
canned_response_id?: number | null;
|
|
2821
|
-
/** Is Public */
|
|
2822
|
-
is_public?: boolean | null;
|
|
2823
|
-
/** Team Ids */
|
|
2824
|
-
team_ids?: number[] | null;
|
|
2825
|
-
/** User Ids */
|
|
2826
|
-
user_ids?: number[] | null;
|
|
2827
|
-
/** Display Order */
|
|
2828
|
-
display_order?: number | null;
|
|
2829
|
-
/** Button Color */
|
|
2830
|
-
button_color?: string | null;
|
|
2831
|
-
/** Icon */
|
|
2832
|
-
icon?: string | null;
|
|
2833
|
-
/** Status */
|
|
2834
|
-
status?: string | null;
|
|
2537
|
+
} | null;
|
|
2835
2538
|
};
|
|
2836
2539
|
/**
|
|
2837
|
-
*
|
|
2838
|
-
* @description Request model for updating a
|
|
2540
|
+
* UpdateAgentTicketRequest
|
|
2541
|
+
* @description Request model for updating a ticket (agent-facing)
|
|
2839
2542
|
*/
|
|
2840
|
-
|
|
2841
|
-
/**
|
|
2842
|
-
|
|
2843
|
-
/** Filter Slug */
|
|
2844
|
-
filter_slug?: string | null;
|
|
2543
|
+
UpdateAgentTicketRequest: {
|
|
2544
|
+
/** Subject */
|
|
2545
|
+
subject?: string | null;
|
|
2845
2546
|
/** Description */
|
|
2846
2547
|
description?: string | null;
|
|
2847
|
-
/** Filter Config */
|
|
2848
|
-
filter_config?: {
|
|
2849
|
-
[key: string]: unknown;
|
|
2850
|
-
} | null;
|
|
2851
|
-
/** Is Public */
|
|
2852
|
-
is_public?: boolean | null;
|
|
2853
|
-
/** Is Default */
|
|
2854
|
-
is_default?: boolean | null;
|
|
2855
|
-
/** Status */
|
|
2856
|
-
status?: string | null;
|
|
2857
|
-
};
|
|
2858
|
-
/**
|
|
2859
|
-
* AssignTicketRequest
|
|
2860
|
-
* @description Request model for assigning a ticket
|
|
2861
|
-
*/
|
|
2862
|
-
AssignTicketRequest: {
|
|
2863
2548
|
/**
|
|
2864
|
-
*
|
|
2865
|
-
* @description
|
|
2549
|
+
* Priority
|
|
2550
|
+
* @description low, medium, high, urgent, critical
|
|
2866
2551
|
*/
|
|
2867
|
-
|
|
2552
|
+
priority?: string | null;
|
|
2553
|
+
/** Category */
|
|
2554
|
+
category?: string | null;
|
|
2555
|
+
/** Sub Category */
|
|
2556
|
+
sub_category?: string | null;
|
|
2868
2557
|
/**
|
|
2869
|
-
*
|
|
2870
|
-
* @description
|
|
2558
|
+
* Status
|
|
2559
|
+
* @description new, open, pending, waiting_for_customer, on_hold, resolved, closed
|
|
2871
2560
|
*/
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
ExportFormat: "csv" | "excel" | "json" | "pdf";
|
|
2880
|
-
Extensions: {
|
|
2881
|
-
/** @example GENERIC_ERROR */
|
|
2882
|
-
message_code?: string;
|
|
2883
|
-
/** @example [] */
|
|
2884
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
2885
|
-
extra_data?: Record<string, never> | null;
|
|
2886
|
-
/** @example Detailed debug information */
|
|
2887
|
-
debug?: string | null;
|
|
2561
|
+
status?: string | null;
|
|
2562
|
+
/** Tags */
|
|
2563
|
+
tags?: string[] | null;
|
|
2564
|
+
/** Custom Fields */
|
|
2565
|
+
custom_fields?: {
|
|
2566
|
+
[key: string]: unknown;
|
|
2567
|
+
} | null;
|
|
2888
2568
|
};
|
|
2889
2569
|
/**
|
|
2890
2570
|
* CreateEmailTemplateRequest
|
|
@@ -2971,158 +2651,55 @@ export interface components {
|
|
|
2971
2651
|
language: string;
|
|
2972
2652
|
};
|
|
2973
2653
|
/**
|
|
2974
|
-
*
|
|
2975
|
-
* @description Request model for adding a
|
|
2654
|
+
* AddWatcherRequest
|
|
2655
|
+
* @description Request model for adding a watcher to a ticket
|
|
2976
2656
|
*/
|
|
2977
|
-
|
|
2657
|
+
AddWatcherRequest: {
|
|
2978
2658
|
/**
|
|
2979
2659
|
* User Id
|
|
2980
|
-
* @description User ID to add
|
|
2660
|
+
* @description User ID to add as watcher
|
|
2981
2661
|
*/
|
|
2982
2662
|
user_id: number;
|
|
2983
|
-
/** User Name */
|
|
2984
|
-
user_name: string;
|
|
2985
|
-
/** User Email */
|
|
2986
|
-
user_email: string;
|
|
2987
|
-
/**
|
|
2988
|
-
* Role
|
|
2989
|
-
* @description agent, senior_agent, team_lead, trainee
|
|
2990
|
-
* @default agent
|
|
2991
|
-
*/
|
|
2992
|
-
role: string;
|
|
2993
|
-
/**
|
|
2994
|
-
* Is Team Lead
|
|
2995
|
-
* @default false
|
|
2996
|
-
*/
|
|
2997
|
-
is_team_lead: boolean;
|
|
2998
|
-
/** Max Concurrent Tickets */
|
|
2999
|
-
max_concurrent_tickets?: number | null;
|
|
3000
|
-
/**
|
|
3001
|
-
* Skills
|
|
3002
|
-
* @description Agent skills and expertise
|
|
3003
|
-
*/
|
|
3004
|
-
skills?: string[] | null;
|
|
3005
2663
|
/**
|
|
3006
|
-
*
|
|
3007
|
-
* @description
|
|
3008
|
-
* @default intermediate
|
|
2664
|
+
* User Name
|
|
2665
|
+
* @description User name
|
|
3009
2666
|
*/
|
|
3010
|
-
|
|
2667
|
+
user_name: string;
|
|
3011
2668
|
/**
|
|
3012
|
-
*
|
|
3013
|
-
* @description
|
|
2669
|
+
* User Email
|
|
2670
|
+
* @description User email
|
|
3014
2671
|
*/
|
|
3015
|
-
|
|
2672
|
+
user_email: string;
|
|
3016
2673
|
/**
|
|
3017
|
-
*
|
|
3018
|
-
* @description
|
|
2674
|
+
* Watch Type
|
|
2675
|
+
* @description Watch type
|
|
2676
|
+
* @default manual
|
|
3019
2677
|
*/
|
|
3020
|
-
|
|
2678
|
+
watch_type: string;
|
|
3021
2679
|
/**
|
|
3022
|
-
*
|
|
2680
|
+
* Notify On Comment
|
|
2681
|
+
* @description Notify on comments
|
|
3023
2682
|
* @default true
|
|
3024
2683
|
*/
|
|
3025
|
-
|
|
3026
|
-
/**
|
|
3027
|
-
* Assignment Weight
|
|
3028
|
-
* @description Weight for load balancing (100 = normal)
|
|
3029
|
-
* @default 100
|
|
3030
|
-
*/
|
|
3031
|
-
assignment_weight: number;
|
|
3032
|
-
/** Working Hours */
|
|
3033
|
-
working_hours?: {
|
|
3034
|
-
[key: string]: unknown;
|
|
3035
|
-
} | null;
|
|
3036
|
-
/**
|
|
3037
|
-
* Timezone
|
|
3038
|
-
* @default UTC
|
|
3039
|
-
*/
|
|
3040
|
-
timezone: string;
|
|
3041
|
-
};
|
|
3042
|
-
/**
|
|
3043
|
-
* UpdateCategoryRequest
|
|
3044
|
-
* @description Request model for updating a support category
|
|
3045
|
-
* @example {
|
|
3046
|
-
* "category_name": "Billing & Payment Issues",
|
|
3047
|
-
* "description": "Updated description for billing category",
|
|
3048
|
-
* "is_public": true,
|
|
3049
|
-
* "sla_first_response_minutes": 30,
|
|
3050
|
-
* "status": "active"
|
|
3051
|
-
* }
|
|
3052
|
-
*/
|
|
3053
|
-
app__models__support__category_models__UpdateCategoryRequest: {
|
|
3054
|
-
/**
|
|
3055
|
-
* Category Name
|
|
3056
|
-
* @description Category name
|
|
3057
|
-
*/
|
|
3058
|
-
category_name?: string | null;
|
|
3059
|
-
/**
|
|
3060
|
-
* Description
|
|
3061
|
-
* @description Category description
|
|
3062
|
-
*/
|
|
3063
|
-
description?: string | null;
|
|
3064
|
-
/**
|
|
3065
|
-
* Category Slug
|
|
3066
|
-
* @description URL-friendly slug
|
|
3067
|
-
*/
|
|
3068
|
-
category_slug?: string | null;
|
|
3069
|
-
/**
|
|
3070
|
-
* Parent Category Id
|
|
3071
|
-
* @description Parent category ID
|
|
3072
|
-
*/
|
|
3073
|
-
parent_category_id?: number | null;
|
|
3074
|
-
/**
|
|
3075
|
-
* Default Team Id
|
|
3076
|
-
* @description Default team ID for auto-routing
|
|
3077
|
-
*/
|
|
3078
|
-
default_team_id?: number | null;
|
|
3079
|
-
/**
|
|
3080
|
-
* Default Priority
|
|
3081
|
-
* @description Default priority slug
|
|
3082
|
-
*/
|
|
3083
|
-
default_priority?: string | null;
|
|
3084
|
-
/**
|
|
3085
|
-
* Sla First Response Minutes
|
|
3086
|
-
* @description SLA for first response in minutes
|
|
3087
|
-
*/
|
|
3088
|
-
sla_first_response_minutes?: number | null;
|
|
3089
|
-
/**
|
|
3090
|
-
* Sla Resolution Minutes
|
|
3091
|
-
* @description SLA for resolution in minutes
|
|
3092
|
-
*/
|
|
3093
|
-
sla_resolution_minutes?: number | null;
|
|
3094
|
-
/**
|
|
3095
|
-
* Is Public
|
|
3096
|
-
* @description Whether category is visible to customers
|
|
3097
|
-
*/
|
|
3098
|
-
is_public?: boolean | null;
|
|
3099
|
-
/**
|
|
3100
|
-
* Display Order
|
|
3101
|
-
* @description Display order for sorting
|
|
3102
|
-
*/
|
|
3103
|
-
display_order?: number | null;
|
|
3104
|
-
/**
|
|
3105
|
-
* Icon
|
|
3106
|
-
* @description Icon identifier
|
|
3107
|
-
*/
|
|
3108
|
-
icon?: string | null;
|
|
2684
|
+
notify_on_comment: boolean;
|
|
3109
2685
|
/**
|
|
3110
|
-
*
|
|
3111
|
-
* @description
|
|
2686
|
+
* Notify On Status Change
|
|
2687
|
+
* @description Notify on status change
|
|
2688
|
+
* @default true
|
|
3112
2689
|
*/
|
|
3113
|
-
|
|
2690
|
+
notify_on_status_change: boolean;
|
|
3114
2691
|
/**
|
|
3115
|
-
*
|
|
3116
|
-
* @description
|
|
2692
|
+
* Notify On Assignment
|
|
2693
|
+
* @description Notify on assignment
|
|
2694
|
+
* @default true
|
|
3117
2695
|
*/
|
|
3118
|
-
|
|
2696
|
+
notify_on_assignment: boolean;
|
|
3119
2697
|
/**
|
|
3120
|
-
*
|
|
3121
|
-
* @description
|
|
2698
|
+
* Notify On Resolution
|
|
2699
|
+
* @description Notify on resolution
|
|
2700
|
+
* @default true
|
|
3122
2701
|
*/
|
|
3123
|
-
|
|
3124
|
-
[key: string]: unknown;
|
|
3125
|
-
} | null;
|
|
2702
|
+
notify_on_resolution: boolean;
|
|
3126
2703
|
};
|
|
3127
2704
|
/**
|
|
3128
2705
|
* UpdateAutomationRuleRequest
|
|
@@ -3163,556 +2740,660 @@ export interface components {
|
|
|
3163
2740
|
status?: string | null;
|
|
3164
2741
|
};
|
|
3165
2742
|
/**
|
|
3166
|
-
*
|
|
3167
|
-
* @description Request model for
|
|
2743
|
+
* CreateTeamRequest
|
|
2744
|
+
* @description Request model for creating a team
|
|
3168
2745
|
*/
|
|
3169
|
-
|
|
3170
|
-
/**
|
|
3171
|
-
* Comment Body
|
|
3172
|
-
* @description Comment text
|
|
3173
|
-
*/
|
|
3174
|
-
comment_body: string;
|
|
2746
|
+
CreateTeamRequest: {
|
|
3175
2747
|
/**
|
|
3176
|
-
*
|
|
3177
|
-
* @description
|
|
3178
|
-
* @default false
|
|
2748
|
+
* Team Name
|
|
2749
|
+
* @description Team name
|
|
3179
2750
|
*/
|
|
3180
|
-
|
|
3181
|
-
};
|
|
3182
|
-
/**
|
|
3183
|
-
* GenerateSurveyRequest
|
|
3184
|
-
* @description Request model for generating a satisfaction survey
|
|
3185
|
-
*/
|
|
3186
|
-
GenerateSurveyRequest: {
|
|
2751
|
+
team_name: string;
|
|
3187
2752
|
/**
|
|
3188
|
-
*
|
|
3189
|
-
* @description
|
|
3190
|
-
* @default post_resolution
|
|
2753
|
+
* Description
|
|
2754
|
+
* @description Team description
|
|
3191
2755
|
*/
|
|
3192
|
-
|
|
3193
|
-
};
|
|
3194
|
-
InvalidParam: {
|
|
3195
|
-
/** @example items[0].quantity */
|
|
3196
|
-
field?: string;
|
|
3197
|
-
/** @example Input should be greater than or equal to 1 */
|
|
3198
|
-
error?: string;
|
|
3199
|
-
};
|
|
3200
|
-
/**
|
|
3201
|
-
* CreateMacroRequest
|
|
3202
|
-
* @description Request model for creating a new macro
|
|
3203
|
-
* @example {
|
|
3204
|
-
* "actions": [
|
|
3205
|
-
* {
|
|
3206
|
-
* "action": "set_status",
|
|
3207
|
-
* "value": "solved"
|
|
3208
|
-
* },
|
|
3209
|
-
* {
|
|
3210
|
-
* "action": "add_internal_note",
|
|
3211
|
-
* "note": "Ticket closed as solved"
|
|
3212
|
-
* }
|
|
3213
|
-
* ],
|
|
3214
|
-
* "button_color": "#4CAF50",
|
|
3215
|
-
* "description": "Mark ticket as solved and close it",
|
|
3216
|
-
* "display_order": 1,
|
|
3217
|
-
* "icon": "check-circle",
|
|
3218
|
-
* "include_response": false,
|
|
3219
|
-
* "is_public": true,
|
|
3220
|
-
* "macro_name": "Close as Solved",
|
|
3221
|
-
* "macro_slug": "close-solved",
|
|
3222
|
-
* "status": "active"
|
|
3223
|
-
* }
|
|
3224
|
-
*/
|
|
3225
|
-
CreateMacroRequest: {
|
|
2756
|
+
description?: string | null;
|
|
3226
2757
|
/**
|
|
3227
|
-
*
|
|
3228
|
-
* @description
|
|
2758
|
+
* Team Type
|
|
2759
|
+
* @description Team type: general, technical, billing, sales, custom
|
|
2760
|
+
* @default general
|
|
3229
2761
|
*/
|
|
3230
|
-
|
|
2762
|
+
team_type: string;
|
|
3231
2763
|
/**
|
|
3232
|
-
*
|
|
3233
|
-
* @description
|
|
2764
|
+
* Team Lead User Id
|
|
2765
|
+
* @description User ID of team leader
|
|
3234
2766
|
*/
|
|
3235
|
-
|
|
2767
|
+
team_lead_user_id?: number | null;
|
|
2768
|
+
/** Team Lead Name */
|
|
2769
|
+
team_lead_name?: string | null;
|
|
2770
|
+
/** Team Lead Email */
|
|
2771
|
+
team_lead_email?: string | null;
|
|
3236
2772
|
/**
|
|
3237
|
-
*
|
|
3238
|
-
* @description
|
|
2773
|
+
* Auto Assign Enabled
|
|
2774
|
+
* @description Enable auto-assignment
|
|
2775
|
+
* @default false
|
|
3239
2776
|
*/
|
|
3240
|
-
|
|
2777
|
+
auto_assign_enabled: boolean;
|
|
3241
2778
|
/**
|
|
3242
|
-
*
|
|
3243
|
-
* @description
|
|
2779
|
+
* Assignment Strategy
|
|
2780
|
+
* @description round_robin, least_active, skill_based, random
|
|
2781
|
+
* @default round_robin
|
|
3244
2782
|
*/
|
|
3245
|
-
|
|
2783
|
+
assignment_strategy: string;
|
|
2784
|
+
/** Max Tickets Per Agent */
|
|
2785
|
+
max_tickets_per_agent?: number | null;
|
|
2786
|
+
/**
|
|
2787
|
+
* Business Hours
|
|
2788
|
+
* @description Business hours schedule
|
|
2789
|
+
*/
|
|
2790
|
+
business_hours?: {
|
|
3246
2791
|
[key: string]: unknown;
|
|
3247
|
-
}
|
|
2792
|
+
} | null;
|
|
3248
2793
|
/**
|
|
3249
|
-
*
|
|
3250
|
-
* @description
|
|
2794
|
+
* Timezone
|
|
2795
|
+
* @description Team timezone
|
|
2796
|
+
* @default UTC
|
|
2797
|
+
*/
|
|
2798
|
+
timezone: string;
|
|
2799
|
+
/**
|
|
2800
|
+
* Routing Rules
|
|
2801
|
+
* @description Routing rules for auto-assignment
|
|
2802
|
+
*/
|
|
2803
|
+
routing_rules?: {
|
|
2804
|
+
[key: string]: unknown;
|
|
2805
|
+
} | null;
|
|
2806
|
+
/** Sla First Response Minutes */
|
|
2807
|
+
sla_first_response_minutes?: number | null;
|
|
2808
|
+
/** Sla Resolution Minutes */
|
|
2809
|
+
sla_resolution_minutes?: number | null;
|
|
2810
|
+
/**
|
|
2811
|
+
* Escalation Enabled
|
|
3251
2812
|
* @default false
|
|
3252
2813
|
*/
|
|
3253
|
-
|
|
2814
|
+
escalation_enabled: boolean;
|
|
2815
|
+
/** Escalation After Minutes */
|
|
2816
|
+
escalation_after_minutes?: number | null;
|
|
3254
2817
|
/**
|
|
3255
|
-
*
|
|
3256
|
-
* @description
|
|
2818
|
+
* Escalation Team Id
|
|
2819
|
+
* @description Team ID to escalate to
|
|
3257
2820
|
*/
|
|
3258
|
-
|
|
2821
|
+
escalation_team_id?: string | null;
|
|
3259
2822
|
/**
|
|
3260
|
-
* Is
|
|
3261
|
-
* @description
|
|
3262
|
-
* @default
|
|
2823
|
+
* Is Default
|
|
2824
|
+
* @description Set as default team for unassigned tickets
|
|
2825
|
+
* @default false
|
|
3263
2826
|
*/
|
|
3264
|
-
|
|
2827
|
+
is_default: boolean;
|
|
2828
|
+
/** Settings */
|
|
2829
|
+
settings?: {
|
|
2830
|
+
[key: string]: unknown;
|
|
2831
|
+
} | null;
|
|
2832
|
+
/** Custom Fields */
|
|
2833
|
+
custom_fields?: {
|
|
2834
|
+
[key: string]: unknown;
|
|
2835
|
+
} | null;
|
|
2836
|
+
};
|
|
2837
|
+
/**
|
|
2838
|
+
* CreateSavedFilterRequest
|
|
2839
|
+
* @description Request model for creating a saved filter
|
|
2840
|
+
* @example {
|
|
2841
|
+
* "description": "All high priority tickets assigned to me",
|
|
2842
|
+
* "filter_config": {
|
|
2843
|
+
* "priority": [
|
|
2844
|
+
* "high",
|
|
2845
|
+
* "urgent"
|
|
2846
|
+
* ],
|
|
2847
|
+
* "status": [
|
|
2848
|
+
* "open",
|
|
2849
|
+
* "pending"
|
|
2850
|
+
* ]
|
|
2851
|
+
* },
|
|
2852
|
+
* "filter_name": "My High Priority Tickets",
|
|
2853
|
+
* "filter_slug": "my-high-priority",
|
|
2854
|
+
* "is_default": true,
|
|
2855
|
+
* "is_public": false
|
|
2856
|
+
* }
|
|
2857
|
+
*/
|
|
2858
|
+
CreateSavedFilterRequest: {
|
|
3265
2859
|
/**
|
|
3266
|
-
*
|
|
3267
|
-
* @description
|
|
2860
|
+
* Filter Name
|
|
2861
|
+
* @description Filter name
|
|
3268
2862
|
*/
|
|
3269
|
-
|
|
2863
|
+
filter_name: string;
|
|
3270
2864
|
/**
|
|
3271
|
-
*
|
|
3272
|
-
* @description
|
|
2865
|
+
* Filter Slug
|
|
2866
|
+
* @description URL-friendly slug
|
|
3273
2867
|
*/
|
|
3274
|
-
|
|
2868
|
+
filter_slug: string;
|
|
3275
2869
|
/**
|
|
3276
|
-
*
|
|
3277
|
-
* @description
|
|
3278
|
-
* @default 0
|
|
2870
|
+
* Description
|
|
2871
|
+
* @description Filter description
|
|
3279
2872
|
*/
|
|
3280
|
-
|
|
2873
|
+
description?: string | null;
|
|
3281
2874
|
/**
|
|
3282
|
-
*
|
|
3283
|
-
* @description
|
|
2875
|
+
* Filter Config
|
|
2876
|
+
* @description Filter configuration (query, filters, sort)
|
|
3284
2877
|
*/
|
|
3285
|
-
|
|
2878
|
+
filter_config: {
|
|
2879
|
+
[key: string]: unknown;
|
|
2880
|
+
};
|
|
3286
2881
|
/**
|
|
3287
|
-
*
|
|
3288
|
-
* @description
|
|
2882
|
+
* Is Public
|
|
2883
|
+
* @description Make filter available to all users in organization
|
|
2884
|
+
* @default false
|
|
3289
2885
|
*/
|
|
3290
|
-
|
|
2886
|
+
is_public: boolean;
|
|
3291
2887
|
/**
|
|
3292
|
-
*
|
|
3293
|
-
* @description
|
|
3294
|
-
* @default
|
|
2888
|
+
* Is Default
|
|
2889
|
+
* @description Set as default filter for user
|
|
2890
|
+
* @default false
|
|
3295
2891
|
*/
|
|
3296
|
-
|
|
2892
|
+
is_default: boolean;
|
|
3297
2893
|
};
|
|
3298
2894
|
/**
|
|
3299
|
-
*
|
|
3300
|
-
* @description Request model for
|
|
2895
|
+
* BulkCloseRequest
|
|
2896
|
+
* @description Request model for bulk closing tickets
|
|
3301
2897
|
*/
|
|
3302
|
-
|
|
2898
|
+
BulkCloseRequest: {
|
|
3303
2899
|
/**
|
|
3304
|
-
*
|
|
3305
|
-
* @description
|
|
2900
|
+
* Ticket Ids
|
|
2901
|
+
* @description List of ticket IDs
|
|
3306
2902
|
*/
|
|
3307
|
-
|
|
2903
|
+
ticket_ids: number[];
|
|
3308
2904
|
};
|
|
3309
2905
|
/**
|
|
3310
|
-
*
|
|
3311
|
-
* @description
|
|
2906
|
+
* ExportFormat
|
|
2907
|
+
* @description Export file formats
|
|
2908
|
+
* @enum {string}
|
|
2909
|
+
*/
|
|
2910
|
+
ExportFormat: "csv" | "excel" | "json" | "pdf";
|
|
2911
|
+
/**
|
|
2912
|
+
* CreateCategoryRequest
|
|
2913
|
+
* @description Request model for creating a new support category
|
|
3312
2914
|
* @example {
|
|
3313
|
-
* "
|
|
3314
|
-
*
|
|
3315
|
-
*
|
|
3316
|
-
*
|
|
3317
|
-
*
|
|
3318
|
-
*
|
|
3319
|
-
*
|
|
3320
|
-
*
|
|
3321
|
-
*
|
|
3322
|
-
*
|
|
3323
|
-
*
|
|
3324
|
-
* "applies_to_all_priorities": true,
|
|
3325
|
-
* "category_ids": [
|
|
3326
|
-
* 123
|
|
3327
|
-
* ],
|
|
3328
|
-
* "conditions": {
|
|
3329
|
-
* "all": [
|
|
3330
|
-
* {
|
|
3331
|
-
* "field": "category_id",
|
|
3332
|
-
* "operator": "equals",
|
|
3333
|
-
* "value": 123
|
|
3334
|
-
* }
|
|
3335
|
-
* ]
|
|
2915
|
+
* "category_name": "Billing & Payments",
|
|
2916
|
+
* "category_slug": "billing-payments",
|
|
2917
|
+
* "color": "#4CAF50",
|
|
2918
|
+
* "default_priority": "medium",
|
|
2919
|
+
* "default_team_id": 123,
|
|
2920
|
+
* "description": "Issues related to billing, invoices, and payments",
|
|
2921
|
+
* "display_order": 1,
|
|
2922
|
+
* "icon": "icon-billing",
|
|
2923
|
+
* "is_public": true,
|
|
2924
|
+
* "settings": {
|
|
2925
|
+
* "require_account_verification": true
|
|
3336
2926
|
* },
|
|
3337
|
-
* "
|
|
3338
|
-
* "
|
|
3339
|
-
* "is_active": true,
|
|
3340
|
-
* "rule_name": "Auto-assign New Tickets",
|
|
3341
|
-
* "rule_slug": "auto-assign-new",
|
|
3342
|
-
* "status": "active",
|
|
3343
|
-
* "stop_processing": false,
|
|
3344
|
-
* "trigger_event": "ticket_created"
|
|
2927
|
+
* "sla_first_response_minutes": 60,
|
|
2928
|
+
* "sla_resolution_minutes": 480
|
|
3345
2929
|
* }
|
|
3346
2930
|
*/
|
|
3347
|
-
|
|
3348
|
-
/**
|
|
3349
|
-
* Rule Name
|
|
3350
|
-
* @description Rule name
|
|
3351
|
-
*/
|
|
3352
|
-
rule_name: string;
|
|
2931
|
+
app__models__support__category_models__CreateCategoryRequest: {
|
|
3353
2932
|
/**
|
|
3354
|
-
*
|
|
3355
|
-
* @description
|
|
2933
|
+
* Category Name
|
|
2934
|
+
* @description Category name
|
|
3356
2935
|
*/
|
|
3357
|
-
|
|
2936
|
+
category_name: string;
|
|
3358
2937
|
/**
|
|
3359
2938
|
* Description
|
|
3360
|
-
* @description
|
|
2939
|
+
* @description Category description
|
|
3361
2940
|
*/
|
|
3362
2941
|
description?: string | null;
|
|
3363
2942
|
/**
|
|
3364
|
-
*
|
|
3365
|
-
* @description
|
|
2943
|
+
* Category Slug
|
|
2944
|
+
* @description URL-friendly slug (lowercase, hyphens only)
|
|
3366
2945
|
*/
|
|
3367
|
-
|
|
2946
|
+
category_slug: string;
|
|
3368
2947
|
/**
|
|
3369
|
-
*
|
|
3370
|
-
* @description
|
|
3371
|
-
* @default 0
|
|
2948
|
+
* Parent Category Id
|
|
2949
|
+
* @description Parent category ID for hierarchical categories
|
|
3372
2950
|
*/
|
|
3373
|
-
|
|
2951
|
+
parent_category_id?: number | null;
|
|
3374
2952
|
/**
|
|
3375
|
-
*
|
|
3376
|
-
* @description
|
|
3377
|
-
* @default false
|
|
2953
|
+
* Default Team Id
|
|
2954
|
+
* @description Default team ID for auto-routing tickets
|
|
3378
2955
|
*/
|
|
3379
|
-
|
|
2956
|
+
default_team_id?: number | null;
|
|
3380
2957
|
/**
|
|
3381
|
-
*
|
|
3382
|
-
* @description
|
|
2958
|
+
* Default Priority
|
|
2959
|
+
* @description Default priority slug for tickets in this category
|
|
3383
2960
|
*/
|
|
3384
|
-
|
|
3385
|
-
[key: string]: unknown;
|
|
3386
|
-
} | null;
|
|
2961
|
+
default_priority?: string | null;
|
|
3387
2962
|
/**
|
|
3388
|
-
*
|
|
3389
|
-
* @description
|
|
2963
|
+
* Sla First Response Minutes
|
|
2964
|
+
* @description SLA for first response in minutes
|
|
3390
2965
|
*/
|
|
3391
|
-
|
|
3392
|
-
[key: string]: unknown;
|
|
3393
|
-
}[];
|
|
2966
|
+
sla_first_response_minutes?: number | null;
|
|
3394
2967
|
/**
|
|
3395
|
-
*
|
|
3396
|
-
* @description
|
|
3397
|
-
* @default true
|
|
2968
|
+
* Sla Resolution Minutes
|
|
2969
|
+
* @description SLA for resolution in minutes
|
|
3398
2970
|
*/
|
|
3399
|
-
|
|
2971
|
+
sla_resolution_minutes?: number | null;
|
|
3400
2972
|
/**
|
|
3401
|
-
*
|
|
3402
|
-
* @description
|
|
2973
|
+
* Is Public
|
|
2974
|
+
* @description Whether category is visible to customers
|
|
2975
|
+
* @default true
|
|
3403
2976
|
*/
|
|
3404
|
-
|
|
2977
|
+
is_public: boolean;
|
|
3405
2978
|
/**
|
|
3406
|
-
*
|
|
3407
|
-
* @description
|
|
3408
|
-
* @default
|
|
2979
|
+
* Display Order
|
|
2980
|
+
* @description Display order for sorting categories
|
|
2981
|
+
* @default 0
|
|
3409
2982
|
*/
|
|
3410
|
-
|
|
2983
|
+
display_order: number;
|
|
3411
2984
|
/**
|
|
3412
|
-
*
|
|
3413
|
-
* @description
|
|
2985
|
+
* Icon
|
|
2986
|
+
* @description Icon identifier (e.g., 'icon-support', 'fa-question')
|
|
3414
2987
|
*/
|
|
3415
|
-
|
|
2988
|
+
icon?: string | null;
|
|
3416
2989
|
/**
|
|
3417
|
-
*
|
|
3418
|
-
* @description
|
|
3419
|
-
* @default true
|
|
2990
|
+
* Color
|
|
2991
|
+
* @description Color hex code (e.g., '#FF5733')
|
|
3420
2992
|
*/
|
|
3421
|
-
|
|
2993
|
+
color?: string | null;
|
|
3422
2994
|
/**
|
|
3423
|
-
*
|
|
3424
|
-
* @description
|
|
3425
|
-
* @default active
|
|
2995
|
+
* Settings
|
|
2996
|
+
* @description Additional JSON settings
|
|
3426
2997
|
*/
|
|
3427
|
-
|
|
2998
|
+
settings?: {
|
|
2999
|
+
[key: string]: unknown;
|
|
3000
|
+
} | null;
|
|
3428
3001
|
};
|
|
3429
3002
|
/**
|
|
3430
|
-
*
|
|
3431
|
-
* @description Request model for
|
|
3003
|
+
* CreateTagRequest
|
|
3004
|
+
* @description Request model for creating a new support tag
|
|
3432
3005
|
* @example {
|
|
3433
|
-
* "
|
|
3434
|
-
* "
|
|
3435
|
-
* "
|
|
3436
|
-
* "
|
|
3437
|
-
* "smtp_enabled": true,
|
|
3438
|
-
* "smtp_host": "smtp.gmail.com",
|
|
3439
|
-
* "smtp_port": 587,
|
|
3440
|
-
* "smtp_use_tls": true
|
|
3006
|
+
* "color": "#FF5733",
|
|
3007
|
+
* "description": "Technical bug or issue",
|
|
3008
|
+
* "tag_name": "Bug",
|
|
3009
|
+
* "tag_slug": "bug"
|
|
3441
3010
|
* }
|
|
3442
3011
|
*/
|
|
3443
|
-
|
|
3012
|
+
CreateTagRequest: {
|
|
3444
3013
|
/**
|
|
3445
|
-
*
|
|
3446
|
-
* @description
|
|
3014
|
+
* Tag Name
|
|
3015
|
+
* @description Tag name
|
|
3447
3016
|
*/
|
|
3448
|
-
|
|
3017
|
+
tag_name: string;
|
|
3449
3018
|
/**
|
|
3450
|
-
*
|
|
3451
|
-
* @description
|
|
3019
|
+
* Tag Slug
|
|
3020
|
+
* @description URL-friendly slug (lowercase, hyphens only)
|
|
3452
3021
|
*/
|
|
3453
|
-
|
|
3022
|
+
tag_slug: string;
|
|
3454
3023
|
/**
|
|
3455
|
-
*
|
|
3456
|
-
* @description
|
|
3024
|
+
* Description
|
|
3025
|
+
* @description Tag description
|
|
3457
3026
|
*/
|
|
3458
|
-
|
|
3027
|
+
description?: string | null;
|
|
3459
3028
|
/**
|
|
3460
|
-
*
|
|
3461
|
-
* @description
|
|
3029
|
+
* Color
|
|
3030
|
+
* @description Color hex code (e.g., '#FF5733')
|
|
3462
3031
|
*/
|
|
3463
|
-
|
|
3032
|
+
color?: string | null;
|
|
3033
|
+
};
|
|
3034
|
+
/**
|
|
3035
|
+
* ReverseMergeRequest
|
|
3036
|
+
* @description Request model for reversing a ticket merge
|
|
3037
|
+
*/
|
|
3038
|
+
ReverseMergeRequest: {
|
|
3464
3039
|
/**
|
|
3465
|
-
*
|
|
3466
|
-
* @description
|
|
3040
|
+
* Reversal Reason
|
|
3041
|
+
* @description Reason for reversal
|
|
3467
3042
|
*/
|
|
3468
|
-
|
|
3043
|
+
reversal_reason: string;
|
|
3044
|
+
};
|
|
3045
|
+
Extensions: {
|
|
3046
|
+
/** @example GENERIC_ERROR */
|
|
3047
|
+
message_code?: string;
|
|
3048
|
+
/** @example [] */
|
|
3049
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
3050
|
+
extra_data?: Record<string, never> | null;
|
|
3051
|
+
/** @example Detailed debug information */
|
|
3052
|
+
debug?: string | null;
|
|
3053
|
+
};
|
|
3054
|
+
/**
|
|
3055
|
+
* CreateCommentRequest
|
|
3056
|
+
* @description Request model for adding a comment
|
|
3057
|
+
*/
|
|
3058
|
+
CreateCommentRequest: {
|
|
3469
3059
|
/**
|
|
3470
|
-
*
|
|
3471
|
-
* @description
|
|
3060
|
+
* Comment Body
|
|
3061
|
+
* @description Comment text
|
|
3472
3062
|
*/
|
|
3473
|
-
|
|
3063
|
+
comment_body: string;
|
|
3474
3064
|
/**
|
|
3475
|
-
*
|
|
3476
|
-
* @description
|
|
3065
|
+
* Is Internal
|
|
3066
|
+
* @description Internal note (agents only)
|
|
3067
|
+
* @default false
|
|
3477
3068
|
*/
|
|
3478
|
-
|
|
3069
|
+
is_internal: boolean | null;
|
|
3070
|
+
};
|
|
3071
|
+
ErrorResponse: {
|
|
3072
|
+
/** @example about:blank */
|
|
3073
|
+
type?: string;
|
|
3074
|
+
/** @example GENERIC_ERROR */
|
|
3075
|
+
code?: string;
|
|
3076
|
+
/** @example Client Error */
|
|
3077
|
+
title?: string;
|
|
3078
|
+
/** @example 400 */
|
|
3079
|
+
status?: number;
|
|
3080
|
+
/** @example An error occurred */
|
|
3081
|
+
detail?: string;
|
|
3082
|
+
/** @example /v1/cart/items */
|
|
3083
|
+
instance?: string;
|
|
3084
|
+
extensions?: components["schemas"]["Extensions"];
|
|
3085
|
+
};
|
|
3086
|
+
/**
|
|
3087
|
+
* SearchTicketsRequest
|
|
3088
|
+
* @description Request model for searching tickets
|
|
3089
|
+
* @example {
|
|
3090
|
+
* "filters": {
|
|
3091
|
+
* "category_id": [
|
|
3092
|
+
* 1,
|
|
3093
|
+
* 2
|
|
3094
|
+
* ],
|
|
3095
|
+
* "created_from": "2025-01-01",
|
|
3096
|
+
* "created_to": "2025-12-31",
|
|
3097
|
+
* "is_overdue": true,
|
|
3098
|
+
* "priority": [
|
|
3099
|
+
* "high",
|
|
3100
|
+
* "urgent"
|
|
3101
|
+
* ],
|
|
3102
|
+
* "status": [
|
|
3103
|
+
* "open",
|
|
3104
|
+
* "pending"
|
|
3105
|
+
* ]
|
|
3106
|
+
* },
|
|
3107
|
+
* "limit": 20,
|
|
3108
|
+
* "page": 1,
|
|
3109
|
+
* "query": "payment issue",
|
|
3110
|
+
* "sort_by": "created_at",
|
|
3111
|
+
* "sort_order": "desc"
|
|
3112
|
+
* }
|
|
3113
|
+
*/
|
|
3114
|
+
SearchTicketsRequest: {
|
|
3479
3115
|
/**
|
|
3480
|
-
*
|
|
3481
|
-
* @description
|
|
3116
|
+
* Query
|
|
3117
|
+
* @description Search query for full-text search
|
|
3482
3118
|
*/
|
|
3483
|
-
|
|
3119
|
+
query?: string | null;
|
|
3484
3120
|
/**
|
|
3485
|
-
*
|
|
3486
|
-
* @description
|
|
3121
|
+
* Filters
|
|
3122
|
+
* @description Advanced filters (status, priority, category, dates, etc.)
|
|
3487
3123
|
*/
|
|
3488
|
-
|
|
3124
|
+
filters?: {
|
|
3125
|
+
[key: string]: unknown;
|
|
3126
|
+
} | null;
|
|
3489
3127
|
/**
|
|
3490
|
-
*
|
|
3491
|
-
* @description
|
|
3128
|
+
* Sort By
|
|
3129
|
+
* @description Sort field (created_at, updated_at, priority, status)
|
|
3130
|
+
* @default created_at
|
|
3492
3131
|
*/
|
|
3493
|
-
|
|
3132
|
+
sort_by: string;
|
|
3494
3133
|
/**
|
|
3495
|
-
*
|
|
3496
|
-
* @description
|
|
3134
|
+
* Sort Order
|
|
3135
|
+
* @description Sort order (asc/desc)
|
|
3136
|
+
* @default desc
|
|
3497
3137
|
*/
|
|
3498
|
-
|
|
3138
|
+
sort_order: string;
|
|
3499
3139
|
/**
|
|
3500
|
-
*
|
|
3501
|
-
* @description
|
|
3140
|
+
* Page
|
|
3141
|
+
* @description Page number
|
|
3142
|
+
* @default 1
|
|
3502
3143
|
*/
|
|
3503
|
-
|
|
3144
|
+
page: number;
|
|
3504
3145
|
/**
|
|
3505
|
-
*
|
|
3506
|
-
* @description
|
|
3146
|
+
* Limit
|
|
3147
|
+
* @description Results per page
|
|
3148
|
+
* @default 20
|
|
3507
3149
|
*/
|
|
3508
|
-
|
|
3150
|
+
limit: number;
|
|
3151
|
+
};
|
|
3152
|
+
/**
|
|
3153
|
+
* AddTeamMemberRequest
|
|
3154
|
+
* @description Request model for adding a team member
|
|
3155
|
+
*/
|
|
3156
|
+
AddTeamMemberRequest: {
|
|
3509
3157
|
/**
|
|
3510
|
-
*
|
|
3511
|
-
* @description
|
|
3158
|
+
* User Id
|
|
3159
|
+
* @description User ID to add to team
|
|
3512
3160
|
*/
|
|
3513
|
-
|
|
3161
|
+
user_id: number;
|
|
3162
|
+
/** User Name */
|
|
3163
|
+
user_name: string;
|
|
3164
|
+
/** User Email */
|
|
3165
|
+
user_email: string;
|
|
3514
3166
|
/**
|
|
3515
|
-
*
|
|
3516
|
-
* @description
|
|
3167
|
+
* Role
|
|
3168
|
+
* @description agent, senior_agent, team_lead, trainee
|
|
3169
|
+
* @default agent
|
|
3517
3170
|
*/
|
|
3518
|
-
|
|
3171
|
+
role: string;
|
|
3519
3172
|
/**
|
|
3520
|
-
*
|
|
3521
|
-
* @
|
|
3173
|
+
* Is Team Lead
|
|
3174
|
+
* @default false
|
|
3522
3175
|
*/
|
|
3523
|
-
|
|
3176
|
+
is_team_lead: boolean;
|
|
3177
|
+
/** Max Concurrent Tickets */
|
|
3178
|
+
max_concurrent_tickets?: number | null;
|
|
3524
3179
|
/**
|
|
3525
|
-
*
|
|
3526
|
-
* @description
|
|
3180
|
+
* Skills
|
|
3181
|
+
* @description Agent skills and expertise
|
|
3527
3182
|
*/
|
|
3528
|
-
|
|
3183
|
+
skills?: string[] | null;
|
|
3529
3184
|
/**
|
|
3530
|
-
*
|
|
3531
|
-
* @description
|
|
3185
|
+
* Skill Level
|
|
3186
|
+
* @description beginner, intermediate, expert, master
|
|
3187
|
+
* @default intermediate
|
|
3532
3188
|
*/
|
|
3533
|
-
|
|
3189
|
+
skill_level: string;
|
|
3534
3190
|
/**
|
|
3535
|
-
*
|
|
3536
|
-
* @description
|
|
3191
|
+
* Categories
|
|
3192
|
+
* @description Categories agent handles
|
|
3537
3193
|
*/
|
|
3538
|
-
|
|
3194
|
+
categories?: string[] | null;
|
|
3539
3195
|
/**
|
|
3540
|
-
*
|
|
3541
|
-
* @description
|
|
3196
|
+
* Priority Levels
|
|
3197
|
+
* @description Priority levels: low, medium, high, critical
|
|
3542
3198
|
*/
|
|
3543
|
-
|
|
3199
|
+
priority_levels?: string[] | null;
|
|
3544
3200
|
/**
|
|
3545
|
-
*
|
|
3546
|
-
* @
|
|
3201
|
+
* Auto Assign Enabled
|
|
3202
|
+
* @default true
|
|
3547
3203
|
*/
|
|
3548
|
-
|
|
3204
|
+
auto_assign_enabled: boolean;
|
|
3549
3205
|
/**
|
|
3550
|
-
*
|
|
3551
|
-
* @description
|
|
3206
|
+
* Assignment Weight
|
|
3207
|
+
* @description Weight for load balancing (100 = normal)
|
|
3208
|
+
* @default 100
|
|
3552
3209
|
*/
|
|
3553
|
-
|
|
3210
|
+
assignment_weight: number;
|
|
3211
|
+
/** Working Hours */
|
|
3212
|
+
working_hours?: {
|
|
3213
|
+
[key: string]: unknown;
|
|
3214
|
+
} | null;
|
|
3554
3215
|
/**
|
|
3555
|
-
*
|
|
3556
|
-
* @
|
|
3216
|
+
* Timezone
|
|
3217
|
+
* @default UTC
|
|
3557
3218
|
*/
|
|
3558
|
-
|
|
3219
|
+
timezone: string;
|
|
3220
|
+
};
|
|
3221
|
+
/**
|
|
3222
|
+
* CreateSLAPolicyRequest
|
|
3223
|
+
* @description Request model for creating a new SLA policy
|
|
3224
|
+
* @example {
|
|
3225
|
+
* "description": "Standard SLA for all tickets",
|
|
3226
|
+
* "escalation_enabled": true,
|
|
3227
|
+
* "escalation_threshold_percent": 80,
|
|
3228
|
+
* "first_response_target_minutes": 60,
|
|
3229
|
+
* "is_default": true,
|
|
3230
|
+
* "policy_name": "Standard Support",
|
|
3231
|
+
* "policy_slug": "standard-support",
|
|
3232
|
+
* "priority_order": 0,
|
|
3233
|
+
* "resolution_target_minutes": 480
|
|
3234
|
+
* }
|
|
3235
|
+
*/
|
|
3236
|
+
CreateSLAPolicyRequest: {
|
|
3559
3237
|
/**
|
|
3560
|
-
*
|
|
3561
|
-
* @description
|
|
3238
|
+
* Policy Name
|
|
3239
|
+
* @description Policy name
|
|
3562
3240
|
*/
|
|
3563
|
-
|
|
3241
|
+
policy_name: string;
|
|
3564
3242
|
/**
|
|
3565
|
-
*
|
|
3566
|
-
* @description
|
|
3243
|
+
* Policy Slug
|
|
3244
|
+
* @description URL-friendly slug (lowercase, hyphens only)
|
|
3567
3245
|
*/
|
|
3568
|
-
|
|
3246
|
+
policy_slug: string;
|
|
3569
3247
|
/**
|
|
3570
|
-
*
|
|
3571
|
-
* @description
|
|
3248
|
+
* Description
|
|
3249
|
+
* @description Policy description
|
|
3572
3250
|
*/
|
|
3573
|
-
|
|
3251
|
+
description?: string | null;
|
|
3574
3252
|
/**
|
|
3575
|
-
*
|
|
3576
|
-
* @description
|
|
3253
|
+
* First Response Target Minutes
|
|
3254
|
+
* @description Target for first response in minutes
|
|
3577
3255
|
*/
|
|
3578
|
-
|
|
3579
|
-
};
|
|
3580
|
-
/**
|
|
3581
|
-
* ExecuteMacroRequest
|
|
3582
|
-
* @description Request model for executing a macro
|
|
3583
|
-
* @example {
|
|
3584
|
-
* "ticket_data": {
|
|
3585
|
-
* "category_id": 5,
|
|
3586
|
-
* "id": 123,
|
|
3587
|
-
* "priority_id": 2,
|
|
3588
|
-
* "status": "open",
|
|
3589
|
-
* "ticket_number": "TKT-12345"
|
|
3590
|
-
* }
|
|
3591
|
-
* }
|
|
3592
|
-
*/
|
|
3593
|
-
ExecuteMacroRequest: {
|
|
3256
|
+
first_response_target_minutes: number;
|
|
3594
3257
|
/**
|
|
3595
|
-
*
|
|
3596
|
-
* @description
|
|
3258
|
+
* Resolution Target Minutes
|
|
3259
|
+
* @description Target for resolution in minutes
|
|
3597
3260
|
*/
|
|
3598
|
-
|
|
3599
|
-
[key: string]: unknown;
|
|
3600
|
-
};
|
|
3601
|
-
};
|
|
3602
|
-
/**
|
|
3603
|
-
* SubmitRatingRequest
|
|
3604
|
-
* @description Request model for submitting a satisfaction rating
|
|
3605
|
-
*/
|
|
3606
|
-
SubmitRatingRequest: {
|
|
3261
|
+
resolution_target_minutes: number;
|
|
3607
3262
|
/**
|
|
3608
|
-
*
|
|
3609
|
-
* @description
|
|
3263
|
+
* Operational Hours Id
|
|
3264
|
+
* @description Business hours schedule ID (NULL = 24/7)
|
|
3610
3265
|
*/
|
|
3611
|
-
|
|
3266
|
+
operational_hours_id?: number | null;
|
|
3612
3267
|
/**
|
|
3613
|
-
*
|
|
3614
|
-
* @description
|
|
3268
|
+
* Escalation Enabled
|
|
3269
|
+
* @description Enable auto-escalation on breach
|
|
3270
|
+
* @default true
|
|
3615
3271
|
*/
|
|
3616
|
-
|
|
3272
|
+
escalation_enabled: boolean;
|
|
3617
3273
|
/**
|
|
3618
|
-
*
|
|
3619
|
-
* @description
|
|
3274
|
+
* Escalation Threshold Percent
|
|
3275
|
+
* @description Escalate at X% of SLA time
|
|
3276
|
+
* @default 80
|
|
3620
3277
|
*/
|
|
3621
|
-
|
|
3278
|
+
escalation_threshold_percent: number;
|
|
3622
3279
|
/**
|
|
3623
|
-
*
|
|
3624
|
-
* @description
|
|
3280
|
+
* Is Default
|
|
3281
|
+
* @description Whether this is the default SLA policy
|
|
3282
|
+
* @default false
|
|
3625
3283
|
*/
|
|
3626
|
-
|
|
3284
|
+
is_default: boolean;
|
|
3285
|
+
/**
|
|
3286
|
+
* Priority Order
|
|
3287
|
+
* @description Priority order (lower = higher priority)
|
|
3288
|
+
* @default 0
|
|
3289
|
+
*/
|
|
3290
|
+
priority_order: number;
|
|
3291
|
+
/**
|
|
3292
|
+
* Settings
|
|
3293
|
+
* @description Additional JSON settings
|
|
3294
|
+
*/
|
|
3295
|
+
settings?: {
|
|
3296
|
+
[key: string]: unknown;
|
|
3297
|
+
} | null;
|
|
3627
3298
|
};
|
|
3628
3299
|
/**
|
|
3629
|
-
*
|
|
3630
|
-
* @description Request model for
|
|
3300
|
+
* UpdateCannedResponseRequest
|
|
3301
|
+
* @description Request model for updating a canned response
|
|
3631
3302
|
*/
|
|
3632
|
-
|
|
3633
|
-
/**
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
|
|
3303
|
+
UpdateCannedResponseRequest: {
|
|
3304
|
+
/** Response Name */
|
|
3305
|
+
response_name?: string | null;
|
|
3306
|
+
/** Response Slug */
|
|
3307
|
+
response_slug?: string | null;
|
|
3308
|
+
/** Subject */
|
|
3309
|
+
subject?: string | null;
|
|
3310
|
+
/** Content */
|
|
3311
|
+
content?: string | null;
|
|
3312
|
+
/** Content Type */
|
|
3313
|
+
content_type?: string | null;
|
|
3314
|
+
/** Category */
|
|
3315
|
+
category?: string | null;
|
|
3316
|
+
/** Tags */
|
|
3317
|
+
tags?: string[] | null;
|
|
3318
|
+
/** Is Public */
|
|
3319
|
+
is_public?: boolean | null;
|
|
3320
|
+
/** Team Ids */
|
|
3321
|
+
team_ids?: number[] | null;
|
|
3322
|
+
/** User Ids */
|
|
3323
|
+
user_ids?: number[] | null;
|
|
3324
|
+
/** Shortcut */
|
|
3325
|
+
shortcut?: string | null;
|
|
3326
|
+
/** Status */
|
|
3327
|
+
status?: string | null;
|
|
3638
3328
|
};
|
|
3639
3329
|
/**
|
|
3640
|
-
*
|
|
3641
|
-
* @description Request model for
|
|
3330
|
+
* CreateHolidayRequest
|
|
3331
|
+
* @description Request model for creating a holiday
|
|
3332
|
+
* @example {
|
|
3333
|
+
* "affects_sla": true,
|
|
3334
|
+
* "holiday_date": "2025-12-25",
|
|
3335
|
+
* "holiday_name": "Christmas Day",
|
|
3336
|
+
* "is_full_day": true,
|
|
3337
|
+
* "is_recurring": true
|
|
3338
|
+
* }
|
|
3642
3339
|
*/
|
|
3643
|
-
|
|
3644
|
-
/**
|
|
3645
|
-
|
|
3646
|
-
* @description User ID to add as watcher
|
|
3647
|
-
*/
|
|
3648
|
-
user_id: number;
|
|
3649
|
-
/**
|
|
3650
|
-
* User Name
|
|
3651
|
-
* @description User name
|
|
3652
|
-
*/
|
|
3653
|
-
user_name: string;
|
|
3340
|
+
CreateHolidayRequest: {
|
|
3341
|
+
/** Holiday Name */
|
|
3342
|
+
holiday_name: string;
|
|
3654
3343
|
/**
|
|
3655
|
-
*
|
|
3656
|
-
*
|
|
3344
|
+
* Holiday Date
|
|
3345
|
+
* Format: date
|
|
3346
|
+
* @description Holiday date
|
|
3657
3347
|
*/
|
|
3658
|
-
|
|
3348
|
+
holiday_date: string;
|
|
3659
3349
|
/**
|
|
3660
|
-
*
|
|
3661
|
-
* @description
|
|
3662
|
-
* @default
|
|
3350
|
+
* Is Recurring
|
|
3351
|
+
* @description Recurs annually
|
|
3352
|
+
* @default false
|
|
3663
3353
|
*/
|
|
3664
|
-
|
|
3354
|
+
is_recurring: boolean;
|
|
3665
3355
|
/**
|
|
3666
|
-
*
|
|
3667
|
-
* @description
|
|
3356
|
+
* Affects Sla
|
|
3357
|
+
* @description Whether this holiday affects SLA
|
|
3668
3358
|
* @default true
|
|
3669
3359
|
*/
|
|
3670
|
-
|
|
3360
|
+
affects_sla: boolean;
|
|
3671
3361
|
/**
|
|
3672
|
-
*
|
|
3673
|
-
* @description
|
|
3362
|
+
* Is Full Day
|
|
3363
|
+
* @description Full day or partial day holiday
|
|
3674
3364
|
* @default true
|
|
3675
3365
|
*/
|
|
3676
|
-
|
|
3366
|
+
is_full_day: boolean;
|
|
3677
3367
|
/**
|
|
3678
|
-
*
|
|
3679
|
-
* @description
|
|
3680
|
-
* @default true
|
|
3368
|
+
* Start Time
|
|
3369
|
+
* @description Start time for partial day
|
|
3681
3370
|
*/
|
|
3682
|
-
|
|
3371
|
+
start_time?: string | null;
|
|
3683
3372
|
/**
|
|
3684
|
-
*
|
|
3685
|
-
* @description
|
|
3686
|
-
* @default true
|
|
3373
|
+
* End Time
|
|
3374
|
+
* @description End time for partial day
|
|
3687
3375
|
*/
|
|
3688
|
-
|
|
3376
|
+
end_time?: string | null;
|
|
3377
|
+
/** Notes */
|
|
3378
|
+
notes?: string | null;
|
|
3689
3379
|
};
|
|
3690
3380
|
/**
|
|
3691
|
-
*
|
|
3692
|
-
* @description Request model for
|
|
3381
|
+
* UpdateCategoryRequest
|
|
3382
|
+
* @description Request model for updating a support category
|
|
3693
3383
|
* @example {
|
|
3694
|
-
* "category_name": "Billing &
|
|
3695
|
-
* "
|
|
3696
|
-
* "color": "#4CAF50",
|
|
3697
|
-
* "default_priority": "medium",
|
|
3698
|
-
* "default_team_id": 123,
|
|
3699
|
-
* "description": "Issues related to billing, invoices, and payments",
|
|
3700
|
-
* "display_order": 1,
|
|
3701
|
-
* "icon": "icon-billing",
|
|
3384
|
+
* "category_name": "Billing & Payment Issues",
|
|
3385
|
+
* "description": "Updated description for billing category",
|
|
3702
3386
|
* "is_public": true,
|
|
3703
|
-
* "
|
|
3704
|
-
*
|
|
3705
|
-
* },
|
|
3706
|
-
* "sla_first_response_minutes": 60,
|
|
3707
|
-
* "sla_resolution_minutes": 480
|
|
3387
|
+
* "sla_first_response_minutes": 30,
|
|
3388
|
+
* "status": "active"
|
|
3708
3389
|
* }
|
|
3709
3390
|
*/
|
|
3710
|
-
|
|
3391
|
+
UpdateCategoryRequest: {
|
|
3711
3392
|
/**
|
|
3712
3393
|
* Category Name
|
|
3713
3394
|
* @description Category name
|
|
3714
3395
|
*/
|
|
3715
|
-
category_name
|
|
3396
|
+
category_name?: string | null;
|
|
3716
3397
|
/**
|
|
3717
3398
|
* Description
|
|
3718
3399
|
* @description Category description
|
|
@@ -3720,22 +3401,22 @@ export interface components {
|
|
|
3720
3401
|
description?: string | null;
|
|
3721
3402
|
/**
|
|
3722
3403
|
* Category Slug
|
|
3723
|
-
* @description URL-friendly slug
|
|
3404
|
+
* @description URL-friendly slug
|
|
3724
3405
|
*/
|
|
3725
|
-
category_slug
|
|
3406
|
+
category_slug?: string | null;
|
|
3726
3407
|
/**
|
|
3727
3408
|
* Parent Category Id
|
|
3728
|
-
* @description Parent category ID
|
|
3409
|
+
* @description Parent category ID
|
|
3729
3410
|
*/
|
|
3730
3411
|
parent_category_id?: number | null;
|
|
3731
3412
|
/**
|
|
3732
3413
|
* Default Team Id
|
|
3733
|
-
* @description Default team ID for auto-routing
|
|
3414
|
+
* @description Default team ID for auto-routing
|
|
3734
3415
|
*/
|
|
3735
3416
|
default_team_id?: number | null;
|
|
3736
3417
|
/**
|
|
3737
3418
|
* Default Priority
|
|
3738
|
-
* @description Default priority slug
|
|
3419
|
+
* @description Default priority slug
|
|
3739
3420
|
*/
|
|
3740
3421
|
default_priority?: string | null;
|
|
3741
3422
|
/**
|
|
@@ -3751,25 +3432,28 @@ export interface components {
|
|
|
3751
3432
|
/**
|
|
3752
3433
|
* Is Public
|
|
3753
3434
|
* @description Whether category is visible to customers
|
|
3754
|
-
* @default true
|
|
3755
3435
|
*/
|
|
3756
|
-
is_public
|
|
3436
|
+
is_public?: boolean | null;
|
|
3757
3437
|
/**
|
|
3758
3438
|
* Display Order
|
|
3759
|
-
* @description Display order for sorting
|
|
3760
|
-
* @default 0
|
|
3439
|
+
* @description Display order for sorting
|
|
3761
3440
|
*/
|
|
3762
|
-
display_order
|
|
3441
|
+
display_order?: number | null;
|
|
3763
3442
|
/**
|
|
3764
3443
|
* Icon
|
|
3765
|
-
* @description Icon identifier
|
|
3444
|
+
* @description Icon identifier
|
|
3766
3445
|
*/
|
|
3767
3446
|
icon?: string | null;
|
|
3768
3447
|
/**
|
|
3769
3448
|
* Color
|
|
3770
|
-
* @description Color hex code
|
|
3449
|
+
* @description Color hex code
|
|
3771
3450
|
*/
|
|
3772
3451
|
color?: string | null;
|
|
3452
|
+
/**
|
|
3453
|
+
* Status
|
|
3454
|
+
* @description Category status: active, inactive, archived
|
|
3455
|
+
*/
|
|
3456
|
+
status?: string | null;
|
|
3773
3457
|
/**
|
|
3774
3458
|
* Settings
|
|
3775
3459
|
* @description Additional JSON settings
|
|
@@ -3779,235 +3463,316 @@ export interface components {
|
|
|
3779
3463
|
} | null;
|
|
3780
3464
|
};
|
|
3781
3465
|
/**
|
|
3782
|
-
*
|
|
3783
|
-
* @description Request model for
|
|
3466
|
+
* CreateBusinessHoursRequest
|
|
3467
|
+
* @description Request model for creating business hours schedule
|
|
3468
|
+
* @example {
|
|
3469
|
+
* "is_default": true,
|
|
3470
|
+
* "observes_holidays": true,
|
|
3471
|
+
* "schedule_name": "Standard Business Hours",
|
|
3472
|
+
* "schedule_slug": "standard-hours",
|
|
3473
|
+
* "timezone": "America/New_York",
|
|
3474
|
+
* "working_hours": {
|
|
3475
|
+
* "friday": {
|
|
3476
|
+
* "enabled": true,
|
|
3477
|
+
* "end": "17:00",
|
|
3478
|
+
* "start": "09:00"
|
|
3479
|
+
* },
|
|
3480
|
+
* "monday": {
|
|
3481
|
+
* "enabled": true,
|
|
3482
|
+
* "end": "17:00",
|
|
3483
|
+
* "start": "09:00"
|
|
3484
|
+
* },
|
|
3485
|
+
* "saturday": {
|
|
3486
|
+
* "enabled": false
|
|
3487
|
+
* },
|
|
3488
|
+
* "sunday": {
|
|
3489
|
+
* "enabled": false
|
|
3490
|
+
* },
|
|
3491
|
+
* "thursday": {
|
|
3492
|
+
* "enabled": true,
|
|
3493
|
+
* "end": "17:00",
|
|
3494
|
+
* "start": "09:00"
|
|
3495
|
+
* },
|
|
3496
|
+
* "tuesday": {
|
|
3497
|
+
* "enabled": true,
|
|
3498
|
+
* "end": "17:00",
|
|
3499
|
+
* "start": "09:00"
|
|
3500
|
+
* },
|
|
3501
|
+
* "wednesday": {
|
|
3502
|
+
* "enabled": true,
|
|
3503
|
+
* "end": "17:00",
|
|
3504
|
+
* "start": "09:00"
|
|
3505
|
+
* }
|
|
3506
|
+
* }
|
|
3507
|
+
* }
|
|
3784
3508
|
*/
|
|
3785
|
-
|
|
3509
|
+
CreateBusinessHoursRequest: {
|
|
3510
|
+
/** Schedule Name */
|
|
3511
|
+
schedule_name: string;
|
|
3512
|
+
/** Schedule Slug */
|
|
3513
|
+
schedule_slug: string;
|
|
3514
|
+
/** Description */
|
|
3515
|
+
description?: string | null;
|
|
3786
3516
|
/**
|
|
3787
|
-
*
|
|
3788
|
-
* @description
|
|
3517
|
+
* Timezone
|
|
3518
|
+
* @description Timezone (e.g., 'America/New_York')
|
|
3519
|
+
* @default UTC
|
|
3789
3520
|
*/
|
|
3790
|
-
|
|
3521
|
+
timezone: string;
|
|
3791
3522
|
/**
|
|
3792
|
-
*
|
|
3793
|
-
* @description
|
|
3523
|
+
* Working Hours
|
|
3524
|
+
* @description Working hours per day of week
|
|
3794
3525
|
*/
|
|
3795
|
-
|
|
3526
|
+
working_hours: {
|
|
3527
|
+
[key: string]: unknown;
|
|
3528
|
+
};
|
|
3529
|
+
/**
|
|
3530
|
+
* Observes Holidays
|
|
3531
|
+
* @description Whether to observe holiday calendar
|
|
3532
|
+
* @default true
|
|
3533
|
+
*/
|
|
3534
|
+
observes_holidays: boolean;
|
|
3535
|
+
/**
|
|
3536
|
+
* Is Default
|
|
3537
|
+
* @description Default business hours for organization
|
|
3538
|
+
* @default false
|
|
3539
|
+
*/
|
|
3540
|
+
is_default: boolean;
|
|
3796
3541
|
};
|
|
3797
3542
|
/**
|
|
3798
|
-
*
|
|
3799
|
-
* @description Request model for
|
|
3543
|
+
* CreateCannedResponseRequest
|
|
3544
|
+
* @description Request model for creating a new canned response
|
|
3800
3545
|
* @example {
|
|
3801
|
-
* "
|
|
3802
|
-
*
|
|
3803
|
-
*
|
|
3804
|
-
*
|
|
3805
|
-
*
|
|
3806
|
-
*
|
|
3807
|
-
*
|
|
3808
|
-
*
|
|
3809
|
-
*
|
|
3810
|
-
*
|
|
3811
|
-
*
|
|
3812
|
-
*
|
|
3813
|
-
*
|
|
3814
|
-
* "open",
|
|
3815
|
-
* "pending"
|
|
3816
|
-
* ]
|
|
3817
|
-
* },
|
|
3818
|
-
* "limit": 20,
|
|
3819
|
-
* "page": 1,
|
|
3820
|
-
* "query": "payment issue",
|
|
3821
|
-
* "sort_by": "created_at",
|
|
3822
|
-
* "sort_order": "desc"
|
|
3546
|
+
* "category": "greeting",
|
|
3547
|
+
* "content": "Hello {{ticket.customer_name}},\\n\\nThank you for contacting support. We received your request and will get back to you shortly.\\n\\nBest regards,\\n{{agent.name}}",
|
|
3548
|
+
* "content_type": "plain",
|
|
3549
|
+
* "is_public": true,
|
|
3550
|
+
* "response_name": "Greeting",
|
|
3551
|
+
* "response_slug": "greeting",
|
|
3552
|
+
* "shortcut": "/greeting",
|
|
3553
|
+
* "status": "active",
|
|
3554
|
+
* "subject": "Thank you for contacting us",
|
|
3555
|
+
* "tags": [
|
|
3556
|
+
* "initial",
|
|
3557
|
+
* "acknowledgment"
|
|
3558
|
+
* ]
|
|
3823
3559
|
* }
|
|
3824
3560
|
*/
|
|
3825
|
-
|
|
3561
|
+
CreateCannedResponseRequest: {
|
|
3826
3562
|
/**
|
|
3827
|
-
*
|
|
3828
|
-
* @description
|
|
3563
|
+
* Response Name
|
|
3564
|
+
* @description Response name/title
|
|
3829
3565
|
*/
|
|
3830
|
-
|
|
3566
|
+
response_name: string;
|
|
3831
3567
|
/**
|
|
3832
|
-
*
|
|
3833
|
-
* @description
|
|
3568
|
+
* Response Slug
|
|
3569
|
+
* @description URL-friendly slug
|
|
3834
3570
|
*/
|
|
3835
|
-
|
|
3836
|
-
[key: string]: unknown;
|
|
3837
|
-
} | null;
|
|
3571
|
+
response_slug: string;
|
|
3838
3572
|
/**
|
|
3839
|
-
*
|
|
3840
|
-
* @description
|
|
3841
|
-
* @default created_at
|
|
3573
|
+
* Subject
|
|
3574
|
+
* @description Email subject (if applicable)
|
|
3842
3575
|
*/
|
|
3843
|
-
|
|
3576
|
+
subject?: string | null;
|
|
3844
3577
|
/**
|
|
3845
|
-
*
|
|
3846
|
-
* @description
|
|
3847
|
-
* @default desc
|
|
3578
|
+
* Content
|
|
3579
|
+
* @description Response content (supports placeholders like {{ticket.customer_name}})
|
|
3848
3580
|
*/
|
|
3849
|
-
|
|
3581
|
+
content: string;
|
|
3850
3582
|
/**
|
|
3851
|
-
*
|
|
3852
|
-
* @description
|
|
3853
|
-
* @default
|
|
3583
|
+
* Content Type
|
|
3584
|
+
* @description Content type (plain, html, markdown)
|
|
3585
|
+
* @default plain
|
|
3854
3586
|
*/
|
|
3855
|
-
|
|
3587
|
+
content_type: string;
|
|
3856
3588
|
/**
|
|
3857
|
-
*
|
|
3858
|
-
* @description
|
|
3859
|
-
* @default 20
|
|
3589
|
+
* Category
|
|
3590
|
+
* @description Response category (greeting, closing, solution, etc.)
|
|
3860
3591
|
*/
|
|
3861
|
-
|
|
3862
|
-
};
|
|
3863
|
-
/**
|
|
3864
|
-
* GetSLAComplianceRequest
|
|
3865
|
-
* @description Request model for SLA compliance report
|
|
3866
|
-
* @example {
|
|
3867
|
-
* "date_from": "2025-11-01",
|
|
3868
|
-
* "date_to": "2025-12-01",
|
|
3869
|
-
* "group_by": "agent"
|
|
3870
|
-
* }
|
|
3871
|
-
*/
|
|
3872
|
-
GetSLAComplianceRequest: {
|
|
3592
|
+
category?: string | null;
|
|
3873
3593
|
/**
|
|
3874
|
-
*
|
|
3875
|
-
*
|
|
3876
|
-
* @description Start date (required)
|
|
3594
|
+
* Tags
|
|
3595
|
+
* @description Tags for quick filtering
|
|
3877
3596
|
*/
|
|
3878
|
-
|
|
3597
|
+
tags?: string[] | null;
|
|
3879
3598
|
/**
|
|
3880
|
-
*
|
|
3881
|
-
*
|
|
3882
|
-
* @
|
|
3599
|
+
* Is Public
|
|
3600
|
+
* @description Available to all agents
|
|
3601
|
+
* @default true
|
|
3883
3602
|
*/
|
|
3884
|
-
|
|
3603
|
+
is_public: boolean;
|
|
3885
3604
|
/**
|
|
3886
|
-
*
|
|
3887
|
-
* @
|
|
3605
|
+
* Team Ids
|
|
3606
|
+
* @description Specific teams (if not public)
|
|
3888
3607
|
*/
|
|
3889
|
-
|
|
3890
|
-
};
|
|
3891
|
-
/**
|
|
3892
|
-
* RemoveTeamMemberRequest
|
|
3893
|
-
* @description Request model for removing a team member
|
|
3894
|
-
*/
|
|
3895
|
-
RemoveTeamMemberRequest: {
|
|
3608
|
+
team_ids?: number[] | null;
|
|
3896
3609
|
/**
|
|
3897
|
-
*
|
|
3898
|
-
* @description
|
|
3610
|
+
* User Ids
|
|
3611
|
+
* @description Specific users (if not public)
|
|
3899
3612
|
*/
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
UpdateTeamRequest: {
|
|
3907
|
-
/** Team Name */
|
|
3908
|
-
team_name?: string | null;
|
|
3909
|
-
/** Description */
|
|
3910
|
-
description?: string | null;
|
|
3911
|
-
/** Team Type */
|
|
3912
|
-
team_type?: string | null;
|
|
3913
|
-
/** Team Lead User Id */
|
|
3914
|
-
team_lead_user_id?: number | null;
|
|
3915
|
-
/** Team Lead Name */
|
|
3916
|
-
team_lead_name?: string | null;
|
|
3917
|
-
/** Team Lead Email */
|
|
3918
|
-
team_lead_email?: string | null;
|
|
3919
|
-
/** Auto Assign Enabled */
|
|
3920
|
-
auto_assign_enabled?: boolean | null;
|
|
3921
|
-
/** Assignment Strategy */
|
|
3922
|
-
assignment_strategy?: string | null;
|
|
3923
|
-
/** Max Tickets Per Agent */
|
|
3924
|
-
max_tickets_per_agent?: number | null;
|
|
3925
|
-
/** Business Hours */
|
|
3926
|
-
business_hours?: {
|
|
3927
|
-
[key: string]: unknown;
|
|
3928
|
-
} | null;
|
|
3929
|
-
/** Timezone */
|
|
3930
|
-
timezone?: string | null;
|
|
3931
|
-
/** Routing Rules */
|
|
3932
|
-
routing_rules?: {
|
|
3933
|
-
[key: string]: unknown;
|
|
3934
|
-
} | null;
|
|
3935
|
-
/** Sla First Response Minutes */
|
|
3936
|
-
sla_first_response_minutes?: number | null;
|
|
3937
|
-
/** Sla Resolution Minutes */
|
|
3938
|
-
sla_resolution_minutes?: number | null;
|
|
3939
|
-
/** Escalation Enabled */
|
|
3940
|
-
escalation_enabled?: boolean | null;
|
|
3941
|
-
/** Escalation After Minutes */
|
|
3942
|
-
escalation_after_minutes?: number | null;
|
|
3943
|
-
/** Escalation Team Id */
|
|
3944
|
-
escalation_team_id?: string | null;
|
|
3945
|
-
/** Is Default */
|
|
3946
|
-
is_default?: boolean | null;
|
|
3613
|
+
user_ids?: number[] | null;
|
|
3614
|
+
/**
|
|
3615
|
+
* Shortcut
|
|
3616
|
+
* @description Keyboard shortcut (e.g., /greeting)
|
|
3617
|
+
*/
|
|
3618
|
+
shortcut?: string | null;
|
|
3947
3619
|
/**
|
|
3948
3620
|
* Status
|
|
3949
|
-
* @description active, inactive, archived
|
|
3621
|
+
* @description Response status (active, inactive, archived)
|
|
3622
|
+
* @default active
|
|
3950
3623
|
*/
|
|
3951
|
-
status
|
|
3952
|
-
/** Settings */
|
|
3953
|
-
settings?: {
|
|
3954
|
-
[key: string]: unknown;
|
|
3955
|
-
} | null;
|
|
3956
|
-
/** Custom Fields */
|
|
3957
|
-
custom_fields?: {
|
|
3958
|
-
[key: string]: unknown;
|
|
3959
|
-
} | null;
|
|
3624
|
+
status: string;
|
|
3960
3625
|
};
|
|
3961
3626
|
/**
|
|
3962
|
-
*
|
|
3963
|
-
* @description Request model for
|
|
3627
|
+
* ExecuteMacroRequest
|
|
3628
|
+
* @description Request model for executing a macro
|
|
3964
3629
|
* @example {
|
|
3965
|
-
* "
|
|
3966
|
-
*
|
|
3967
|
-
*
|
|
3968
|
-
*
|
|
3969
|
-
*
|
|
3970
|
-
*
|
|
3971
|
-
*
|
|
3630
|
+
* "ticket_data": {
|
|
3631
|
+
* "category_id": 5,
|
|
3632
|
+
* "id": 123,
|
|
3633
|
+
* "priority_id": 2,
|
|
3634
|
+
* "status": "open",
|
|
3635
|
+
* "ticket_number": "TKT-12345"
|
|
3636
|
+
* }
|
|
3972
3637
|
* }
|
|
3973
3638
|
*/
|
|
3974
|
-
|
|
3639
|
+
ExecuteMacroRequest: {
|
|
3975
3640
|
/**
|
|
3976
|
-
*
|
|
3977
|
-
* @description
|
|
3641
|
+
* Ticket Data
|
|
3642
|
+
* @description Ticket context data
|
|
3978
3643
|
*/
|
|
3979
|
-
|
|
3644
|
+
ticket_data: {
|
|
3645
|
+
[key: string]: unknown;
|
|
3646
|
+
};
|
|
3647
|
+
};
|
|
3648
|
+
/**
|
|
3649
|
+
* GenerateSurveyRequest
|
|
3650
|
+
* @description Request model for generating a satisfaction survey
|
|
3651
|
+
*/
|
|
3652
|
+
GenerateSurveyRequest: {
|
|
3980
3653
|
/**
|
|
3981
|
-
*
|
|
3982
|
-
* @description
|
|
3654
|
+
* Survey Type
|
|
3655
|
+
* @description Survey type
|
|
3656
|
+
* @default post_resolution
|
|
3983
3657
|
*/
|
|
3984
|
-
|
|
3658
|
+
survey_type: string;
|
|
3659
|
+
};
|
|
3660
|
+
/**
|
|
3661
|
+
* TemplateStatus
|
|
3662
|
+
* @description Template status values
|
|
3663
|
+
* @enum {string}
|
|
3664
|
+
*/
|
|
3665
|
+
TemplateStatus: "active" | "draft" | "archived";
|
|
3666
|
+
/**
|
|
3667
|
+
* RemoveTeamMemberRequest
|
|
3668
|
+
* @description Request model for removing a team member
|
|
3669
|
+
*/
|
|
3670
|
+
RemoveTeamMemberRequest: {
|
|
3985
3671
|
/**
|
|
3986
|
-
*
|
|
3987
|
-
* @description
|
|
3672
|
+
* Removal Reason
|
|
3673
|
+
* @description Reason for removal
|
|
3988
3674
|
*/
|
|
3989
|
-
|
|
3675
|
+
removal_reason?: string | null;
|
|
3676
|
+
};
|
|
3677
|
+
/**
|
|
3678
|
+
* BulkAssignRequest
|
|
3679
|
+
* @description Request model for bulk assigning tickets
|
|
3680
|
+
*/
|
|
3681
|
+
BulkAssignRequest: {
|
|
3990
3682
|
/**
|
|
3991
|
-
*
|
|
3992
|
-
* @description
|
|
3683
|
+
* Ticket Ids
|
|
3684
|
+
* @description List of ticket IDs
|
|
3993
3685
|
*/
|
|
3994
|
-
|
|
3686
|
+
ticket_ids: number[];
|
|
3995
3687
|
/**
|
|
3996
|
-
*
|
|
3997
|
-
* @description
|
|
3688
|
+
* Assigned To User Id
|
|
3689
|
+
* @description User to assign to
|
|
3998
3690
|
*/
|
|
3999
|
-
|
|
3691
|
+
assigned_to_user_id: number;
|
|
4000
3692
|
/**
|
|
4001
|
-
*
|
|
4002
|
-
* @description
|
|
4003
|
-
* @default false
|
|
3693
|
+
* Assigned To Name
|
|
3694
|
+
* @description User name
|
|
4004
3695
|
*/
|
|
4005
|
-
|
|
3696
|
+
assigned_to_name: string;
|
|
4006
3697
|
/**
|
|
4007
|
-
*
|
|
4008
|
-
* @description
|
|
3698
|
+
* Assigned Team Id
|
|
3699
|
+
* @description Team ID (optional)
|
|
4009
3700
|
*/
|
|
4010
|
-
|
|
3701
|
+
assigned_team_id?: number | null;
|
|
3702
|
+
};
|
|
3703
|
+
/**
|
|
3704
|
+
* UpdateTicketRequest
|
|
3705
|
+
* @description Request model for updating a ticket (customer-facing)
|
|
3706
|
+
*/
|
|
3707
|
+
UpdateTicketRequest: {
|
|
3708
|
+
/**
|
|
3709
|
+
* Subject
|
|
3710
|
+
* @description Ticket subject
|
|
3711
|
+
*/
|
|
3712
|
+
subject?: string | null;
|
|
3713
|
+
/**
|
|
3714
|
+
* Description
|
|
3715
|
+
* @description Ticket description
|
|
3716
|
+
*/
|
|
3717
|
+
description?: string | null;
|
|
3718
|
+
/**
|
|
3719
|
+
* Priority
|
|
3720
|
+
* @description Priority level
|
|
3721
|
+
*/
|
|
3722
|
+
priority?: string | null;
|
|
3723
|
+
/**
|
|
3724
|
+
* Category
|
|
3725
|
+
* @description Ticket category
|
|
3726
|
+
*/
|
|
3727
|
+
category?: string | null;
|
|
3728
|
+
/**
|
|
3729
|
+
* Tags
|
|
3730
|
+
* @description Tags
|
|
3731
|
+
*/
|
|
3732
|
+
tags?: string[] | null;
|
|
3733
|
+
};
|
|
3734
|
+
/**
|
|
3735
|
+
* AssignTicketRequest
|
|
3736
|
+
* @description Request model for assigning a ticket
|
|
3737
|
+
*/
|
|
3738
|
+
AssignTicketRequest: {
|
|
3739
|
+
/**
|
|
3740
|
+
* Assigned To User Id
|
|
3741
|
+
* @description User ID to assign to
|
|
3742
|
+
*/
|
|
3743
|
+
assigned_to_user_id?: number | null;
|
|
3744
|
+
/**
|
|
3745
|
+
* Assigned Team Id
|
|
3746
|
+
* @description Team ID to assign to
|
|
3747
|
+
*/
|
|
3748
|
+
assigned_team_id?: number | null;
|
|
3749
|
+
};
|
|
3750
|
+
/**
|
|
3751
|
+
* @example {
|
|
3752
|
+
* "status": "success",
|
|
3753
|
+
* "message": "Operation successful",
|
|
3754
|
+
* "message_code": "api_suc_20001",
|
|
3755
|
+
* "data": {},
|
|
3756
|
+
* "metadata": {
|
|
3757
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
3758
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
3759
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
3760
|
+
* "version": "v1",
|
|
3761
|
+
* "executionTime": 42,
|
|
3762
|
+
* "language": "en-US"
|
|
3763
|
+
* }
|
|
3764
|
+
* }
|
|
3765
|
+
*/
|
|
3766
|
+
StandardResponse: {
|
|
3767
|
+
/** @example success */
|
|
3768
|
+
status?: string;
|
|
3769
|
+
data?: Record<string, never> | null;
|
|
3770
|
+
/** @example Operation successful */
|
|
3771
|
+
message?: string | null;
|
|
3772
|
+
/** @example api_suc_20001 */
|
|
3773
|
+
message_code?: string | null;
|
|
3774
|
+
metadata?: Record<string, never> | null;
|
|
3775
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
4011
3776
|
};
|
|
4012
3777
|
/**
|
|
4013
3778
|
* CreateReportExportRequest
|
|
@@ -4043,267 +3808,387 @@ export interface components {
|
|
|
4043
3808
|
export_format: components["schemas"]["ExportFormat"];
|
|
4044
3809
|
};
|
|
4045
3810
|
/**
|
|
4046
|
-
*
|
|
4047
|
-
* @description
|
|
4048
|
-
* @enum {string}
|
|
4049
|
-
*/
|
|
4050
|
-
ReportType: "ticket_metrics" | "agent_performance" | "sla_compliance" | "custom";
|
|
4051
|
-
/**
|
|
4052
|
-
* CreateSLAPolicyRequest
|
|
4053
|
-
* @description Request model for creating a new SLA policy
|
|
3811
|
+
* ApplyCannedResponseRequest
|
|
3812
|
+
* @description Request model for applying a canned response
|
|
4054
3813
|
* @example {
|
|
4055
|
-
* "
|
|
4056
|
-
*
|
|
4057
|
-
*
|
|
4058
|
-
*
|
|
4059
|
-
*
|
|
4060
|
-
*
|
|
4061
|
-
*
|
|
4062
|
-
*
|
|
4063
|
-
*
|
|
3814
|
+
* "context": {
|
|
3815
|
+
* "agent": {
|
|
3816
|
+
* "email": "jane@example.com",
|
|
3817
|
+
* "name": "Jane Smith"
|
|
3818
|
+
* },
|
|
3819
|
+
* "ticket": {
|
|
3820
|
+
* "customer_name": "John Doe",
|
|
3821
|
+
* "ticket_number": "TKT-12345"
|
|
3822
|
+
* }
|
|
3823
|
+
* }
|
|
4064
3824
|
* }
|
|
4065
3825
|
*/
|
|
4066
|
-
|
|
3826
|
+
ApplyCannedResponseRequest: {
|
|
4067
3827
|
/**
|
|
4068
|
-
*
|
|
4069
|
-
* @description
|
|
3828
|
+
* Context
|
|
3829
|
+
* @description Context data for placeholder replacement (e.g., ticket data, agent data)
|
|
4070
3830
|
*/
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
3831
|
+
context: {
|
|
3832
|
+
[key: string]: unknown;
|
|
3833
|
+
};
|
|
3834
|
+
};
|
|
3835
|
+
/**
|
|
3836
|
+
* CreateMacroRequest
|
|
3837
|
+
* @description Request model for creating a new macro
|
|
3838
|
+
* @example {
|
|
3839
|
+
* "actions": [
|
|
3840
|
+
* {
|
|
3841
|
+
* "action": "set_status",
|
|
3842
|
+
* "value": "solved"
|
|
3843
|
+
* },
|
|
3844
|
+
* {
|
|
3845
|
+
* "action": "add_internal_note",
|
|
3846
|
+
* "note": "Ticket closed as solved"
|
|
3847
|
+
* }
|
|
3848
|
+
* ],
|
|
3849
|
+
* "button_color": "#4CAF50",
|
|
3850
|
+
* "description": "Mark ticket as solved and close it",
|
|
3851
|
+
* "display_order": 1,
|
|
3852
|
+
* "icon": "check-circle",
|
|
3853
|
+
* "include_response": false,
|
|
3854
|
+
* "is_public": true,
|
|
3855
|
+
* "macro_name": "Close as Solved",
|
|
3856
|
+
* "macro_slug": "close-solved",
|
|
3857
|
+
* "status": "active"
|
|
3858
|
+
* }
|
|
3859
|
+
*/
|
|
3860
|
+
CreateMacroRequest: {
|
|
3861
|
+
/**
|
|
3862
|
+
* Macro Name
|
|
3863
|
+
* @description Macro name
|
|
4075
3864
|
*/
|
|
4076
|
-
|
|
3865
|
+
macro_name: string;
|
|
3866
|
+
/**
|
|
3867
|
+
* Macro Slug
|
|
3868
|
+
* @description URL-friendly slug
|
|
3869
|
+
*/
|
|
3870
|
+
macro_slug: string;
|
|
4077
3871
|
/**
|
|
4078
3872
|
* Description
|
|
4079
|
-
* @description
|
|
3873
|
+
* @description Macro description
|
|
4080
3874
|
*/
|
|
4081
3875
|
description?: string | null;
|
|
4082
3876
|
/**
|
|
4083
|
-
*
|
|
4084
|
-
* @description
|
|
3877
|
+
* Actions
|
|
3878
|
+
* @description Actions to perform
|
|
4085
3879
|
*/
|
|
4086
|
-
|
|
3880
|
+
actions: {
|
|
3881
|
+
[key: string]: unknown;
|
|
3882
|
+
}[];
|
|
4087
3883
|
/**
|
|
4088
|
-
*
|
|
4089
|
-
* @description
|
|
3884
|
+
* Include Response
|
|
3885
|
+
* @description Include a canned response
|
|
3886
|
+
* @default false
|
|
4090
3887
|
*/
|
|
4091
|
-
|
|
3888
|
+
include_response: boolean;
|
|
4092
3889
|
/**
|
|
4093
|
-
*
|
|
4094
|
-
* @description
|
|
3890
|
+
* Canned Response Id
|
|
3891
|
+
* @description Canned response to include
|
|
4095
3892
|
*/
|
|
4096
|
-
|
|
3893
|
+
canned_response_id?: number | null;
|
|
4097
3894
|
/**
|
|
4098
|
-
*
|
|
4099
|
-
* @description
|
|
3895
|
+
* Is Public
|
|
3896
|
+
* @description Available to all agents
|
|
4100
3897
|
* @default true
|
|
4101
3898
|
*/
|
|
4102
|
-
|
|
3899
|
+
is_public: boolean;
|
|
4103
3900
|
/**
|
|
4104
|
-
*
|
|
4105
|
-
* @description
|
|
4106
|
-
* @default 80
|
|
3901
|
+
* Team Ids
|
|
3902
|
+
* @description Specific teams (if not public)
|
|
4107
3903
|
*/
|
|
4108
|
-
|
|
3904
|
+
team_ids?: number[] | null;
|
|
4109
3905
|
/**
|
|
4110
|
-
*
|
|
4111
|
-
* @description
|
|
4112
|
-
* @default false
|
|
3906
|
+
* User Ids
|
|
3907
|
+
* @description Specific users (if not public)
|
|
4113
3908
|
*/
|
|
4114
|
-
|
|
3909
|
+
user_ids?: number[] | null;
|
|
4115
3910
|
/**
|
|
4116
|
-
*
|
|
4117
|
-
* @description
|
|
3911
|
+
* Display Order
|
|
3912
|
+
* @description Display order
|
|
4118
3913
|
* @default 0
|
|
4119
3914
|
*/
|
|
4120
|
-
|
|
3915
|
+
display_order: number;
|
|
4121
3916
|
/**
|
|
4122
|
-
*
|
|
4123
|
-
* @description
|
|
3917
|
+
* Button Color
|
|
3918
|
+
* @description Button color (hex)
|
|
4124
3919
|
*/
|
|
4125
|
-
|
|
4126
|
-
|
|
4127
|
-
|
|
3920
|
+
button_color?: string | null;
|
|
3921
|
+
/**
|
|
3922
|
+
* Icon
|
|
3923
|
+
* @description Icon identifier
|
|
3924
|
+
*/
|
|
3925
|
+
icon?: string | null;
|
|
3926
|
+
/**
|
|
3927
|
+
* Status
|
|
3928
|
+
* @description Macro status (active, inactive)
|
|
3929
|
+
* @default active
|
|
3930
|
+
*/
|
|
3931
|
+
status: string;
|
|
3932
|
+
};
|
|
3933
|
+
InvalidParam: {
|
|
3934
|
+
/** @example items[0].quantity */
|
|
3935
|
+
field?: string;
|
|
3936
|
+
/** @example Input should be greater than or equal to 1 */
|
|
3937
|
+
error?: string;
|
|
4128
3938
|
};
|
|
4129
3939
|
/**
|
|
4130
|
-
*
|
|
4131
|
-
* @description
|
|
4132
|
-
* @
|
|
3940
|
+
* UpdateEmailTemplateRequest
|
|
3941
|
+
* @description Request model for updating email template
|
|
3942
|
+
* @example {
|
|
3943
|
+
* "status": "active",
|
|
3944
|
+
* "subject_template": "New Support Ticket #{{ticket_number}}",
|
|
3945
|
+
* "template_name": "Updated Ticket Created Template"
|
|
3946
|
+
* }
|
|
4133
3947
|
*/
|
|
4134
|
-
|
|
3948
|
+
UpdateEmailTemplateRequest: {
|
|
3949
|
+
/** Template Name */
|
|
3950
|
+
template_name?: string | null;
|
|
3951
|
+
/** Description */
|
|
3952
|
+
description?: string | null;
|
|
3953
|
+
/** Subject Template */
|
|
3954
|
+
subject_template?: string | null;
|
|
3955
|
+
/** Body Html */
|
|
3956
|
+
body_html?: string | null;
|
|
3957
|
+
/** Body Text */
|
|
3958
|
+
body_text?: string | null;
|
|
3959
|
+
/** Available Variables */
|
|
3960
|
+
available_variables?: string[] | null;
|
|
3961
|
+
/** From Email */
|
|
3962
|
+
from_email?: string | null;
|
|
3963
|
+
/** From Name */
|
|
3964
|
+
from_name?: string | null;
|
|
3965
|
+
/** Reply To */
|
|
3966
|
+
reply_to?: string | null;
|
|
3967
|
+
/** Is Default */
|
|
3968
|
+
is_default?: boolean | null;
|
|
3969
|
+
status?: components["schemas"]["TemplateStatus"] | null;
|
|
3970
|
+
};
|
|
4135
3971
|
/**
|
|
4136
|
-
*
|
|
4137
|
-
* @description Request model for
|
|
3972
|
+
* SearchCommentsRequest
|
|
3973
|
+
* @description Request model for searching comments
|
|
3974
|
+
* @example {
|
|
3975
|
+
* "include_internal": false,
|
|
3976
|
+
* "limit": 20,
|
|
3977
|
+
* "page": 1,
|
|
3978
|
+
* "query": "refund",
|
|
3979
|
+
* "ticket_id": "tkt_xxx123"
|
|
3980
|
+
* }
|
|
4138
3981
|
*/
|
|
4139
|
-
|
|
4140
|
-
/**
|
|
4141
|
-
* Subject
|
|
4142
|
-
* @description Ticket subject/title
|
|
4143
|
-
*/
|
|
4144
|
-
subject: string;
|
|
4145
|
-
/**
|
|
4146
|
-
* Description
|
|
4147
|
-
* @description Detailed description of the issue
|
|
4148
|
-
*/
|
|
4149
|
-
description: string;
|
|
3982
|
+
SearchCommentsRequest: {
|
|
4150
3983
|
/**
|
|
4151
|
-
*
|
|
4152
|
-
* @description
|
|
3984
|
+
* Query
|
|
3985
|
+
* @description Search query
|
|
4153
3986
|
*/
|
|
4154
|
-
|
|
3987
|
+
query: string;
|
|
4155
3988
|
/**
|
|
4156
|
-
*
|
|
4157
|
-
* @description
|
|
4158
|
-
* @default medium
|
|
3989
|
+
* Ticket Id
|
|
3990
|
+
* @description Filter by specific ticket ID
|
|
4159
3991
|
*/
|
|
4160
|
-
|
|
3992
|
+
ticket_id?: string | null;
|
|
4161
3993
|
/**
|
|
4162
|
-
*
|
|
4163
|
-
* @description
|
|
3994
|
+
* Include Internal
|
|
3995
|
+
* @description Include internal notes in search results
|
|
3996
|
+
* @default false
|
|
4164
3997
|
*/
|
|
4165
|
-
|
|
3998
|
+
include_internal: boolean;
|
|
4166
3999
|
/**
|
|
4167
|
-
*
|
|
4168
|
-
* @description
|
|
4000
|
+
* Page
|
|
4001
|
+
* @description Page number
|
|
4002
|
+
* @default 1
|
|
4169
4003
|
*/
|
|
4170
|
-
|
|
4004
|
+
page: number;
|
|
4171
4005
|
/**
|
|
4172
|
-
*
|
|
4173
|
-
* @description
|
|
4006
|
+
* Limit
|
|
4007
|
+
* @description Results per page
|
|
4008
|
+
* @default 20
|
|
4174
4009
|
*/
|
|
4175
|
-
|
|
4010
|
+
limit: number;
|
|
4011
|
+
};
|
|
4012
|
+
/**
|
|
4013
|
+
* UpdateSavedFilterRequest
|
|
4014
|
+
* @description Request model for updating a saved filter
|
|
4015
|
+
*/
|
|
4016
|
+
UpdateSavedFilterRequest: {
|
|
4017
|
+
/** Filter Name */
|
|
4018
|
+
filter_name?: string | null;
|
|
4019
|
+
/** Filter Slug */
|
|
4020
|
+
filter_slug?: string | null;
|
|
4021
|
+
/** Description */
|
|
4022
|
+
description?: string | null;
|
|
4023
|
+
/** Filter Config */
|
|
4024
|
+
filter_config?: {
|
|
4025
|
+
[key: string]: unknown;
|
|
4026
|
+
} | null;
|
|
4027
|
+
/** Is Public */
|
|
4028
|
+
is_public?: boolean | null;
|
|
4029
|
+
/** Is Default */
|
|
4030
|
+
is_default?: boolean | null;
|
|
4031
|
+
/** Status */
|
|
4032
|
+
status?: string | null;
|
|
4033
|
+
};
|
|
4034
|
+
/**
|
|
4035
|
+
* GetSLAComplianceRequest
|
|
4036
|
+
* @description Request model for SLA compliance report
|
|
4037
|
+
* @example {
|
|
4038
|
+
* "date_from": "2025-11-01",
|
|
4039
|
+
* "date_to": "2025-12-01",
|
|
4040
|
+
* "group_by": "agent"
|
|
4041
|
+
* }
|
|
4042
|
+
*/
|
|
4043
|
+
GetSLAComplianceRequest: {
|
|
4176
4044
|
/**
|
|
4177
|
-
*
|
|
4178
|
-
*
|
|
4045
|
+
* Date From
|
|
4046
|
+
* Format: date
|
|
4047
|
+
* @description Start date (required)
|
|
4179
4048
|
*/
|
|
4180
|
-
|
|
4049
|
+
date_from: string;
|
|
4181
4050
|
/**
|
|
4182
|
-
*
|
|
4183
|
-
*
|
|
4051
|
+
* Date To
|
|
4052
|
+
* Format: date
|
|
4053
|
+
* @description End date (required)
|
|
4184
4054
|
*/
|
|
4185
|
-
|
|
4055
|
+
date_to: string;
|
|
4186
4056
|
/**
|
|
4187
|
-
*
|
|
4188
|
-
* @
|
|
4057
|
+
* @description Grouping dimension
|
|
4058
|
+
* @default daily
|
|
4189
4059
|
*/
|
|
4190
|
-
|
|
4191
|
-
[key: string]: unknown;
|
|
4192
|
-
} | null;
|
|
4060
|
+
group_by: components["schemas"]["GroupByDimension"];
|
|
4193
4061
|
};
|
|
4194
4062
|
/**
|
|
4195
|
-
*
|
|
4196
|
-
*
|
|
4197
|
-
*
|
|
4198
|
-
* "message_code": "api_suc_20001",
|
|
4199
|
-
* "data": {},
|
|
4200
|
-
* "metadata": {
|
|
4201
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
4202
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
4203
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
4204
|
-
* "version": "v1",
|
|
4205
|
-
* "executionTime": 42,
|
|
4206
|
-
* "language": "en-US"
|
|
4207
|
-
* }
|
|
4208
|
-
* }
|
|
4063
|
+
* TemplateType
|
|
4064
|
+
* @description Email template types
|
|
4065
|
+
* @enum {string}
|
|
4209
4066
|
*/
|
|
4210
|
-
|
|
4211
|
-
/** @example success */
|
|
4212
|
-
status?: string;
|
|
4213
|
-
data?: Record<string, never> | null;
|
|
4214
|
-
/** @example Operation successful */
|
|
4215
|
-
message?: string | null;
|
|
4216
|
-
/** @example api_suc_20001 */
|
|
4217
|
-
message_code?: string | null;
|
|
4218
|
-
metadata?: Record<string, never> | null;
|
|
4219
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
4220
|
-
};
|
|
4067
|
+
TemplateType: "ticket_created" | "ticket_updated" | "ticket_assigned" | "ticket_resolved" | "ticket_closed" | "comment_added" | "agent_assigned" | "sla_warning" | "customer_satisfaction";
|
|
4221
4068
|
/**
|
|
4222
|
-
*
|
|
4223
|
-
* @description Request model for
|
|
4069
|
+
* GetAgentPerformanceRequest
|
|
4070
|
+
* @description Request model for getting agent performance metrics
|
|
4071
|
+
* @example {
|
|
4072
|
+
* "agent_id": 123,
|
|
4073
|
+
* "date_from": "2025-11-01",
|
|
4074
|
+
* "date_to": "2025-12-01",
|
|
4075
|
+
* "limit": 50,
|
|
4076
|
+
* "page": 1,
|
|
4077
|
+
* "period_type": "daily"
|
|
4078
|
+
* }
|
|
4224
4079
|
*/
|
|
4225
|
-
|
|
4080
|
+
GetAgentPerformanceRequest: {
|
|
4226
4081
|
/**
|
|
4227
|
-
*
|
|
4228
|
-
* @description
|
|
4082
|
+
* Agent Id
|
|
4083
|
+
* @description Specific agent ID
|
|
4229
4084
|
*/
|
|
4230
|
-
|
|
4085
|
+
agent_id?: number | null;
|
|
4231
4086
|
/**
|
|
4232
|
-
*
|
|
4233
|
-
* @description
|
|
4087
|
+
* Team Id
|
|
4088
|
+
* @description Filter by team ID
|
|
4234
4089
|
*/
|
|
4235
|
-
|
|
4090
|
+
team_id?: number | null;
|
|
4236
4091
|
/**
|
|
4237
|
-
*
|
|
4238
|
-
* @
|
|
4092
|
+
* @description Period type: daily, weekly, monthly
|
|
4093
|
+
* @default daily
|
|
4239
4094
|
*/
|
|
4240
|
-
|
|
4095
|
+
period_type: components["schemas"]["PeriodType"];
|
|
4241
4096
|
/**
|
|
4242
|
-
*
|
|
4243
|
-
* @description
|
|
4097
|
+
* Date From
|
|
4098
|
+
* @description Start date
|
|
4244
4099
|
*/
|
|
4245
|
-
|
|
4100
|
+
date_from?: string | null;
|
|
4101
|
+
/**
|
|
4102
|
+
* Date To
|
|
4103
|
+
* @description End date
|
|
4104
|
+
*/
|
|
4105
|
+
date_to?: string | null;
|
|
4106
|
+
/**
|
|
4107
|
+
* Page
|
|
4108
|
+
* @description Page number
|
|
4109
|
+
* @default 1
|
|
4110
|
+
*/
|
|
4111
|
+
page: number;
|
|
4112
|
+
/**
|
|
4113
|
+
* Limit
|
|
4114
|
+
* @description Items per page
|
|
4115
|
+
* @default 50
|
|
4116
|
+
*/
|
|
4117
|
+
limit: number;
|
|
4246
4118
|
};
|
|
4247
4119
|
/**
|
|
4248
|
-
*
|
|
4249
|
-
* @description Request model for
|
|
4120
|
+
* RateSatisfactionRequest
|
|
4121
|
+
* @description Request model for customer satisfaction rating
|
|
4250
4122
|
*/
|
|
4251
|
-
|
|
4252
|
-
/** Subject */
|
|
4253
|
-
subject?: string | null;
|
|
4254
|
-
/** Description */
|
|
4255
|
-
description?: string | null;
|
|
4123
|
+
RateSatisfactionRequest: {
|
|
4256
4124
|
/**
|
|
4257
|
-
*
|
|
4258
|
-
* @description
|
|
4125
|
+
* Rating
|
|
4126
|
+
* @description Satisfaction rating 1-5
|
|
4259
4127
|
*/
|
|
4260
|
-
|
|
4261
|
-
/** Category */
|
|
4262
|
-
category?: string | null;
|
|
4263
|
-
/** Sub Category */
|
|
4264
|
-
sub_category?: string | null;
|
|
4128
|
+
rating: number;
|
|
4265
4129
|
/**
|
|
4266
|
-
*
|
|
4267
|
-
* @description
|
|
4130
|
+
* Comment
|
|
4131
|
+
* @description Additional feedback
|
|
4268
4132
|
*/
|
|
4269
|
-
|
|
4270
|
-
/** Tags */
|
|
4271
|
-
tags?: string[] | null;
|
|
4272
|
-
/** Custom Fields */
|
|
4273
|
-
custom_fields?: {
|
|
4274
|
-
[key: string]: unknown;
|
|
4275
|
-
} | null;
|
|
4133
|
+
comment?: string | null;
|
|
4276
4134
|
};
|
|
4277
4135
|
/**
|
|
4278
|
-
*
|
|
4279
|
-
* @description Request model for
|
|
4136
|
+
* CreatePriorityRequest
|
|
4137
|
+
* @description Request model for creating a new priority level
|
|
4138
|
+
* @example {
|
|
4139
|
+
* "color": "#FF0000",
|
|
4140
|
+
* "is_default": false,
|
|
4141
|
+
* "priority_level": 1,
|
|
4142
|
+
* "priority_name": "Urgent",
|
|
4143
|
+
* "priority_slug": "urgent",
|
|
4144
|
+
* "sla_first_response_minutes": 15,
|
|
4145
|
+
* "sla_resolution_minutes": 120
|
|
4146
|
+
* }
|
|
4280
4147
|
*/
|
|
4281
|
-
|
|
4282
|
-
/**
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
/**
|
|
4293
|
-
|
|
4294
|
-
|
|
4295
|
-
|
|
4296
|
-
|
|
4297
|
-
|
|
4298
|
-
|
|
4299
|
-
|
|
4300
|
-
|
|
4301
|
-
|
|
4302
|
-
/**
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
|
|
4148
|
+
CreatePriorityRequest: {
|
|
4149
|
+
/**
|
|
4150
|
+
* Priority Name
|
|
4151
|
+
* @description Priority name (e.g., 'Urgent', 'High', 'Medium', 'Low')
|
|
4152
|
+
*/
|
|
4153
|
+
priority_name: string;
|
|
4154
|
+
/**
|
|
4155
|
+
* Priority Slug
|
|
4156
|
+
* @description URL-friendly slug (lowercase, hyphens only)
|
|
4157
|
+
*/
|
|
4158
|
+
priority_slug: string;
|
|
4159
|
+
/**
|
|
4160
|
+
* Priority Level
|
|
4161
|
+
* @description Priority level (1=highest, 100=lowest)
|
|
4162
|
+
*/
|
|
4163
|
+
priority_level: number;
|
|
4164
|
+
/**
|
|
4165
|
+
* Sla First Response Minutes
|
|
4166
|
+
* @description SLA for first response in minutes
|
|
4167
|
+
*/
|
|
4168
|
+
sla_first_response_minutes?: number | null;
|
|
4169
|
+
/**
|
|
4170
|
+
* Sla Resolution Minutes
|
|
4171
|
+
* @description SLA for resolution in minutes
|
|
4172
|
+
*/
|
|
4173
|
+
sla_resolution_minutes?: number | null;
|
|
4174
|
+
/**
|
|
4175
|
+
* Is Default
|
|
4176
|
+
* @description Whether this is the default priority level
|
|
4177
|
+
* @default false
|
|
4178
|
+
*/
|
|
4179
|
+
is_default: boolean;
|
|
4180
|
+
/**
|
|
4181
|
+
* Color
|
|
4182
|
+
* @description Color hex code (e.g., '#FF5733')
|
|
4183
|
+
*/
|
|
4184
|
+
color?: string | null;
|
|
4306
4185
|
};
|
|
4186
|
+
/**
|
|
4187
|
+
* ReportType
|
|
4188
|
+
* @description Report types for exports
|
|
4189
|
+
* @enum {string}
|
|
4190
|
+
*/
|
|
4191
|
+
ReportType: "ticket_metrics" | "agent_performance" | "sla_compliance" | "custom";
|
|
4307
4192
|
/**
|
|
4308
4193
|
* GetDashboardMetricsRequest
|
|
4309
4194
|
* @description Request model for getting dashboard metrics
|
|
@@ -4331,82 +4216,197 @@ export interface components {
|
|
|
4331
4216
|
date_to?: string | null;
|
|
4332
4217
|
};
|
|
4333
4218
|
/**
|
|
4334
|
-
*
|
|
4335
|
-
* @description Request model for
|
|
4219
|
+
* UpdateTicketStatusRequest
|
|
4220
|
+
* @description Request model for updating ticket status
|
|
4221
|
+
*/
|
|
4222
|
+
UpdateTicketStatusRequest: {
|
|
4223
|
+
/**
|
|
4224
|
+
* Status
|
|
4225
|
+
* @description New status: new, open, pending, waiting_for_customer, on_hold, resolved, closed
|
|
4226
|
+
*/
|
|
4227
|
+
status: string;
|
|
4228
|
+
/**
|
|
4229
|
+
* Reason
|
|
4230
|
+
* @description Reason for status change
|
|
4231
|
+
*/
|
|
4232
|
+
reason?: string | null;
|
|
4233
|
+
};
|
|
4234
|
+
/**
|
|
4235
|
+
* MergeTicketsRequest
|
|
4236
|
+
* @description Request model for merging tickets
|
|
4237
|
+
*/
|
|
4238
|
+
MergeTicketsRequest: {
|
|
4239
|
+
/**
|
|
4240
|
+
* Parent Ticket Id
|
|
4241
|
+
* @description Parent ticket ID (kept active)
|
|
4242
|
+
*/
|
|
4243
|
+
parent_ticket_id: number;
|
|
4244
|
+
/**
|
|
4245
|
+
* Child Ticket Id
|
|
4246
|
+
* @description Child ticket ID (merged)
|
|
4247
|
+
*/
|
|
4248
|
+
child_ticket_id: number;
|
|
4249
|
+
/**
|
|
4250
|
+
* Merge Reason
|
|
4251
|
+
* @description Reason for merge
|
|
4252
|
+
*/
|
|
4253
|
+
merge_reason: string;
|
|
4254
|
+
/**
|
|
4255
|
+
* Merge Type
|
|
4256
|
+
* @description Merge type
|
|
4257
|
+
*/
|
|
4258
|
+
merge_type: string;
|
|
4259
|
+
/**
|
|
4260
|
+
* Copy Comments
|
|
4261
|
+
* @description Copy comments to parent
|
|
4262
|
+
* @default true
|
|
4263
|
+
*/
|
|
4264
|
+
copy_comments: boolean;
|
|
4265
|
+
/**
|
|
4266
|
+
* Copy Attachments
|
|
4267
|
+
* @description Copy attachments to parent
|
|
4268
|
+
* @default true
|
|
4269
|
+
*/
|
|
4270
|
+
copy_attachments: boolean;
|
|
4271
|
+
/**
|
|
4272
|
+
* Notify Customers
|
|
4273
|
+
* @description Notify customers
|
|
4274
|
+
* @default true
|
|
4275
|
+
*/
|
|
4276
|
+
notify_customers: boolean;
|
|
4277
|
+
};
|
|
4278
|
+
/**
|
|
4279
|
+
* GroupByDimension
|
|
4280
|
+
* @description Grouping dimensions for SLA compliance
|
|
4281
|
+
* @enum {string}
|
|
4282
|
+
*/
|
|
4283
|
+
GroupByDimension: "daily" | "weekly" | "monthly" | "team" | "agent";
|
|
4284
|
+
/**
|
|
4285
|
+
* CreateAutomationRuleRequest
|
|
4286
|
+
* @description Request model for creating a new automation rule
|
|
4336
4287
|
* @example {
|
|
4337
|
-
* "
|
|
4338
|
-
*
|
|
4339
|
-
*
|
|
4340
|
-
*
|
|
4341
|
-
* "timezone": "America/New_York",
|
|
4342
|
-
* "working_hours": {
|
|
4343
|
-
* "friday": {
|
|
4344
|
-
* "enabled": true,
|
|
4345
|
-
* "end": "17:00",
|
|
4346
|
-
* "start": "09:00"
|
|
4347
|
-
* },
|
|
4348
|
-
* "monday": {
|
|
4349
|
-
* "enabled": true,
|
|
4350
|
-
* "end": "17:00",
|
|
4351
|
-
* "start": "09:00"
|
|
4352
|
-
* },
|
|
4353
|
-
* "saturday": {
|
|
4354
|
-
* "enabled": false
|
|
4355
|
-
* },
|
|
4356
|
-
* "sunday": {
|
|
4357
|
-
* "enabled": false
|
|
4358
|
-
* },
|
|
4359
|
-
* "thursday": {
|
|
4360
|
-
* "enabled": true,
|
|
4361
|
-
* "end": "17:00",
|
|
4362
|
-
* "start": "09:00"
|
|
4363
|
-
* },
|
|
4364
|
-
* "tuesday": {
|
|
4365
|
-
* "enabled": true,
|
|
4366
|
-
* "end": "17:00",
|
|
4367
|
-
* "start": "09:00"
|
|
4288
|
+
* "actions": [
|
|
4289
|
+
* {
|
|
4290
|
+
* "action": "assign_to_team",
|
|
4291
|
+
* "team_id": 456
|
|
4368
4292
|
* },
|
|
4369
|
-
*
|
|
4370
|
-
* "
|
|
4371
|
-
* "
|
|
4372
|
-
* "start": "09:00"
|
|
4293
|
+
* {
|
|
4294
|
+
* "action": "set_priority",
|
|
4295
|
+
* "priority_id": 2
|
|
4373
4296
|
* }
|
|
4374
|
-
*
|
|
4297
|
+
* ],
|
|
4298
|
+
* "applies_to_all_categories": false,
|
|
4299
|
+
* "applies_to_all_priorities": true,
|
|
4300
|
+
* "category_ids": [
|
|
4301
|
+
* 123
|
|
4302
|
+
* ],
|
|
4303
|
+
* "conditions": {
|
|
4304
|
+
* "all": [
|
|
4305
|
+
* {
|
|
4306
|
+
* "field": "category_id",
|
|
4307
|
+
* "operator": "equals",
|
|
4308
|
+
* "value": 123
|
|
4309
|
+
* }
|
|
4310
|
+
* ]
|
|
4311
|
+
* },
|
|
4312
|
+
* "description": "Automatically assign new tickets to the support team",
|
|
4313
|
+
* "execution_order": 1,
|
|
4314
|
+
* "is_active": true,
|
|
4315
|
+
* "rule_name": "Auto-assign New Tickets",
|
|
4316
|
+
* "rule_slug": "auto-assign-new",
|
|
4317
|
+
* "status": "active",
|
|
4318
|
+
* "stop_processing": false,
|
|
4319
|
+
* "trigger_event": "ticket_created"
|
|
4375
4320
|
* }
|
|
4376
4321
|
*/
|
|
4377
|
-
|
|
4378
|
-
/**
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
|
-
|
|
4382
|
-
|
|
4322
|
+
CreateAutomationRuleRequest: {
|
|
4323
|
+
/**
|
|
4324
|
+
* Rule Name
|
|
4325
|
+
* @description Rule name
|
|
4326
|
+
*/
|
|
4327
|
+
rule_name: string;
|
|
4328
|
+
/**
|
|
4329
|
+
* Rule Slug
|
|
4330
|
+
* @description URL-friendly slug (lowercase, hyphens only)
|
|
4331
|
+
*/
|
|
4332
|
+
rule_slug: string;
|
|
4333
|
+
/**
|
|
4334
|
+
* Description
|
|
4335
|
+
* @description Rule description
|
|
4336
|
+
*/
|
|
4383
4337
|
description?: string | null;
|
|
4384
4338
|
/**
|
|
4385
|
-
*
|
|
4386
|
-
* @description
|
|
4387
|
-
* @default UTC
|
|
4339
|
+
* Trigger Event
|
|
4340
|
+
* @description Event that triggers the rule (ticket_created, status_changed, etc.)
|
|
4388
4341
|
*/
|
|
4389
|
-
|
|
4342
|
+
trigger_event: string;
|
|
4390
4343
|
/**
|
|
4391
|
-
*
|
|
4392
|
-
* @description
|
|
4344
|
+
* Execution Order
|
|
4345
|
+
* @description Order of execution (lower runs first)
|
|
4346
|
+
* @default 0
|
|
4393
4347
|
*/
|
|
4394
|
-
|
|
4348
|
+
execution_order: number;
|
|
4349
|
+
/**
|
|
4350
|
+
* Stop Processing
|
|
4351
|
+
* @description Stop processing other rules if this matches
|
|
4352
|
+
* @default false
|
|
4353
|
+
*/
|
|
4354
|
+
stop_processing: boolean;
|
|
4355
|
+
/**
|
|
4356
|
+
* Conditions
|
|
4357
|
+
* @description Matching conditions (AND/OR logic)
|
|
4358
|
+
*/
|
|
4359
|
+
conditions?: {
|
|
4395
4360
|
[key: string]: unknown;
|
|
4396
|
-
};
|
|
4361
|
+
} | null;
|
|
4397
4362
|
/**
|
|
4398
|
-
*
|
|
4399
|
-
* @description
|
|
4363
|
+
* Actions
|
|
4364
|
+
* @description Actions to perform when conditions match
|
|
4365
|
+
*/
|
|
4366
|
+
actions: {
|
|
4367
|
+
[key: string]: unknown;
|
|
4368
|
+
}[];
|
|
4369
|
+
/**
|
|
4370
|
+
* Applies To All Categories
|
|
4371
|
+
* @description Apply to all categories
|
|
4400
4372
|
* @default true
|
|
4401
4373
|
*/
|
|
4402
|
-
|
|
4374
|
+
applies_to_all_categories: boolean;
|
|
4403
4375
|
/**
|
|
4404
|
-
*
|
|
4405
|
-
* @description
|
|
4406
|
-
* @default false
|
|
4376
|
+
* Category Ids
|
|
4377
|
+
* @description Specific category IDs (if not all)
|
|
4407
4378
|
*/
|
|
4408
|
-
|
|
4379
|
+
category_ids?: number[] | null;
|
|
4380
|
+
/**
|
|
4381
|
+
* Applies To All Priorities
|
|
4382
|
+
* @description Apply to all priorities
|
|
4383
|
+
* @default true
|
|
4384
|
+
*/
|
|
4385
|
+
applies_to_all_priorities: boolean;
|
|
4386
|
+
/**
|
|
4387
|
+
* Priority Ids
|
|
4388
|
+
* @description Specific priority IDs (if not all)
|
|
4389
|
+
*/
|
|
4390
|
+
priority_ids?: number[] | null;
|
|
4391
|
+
/**
|
|
4392
|
+
* Is Active
|
|
4393
|
+
* @description Rule is active
|
|
4394
|
+
* @default true
|
|
4395
|
+
*/
|
|
4396
|
+
is_active: boolean;
|
|
4397
|
+
/**
|
|
4398
|
+
* Status
|
|
4399
|
+
* @description Rule status (active, inactive, paused)
|
|
4400
|
+
* @default active
|
|
4401
|
+
*/
|
|
4402
|
+
status: string;
|
|
4409
4403
|
};
|
|
4404
|
+
/**
|
|
4405
|
+
* PeriodType
|
|
4406
|
+
* @description Period type for metrics snapshots
|
|
4407
|
+
* @enum {string}
|
|
4408
|
+
*/
|
|
4409
|
+
PeriodType: "daily" | "weekly" | "monthly";
|
|
4410
4410
|
};
|
|
4411
4411
|
responses: never;
|
|
4412
4412
|
parameters: never;
|
|
@@ -5455,7 +5455,7 @@ export interface operations {
|
|
|
5455
5455
|
};
|
|
5456
5456
|
requestBody: {
|
|
5457
5457
|
content: {
|
|
5458
|
-
"application/json": components["schemas"]["
|
|
5458
|
+
"application/json": components["schemas"]["CreateCommentRequest"];
|
|
5459
5459
|
};
|
|
5460
5460
|
};
|
|
5461
5461
|
responses: {
|
|
@@ -7703,7 +7703,7 @@ export interface operations {
|
|
|
7703
7703
|
};
|
|
7704
7704
|
requestBody: {
|
|
7705
7705
|
content: {
|
|
7706
|
-
"application/json": components["schemas"]["
|
|
7706
|
+
"application/json": components["schemas"]["CreateCommentRequest"];
|
|
7707
7707
|
};
|
|
7708
7708
|
};
|
|
7709
7709
|
responses: {
|
|
@@ -7908,7 +7908,7 @@ export interface operations {
|
|
|
7908
7908
|
};
|
|
7909
7909
|
requestBody: {
|
|
7910
7910
|
content: {
|
|
7911
|
-
"application/json": components["schemas"]["
|
|
7911
|
+
"application/json": components["schemas"]["CreateCommentRequest"];
|
|
7912
7912
|
};
|
|
7913
7913
|
};
|
|
7914
7914
|
responses: {
|
|
@@ -10166,7 +10166,7 @@ export interface operations {
|
|
|
10166
10166
|
};
|
|
10167
10167
|
requestBody: {
|
|
10168
10168
|
content: {
|
|
10169
|
-
"application/json": components["schemas"]["
|
|
10169
|
+
"application/json": components["schemas"]["app__models__support__category_models__CreateCategoryRequest"];
|
|
10170
10170
|
};
|
|
10171
10171
|
};
|
|
10172
10172
|
responses: {
|
|
@@ -10776,7 +10776,7 @@ export interface operations {
|
|
|
10776
10776
|
};
|
|
10777
10777
|
requestBody: {
|
|
10778
10778
|
content: {
|
|
10779
|
-
"application/json": components["schemas"]["
|
|
10779
|
+
"application/json": components["schemas"]["UpdateCategoryRequest"];
|
|
10780
10780
|
};
|
|
10781
10781
|
};
|
|
10782
10782
|
responses: {
|
|
@@ -11185,7 +11185,7 @@ export interface operations {
|
|
|
11185
11185
|
};
|
|
11186
11186
|
requestBody: {
|
|
11187
11187
|
content: {
|
|
11188
|
-
"application/json": components["schemas"]["
|
|
11188
|
+
"application/json": components["schemas"]["CreateTagRequest"];
|
|
11189
11189
|
};
|
|
11190
11190
|
};
|
|
11191
11191
|
responses: {
|
|
@@ -12606,7 +12606,7 @@ export interface operations {
|
|
|
12606
12606
|
};
|
|
12607
12607
|
requestBody: {
|
|
12608
12608
|
content: {
|
|
12609
|
-
"application/json": components["schemas"]["
|
|
12609
|
+
"application/json": components["schemas"]["CreateHolidayRequest"];
|
|
12610
12610
|
};
|
|
12611
12611
|
};
|
|
12612
12612
|
responses: {
|