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