@opencx/mcp 1.11.84 → 1.11.86
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/schema.d.ts +557 -19
- package/dist/schema.d.ts.map +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +4 -0
- package/dist/server.js.map +1 -1
- package/dist/tools/conversation-sankey.d.ts +4 -0
- package/dist/tools/conversation-sankey.d.ts.map +1 -0
- package/dist/tools/conversation-sankey.js +37 -0
- package/dist/tools/conversation-sankey.js.map +1 -0
- package/dist/tools/resource-usage.d.ts +4 -0
- package/dist/tools/resource-usage.d.ts.map +1 -0
- package/dist/tools/resource-usage.js +80 -0
- package/dist/tools/resource-usage.js.map +1 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1280,6 +1280,58 @@ export interface paths {
|
|
|
1280
1280
|
patch?: never;
|
|
1281
1281
|
trace?: never;
|
|
1282
1282
|
};
|
|
1283
|
+
"/macros": {
|
|
1284
|
+
parameters: {
|
|
1285
|
+
query?: never;
|
|
1286
|
+
header?: never;
|
|
1287
|
+
path?: never;
|
|
1288
|
+
cookie?: never;
|
|
1289
|
+
};
|
|
1290
|
+
/**
|
|
1291
|
+
* List macros
|
|
1292
|
+
* @description List all saved-reply macros for the organization.
|
|
1293
|
+
*/
|
|
1294
|
+
get: operations["listMacros"];
|
|
1295
|
+
put?: never;
|
|
1296
|
+
/**
|
|
1297
|
+
* Create a macro
|
|
1298
|
+
* @description Create a new saved-reply macro. Use {{variable}} syntax in content to reference system or custom variables.
|
|
1299
|
+
*/
|
|
1300
|
+
post: operations["createMacro"];
|
|
1301
|
+
delete?: never;
|
|
1302
|
+
options?: never;
|
|
1303
|
+
head?: never;
|
|
1304
|
+
patch?: never;
|
|
1305
|
+
trace?: never;
|
|
1306
|
+
};
|
|
1307
|
+
"/macros/{id}": {
|
|
1308
|
+
parameters: {
|
|
1309
|
+
query?: never;
|
|
1310
|
+
header?: never;
|
|
1311
|
+
path?: never;
|
|
1312
|
+
cookie?: never;
|
|
1313
|
+
};
|
|
1314
|
+
/**
|
|
1315
|
+
* Get a macro
|
|
1316
|
+
* @description Get a single saved-reply macro by ID.
|
|
1317
|
+
*/
|
|
1318
|
+
get: operations["getMacro"];
|
|
1319
|
+
put?: never;
|
|
1320
|
+
post?: never;
|
|
1321
|
+
/**
|
|
1322
|
+
* Delete a macro
|
|
1323
|
+
* @description Permanently delete a saved-reply macro.
|
|
1324
|
+
*/
|
|
1325
|
+
delete: operations["deleteMacro"];
|
|
1326
|
+
options?: never;
|
|
1327
|
+
head?: never;
|
|
1328
|
+
/**
|
|
1329
|
+
* Update a macro
|
|
1330
|
+
* @description Partially update a saved-reply macro.
|
|
1331
|
+
*/
|
|
1332
|
+
patch: operations["updateMacro"];
|
|
1333
|
+
trace?: never;
|
|
1334
|
+
};
|
|
1283
1335
|
"/handoff-analytics/events": {
|
|
1284
1336
|
parameters: {
|
|
1285
1337
|
query?: never;
|
|
@@ -1340,6 +1392,26 @@ export interface paths {
|
|
|
1340
1392
|
patch?: never;
|
|
1341
1393
|
trace?: never;
|
|
1342
1394
|
};
|
|
1395
|
+
"/impact-report/sankey": {
|
|
1396
|
+
parameters: {
|
|
1397
|
+
query?: never;
|
|
1398
|
+
header?: never;
|
|
1399
|
+
path?: never;
|
|
1400
|
+
cookie?: never;
|
|
1401
|
+
};
|
|
1402
|
+
/**
|
|
1403
|
+
* Get conversation-flow Sankey
|
|
1404
|
+
* @description Get a Sankey breakdown of how conversations flow through the chosen dimensions. Pass an ordered, comma-separated list of dimension keys (e.g. "replied_by,outcome" or "integration_source,channel"). Returns nodes and links describing the flow.
|
|
1405
|
+
*/
|
|
1406
|
+
get: operations["getConversationSankey"];
|
|
1407
|
+
put?: never;
|
|
1408
|
+
post?: never;
|
|
1409
|
+
delete?: never;
|
|
1410
|
+
options?: never;
|
|
1411
|
+
head?: never;
|
|
1412
|
+
patch?: never;
|
|
1413
|
+
trace?: never;
|
|
1414
|
+
};
|
|
1343
1415
|
"/office-hours": {
|
|
1344
1416
|
parameters: {
|
|
1345
1417
|
query?: never;
|
|
@@ -2044,6 +2116,46 @@ export interface paths {
|
|
|
2044
2116
|
patch?: never;
|
|
2045
2117
|
trace?: never;
|
|
2046
2118
|
};
|
|
2119
|
+
"/resource-usage/{resource_type}/{resource_id}/conversations": {
|
|
2120
|
+
parameters: {
|
|
2121
|
+
query?: never;
|
|
2122
|
+
header?: never;
|
|
2123
|
+
path?: never;
|
|
2124
|
+
cookie?: never;
|
|
2125
|
+
};
|
|
2126
|
+
/**
|
|
2127
|
+
* List conversations that used a resource
|
|
2128
|
+
* @description Reverse lookup: list the conversations where a given action, instruction, or KB item was used, newest first. Returns one row per conversation with the reply count, ticket number, last message, and first/last-used timestamps. Defaults to `applied` usage (the resource actually fired); pass `usageKind=available` to see where an instruction was in context but may not have fired.
|
|
2129
|
+
*/
|
|
2130
|
+
get: operations["listResourceConversations"];
|
|
2131
|
+
put?: never;
|
|
2132
|
+
post?: never;
|
|
2133
|
+
delete?: never;
|
|
2134
|
+
options?: never;
|
|
2135
|
+
head?: never;
|
|
2136
|
+
patch?: never;
|
|
2137
|
+
trace?: never;
|
|
2138
|
+
};
|
|
2139
|
+
"/resource-usage/{resource_type}/{resource_id}/usage-summary": {
|
|
2140
|
+
parameters: {
|
|
2141
|
+
query?: never;
|
|
2142
|
+
header?: never;
|
|
2143
|
+
path?: never;
|
|
2144
|
+
cookie?: never;
|
|
2145
|
+
};
|
|
2146
|
+
/**
|
|
2147
|
+
* Get usage counts for a resource
|
|
2148
|
+
* @description Aggregate usage for a given action, instruction, or KB item: distinct sessions and total replies where it was applied, the available counterpart (for instructions, to compute apply-rate), and first/last-used timestamps. Optionally bound by a date range.
|
|
2149
|
+
*/
|
|
2150
|
+
get: operations["getResourceUsageSummary"];
|
|
2151
|
+
put?: never;
|
|
2152
|
+
post?: never;
|
|
2153
|
+
delete?: never;
|
|
2154
|
+
options?: never;
|
|
2155
|
+
head?: never;
|
|
2156
|
+
patch?: never;
|
|
2157
|
+
trace?: never;
|
|
2158
|
+
};
|
|
2047
2159
|
"/sequences": {
|
|
2048
2160
|
parameters: {
|
|
2049
2161
|
query?: never;
|
|
@@ -4000,6 +4112,16 @@ export interface components {
|
|
|
4000
4112
|
/** @description Optional reason for redaction */
|
|
4001
4113
|
reason?: string;
|
|
4002
4114
|
};
|
|
4115
|
+
CreateSavedReplyDto: {
|
|
4116
|
+
category: string;
|
|
4117
|
+
title: string;
|
|
4118
|
+
content: string;
|
|
4119
|
+
};
|
|
4120
|
+
UpdateSavedReplyDto: {
|
|
4121
|
+
category?: string;
|
|
4122
|
+
title?: string;
|
|
4123
|
+
content?: string;
|
|
4124
|
+
};
|
|
4003
4125
|
SalesforceMiawWebhookBody: {
|
|
4004
4126
|
/** @enum {string} */
|
|
4005
4127
|
event: "message:new";
|
|
@@ -4762,7 +4884,7 @@ export interface components {
|
|
|
4762
4884
|
* @description What starts the workflow. Use "manual-trigger" for on-demand execution, "ai-trigger" for AI-initiated, "webhook" for external HTTP triggers, "cron-trigger" for scheduled runs, or event-based triggers like "ticket-created", "contact-created", etc.
|
|
4763
4885
|
* @enum {string}
|
|
4764
4886
|
*/
|
|
4765
|
-
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4887
|
+
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4766
4888
|
/** @description Trigger-specific configuration (e.g. cron expression for cron-trigger) */
|
|
4767
4889
|
trigger_configuration?: unknown | null;
|
|
4768
4890
|
/** @description Array of workflow steps and control-flow blocks. Each step is an object with { "$kind": "Action", "id": "<unique-step-id>", "type": "<action-type>", "name": "<display-name>", "input": { ... } }. Control-flow blocks use { "$kind": "Block", "type": "if-else", "id": "<unique-id>", "inputs": { "condition": { "operatorName": "equals", "left": "{{step_id.field}}", "right": "value" } }, "branches": { "then": [...steps], "else": [...steps] } }. Use {{step_id.field}} to reference outputs from previous steps (no `.output.` segment — the field sits directly under the step id). */
|
|
@@ -4779,7 +4901,7 @@ export interface components {
|
|
|
4779
4901
|
* @description New trigger type
|
|
4780
4902
|
* @enum {string}
|
|
4781
4903
|
*/
|
|
4782
|
-
trigger_type?: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4904
|
+
trigger_type?: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4783
4905
|
/** @description New trigger configuration */
|
|
4784
4906
|
trigger_configuration?: unknown | null;
|
|
4785
4907
|
/** @description New workflow step/block definitions (replaces existing blocks) */
|
|
@@ -4792,7 +4914,7 @@ export interface components {
|
|
|
4792
4914
|
* @description Trigger type to validate against
|
|
4793
4915
|
* @enum {string}
|
|
4794
4916
|
*/
|
|
4795
|
-
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4917
|
+
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4796
4918
|
/** @description Trigger configuration to validate against the trigger's configuration_def. When omitted, the trigger is validated as if unconfigured — triggers with required configuration (e.g. cron-trigger, ai-trigger) will report errors. */
|
|
4797
4919
|
trigger_configuration?: unknown | null;
|
|
4798
4920
|
/** @description Workflow blocks to validate */
|
|
@@ -4805,7 +4927,7 @@ export interface components {
|
|
|
4805
4927
|
* @description Trigger type whose payload shape this synthetic payload should match
|
|
4806
4928
|
* @enum {string}
|
|
4807
4929
|
*/
|
|
4808
|
-
type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4930
|
+
type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "agent-availability-changed" | "agent-avail-in-team-changed";
|
|
4809
4931
|
payload: unknown;
|
|
4810
4932
|
};
|
|
4811
4933
|
};
|
|
@@ -4956,6 +5078,8 @@ export interface components {
|
|
|
4956
5078
|
};
|
|
4957
5079
|
CreateEmailTemplatePublicInput: components["schemas"]["CreateEmailTemplateBodyDto"];
|
|
4958
5080
|
UpdateEmailTemplatePublicInput: components["schemas"]["CreateEmailTemplateBodyDto"];
|
|
5081
|
+
CreateMacroInput: components["schemas"]["CreateSavedReplyDto"];
|
|
5082
|
+
UpdateMacroInput: components["schemas"]["UpdateSavedReplyDto"];
|
|
4959
5083
|
UpsertTagInputDto: {
|
|
4960
5084
|
/** @description Tag name (e.g. "billing", "refund", "feature-request") */
|
|
4961
5085
|
tag_name: string;
|
|
@@ -4988,12 +5112,14 @@ export interface components {
|
|
|
4988
5112
|
limit: number;
|
|
4989
5113
|
visibility?: ("internal" | "public")[];
|
|
4990
5114
|
sourceTypes?: ("custom_training" | "help_center" | "integration" | "website")[];
|
|
4991
|
-
dataSources?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "ai_instructions" | "custom_training" | "website")[];
|
|
5115
|
+
dataSources?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website")[];
|
|
4992
5116
|
/**
|
|
4993
5117
|
* @default relevance
|
|
4994
5118
|
* @enum {string}
|
|
4995
5119
|
*/
|
|
4996
|
-
sortBy: "relevance" | "handoffs";
|
|
5120
|
+
sortBy: "relevance" | "handoffs" | "citations";
|
|
5121
|
+
dateFrom?: unknown;
|
|
5122
|
+
dateTo?: unknown;
|
|
4997
5123
|
/**
|
|
4998
5124
|
* @description Include the full content field in results. Set to false to reduce response size.
|
|
4999
5125
|
* @default true
|
|
@@ -5125,7 +5251,7 @@ export interface components {
|
|
|
5125
5251
|
/** @constant */
|
|
5126
5252
|
type: "response_skipped";
|
|
5127
5253
|
/** @enum {string} */
|
|
5128
|
-
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff";
|
|
5254
|
+
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "superseded_by_newer_run";
|
|
5129
5255
|
reasoning?: ({
|
|
5130
5256
|
/** @constant */
|
|
5131
5257
|
type: "reasoning";
|
|
@@ -5228,6 +5354,23 @@ export interface components {
|
|
|
5228
5354
|
language: "en" | "fr" | "de" | "nl" | "pl" | "pt" | "es" | "it" | "ru" | "ja" | "ko" | "zh" | "ar" | "tr" | "sv" | "da" | "no" | "fi" | "el" | "cs" | "hu" | "th" | "vi" | "id" | "he" | "hi" | "uk" | "ro" | "bg" | "hr" | "sk" | "sl" | "sr" | "et" | "lv" | "lt" | "is" | "ga" | "ms" | "tl" | "fa" | "bn" | "ta" | "te" | "ur" | "sw" | "zu" | "af" | "sq" | "hy" | "az" | "eu" | "be" | "bs" | "ca" | "cy" | "ku" | "ckb" | "kmr";
|
|
5229
5355
|
};
|
|
5230
5356
|
};
|
|
5357
|
+
actionCalls?: {
|
|
5358
|
+
action: {
|
|
5359
|
+
name: string;
|
|
5360
|
+
id: string;
|
|
5361
|
+
openapi?: {
|
|
5362
|
+
openapi_spec_id?: string;
|
|
5363
|
+
operation_spec: unknown;
|
|
5364
|
+
operation_id?: string;
|
|
5365
|
+
operation_method?: string;
|
|
5366
|
+
};
|
|
5367
|
+
metadata: unknown;
|
|
5368
|
+
required_form_submission?: boolean;
|
|
5369
|
+
is_handoff_like?: boolean;
|
|
5370
|
+
};
|
|
5371
|
+
arguments: unknown;
|
|
5372
|
+
result: unknown;
|
|
5373
|
+
}[];
|
|
5231
5374
|
/** @default null */
|
|
5232
5375
|
assignment_choice_summary: {
|
|
5233
5376
|
/** @constant */
|
|
@@ -5243,6 +5386,11 @@ export interface components {
|
|
|
5243
5386
|
max_capacity_in_group: number | null;
|
|
5244
5387
|
is_available_globally: boolean;
|
|
5245
5388
|
is_available_in_group: boolean;
|
|
5389
|
+
/** @default [] */
|
|
5390
|
+
missing_required_skills: {
|
|
5391
|
+
id: string;
|
|
5392
|
+
name: string;
|
|
5393
|
+
}[];
|
|
5246
5394
|
} | null;
|
|
5247
5395
|
peers: {
|
|
5248
5396
|
agent_id: number;
|
|
@@ -5255,6 +5403,16 @@ export interface components {
|
|
|
5255
5403
|
max_capacity_in_group: number | null;
|
|
5256
5404
|
is_available_globally: boolean;
|
|
5257
5405
|
is_available_in_group: boolean;
|
|
5406
|
+
/** @default [] */
|
|
5407
|
+
missing_required_skills: {
|
|
5408
|
+
id: string;
|
|
5409
|
+
name: string;
|
|
5410
|
+
}[];
|
|
5411
|
+
}[];
|
|
5412
|
+
/** @default [] */
|
|
5413
|
+
required_skills: {
|
|
5414
|
+
id: string;
|
|
5415
|
+
name: string;
|
|
5258
5416
|
}[];
|
|
5259
5417
|
} | null;
|
|
5260
5418
|
} | {
|
|
@@ -5321,6 +5479,11 @@ export interface components {
|
|
|
5321
5479
|
max_capacity_in_group: number | null;
|
|
5322
5480
|
is_available_globally: boolean;
|
|
5323
5481
|
is_available_in_group: boolean;
|
|
5482
|
+
/** @default [] */
|
|
5483
|
+
missing_required_skills: {
|
|
5484
|
+
id: string;
|
|
5485
|
+
name: string;
|
|
5486
|
+
}[];
|
|
5324
5487
|
} | null;
|
|
5325
5488
|
peers: {
|
|
5326
5489
|
agent_id: number;
|
|
@@ -5333,6 +5496,16 @@ export interface components {
|
|
|
5333
5496
|
max_capacity_in_group: number | null;
|
|
5334
5497
|
is_available_globally: boolean;
|
|
5335
5498
|
is_available_in_group: boolean;
|
|
5499
|
+
/** @default [] */
|
|
5500
|
+
missing_required_skills: {
|
|
5501
|
+
id: string;
|
|
5502
|
+
name: string;
|
|
5503
|
+
}[];
|
|
5504
|
+
}[];
|
|
5505
|
+
/** @default [] */
|
|
5506
|
+
required_skills: {
|
|
5507
|
+
id: string;
|
|
5508
|
+
name: string;
|
|
5336
5509
|
}[];
|
|
5337
5510
|
} | null;
|
|
5338
5511
|
destination_id?: string;
|
|
@@ -5352,7 +5525,7 @@ export interface components {
|
|
|
5352
5525
|
}) | null;
|
|
5353
5526
|
knowledgebase_called?: boolean | null;
|
|
5354
5527
|
/** @enum {string} */
|
|
5355
|
-
type: "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_not_reply" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "ai_response_cancelled" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "message" | "prohibited_topic_detected" | "sequence_message" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_system" | "system_reopened_session" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
5528
|
+
type: "agent_assigned_by_integration" | "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_integration" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_not_reply" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "prohibited_topic_detected" | "sequence_message" | "skills_added_by_system" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_system" | "system_reopened_session" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_added_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration" | "tag_removed_by_system" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
5356
5529
|
extra_params?: {
|
|
5357
5530
|
[key: string]: unknown;
|
|
5358
5531
|
} | null;
|
|
@@ -5369,6 +5542,8 @@ export interface components {
|
|
|
5369
5542
|
contact_slack_data?: string | null;
|
|
5370
5543
|
attachments?: components["schemas"]["ChatAttachmentDto"][] | null;
|
|
5371
5544
|
email_rfc_message_id?: string | null;
|
|
5545
|
+
email_to?: string[] | null;
|
|
5546
|
+
email_cc?: string[] | null;
|
|
5372
5547
|
external_message_id?: string | null;
|
|
5373
5548
|
csat_score?: number | null;
|
|
5374
5549
|
csat_feedback?: string | null;
|
|
@@ -5471,6 +5646,7 @@ export interface components {
|
|
|
5471
5646
|
recording_enabled: boolean;
|
|
5472
5647
|
stt_keyterms: string[];
|
|
5473
5648
|
stt_model: ("deepgram/flux-general" | "deepgram/nova-3" | "deepgram/nova-3-medical" | "cartesia/ink-whisper" | "elevenlabs/scribe_v2_realtime" | "xai/stt-1") | null;
|
|
5649
|
+
tts_speed_pct: number | null;
|
|
5474
5650
|
failover_transfer_destination_id: string | null;
|
|
5475
5651
|
};
|
|
5476
5652
|
PhoneAgentVoiceDto: {
|
|
@@ -5593,6 +5769,21 @@ export interface components {
|
|
|
5593
5769
|
ended_at: string | null;
|
|
5594
5770
|
status: components["schemas"]["SequenceStatus"] | null;
|
|
5595
5771
|
};
|
|
5772
|
+
SankeyReportResDto: {
|
|
5773
|
+
nodes: {
|
|
5774
|
+
id: string;
|
|
5775
|
+
/** @enum {string} */
|
|
5776
|
+
dimensionKey: "replied_by" | "outcome" | "handoff" | "channel" | "integration_source" | "assist_mode" | "contact_custom_data" | "sentiment" | "status" | "assigned_team" | "contact_source";
|
|
5777
|
+
dimensionLabel: string;
|
|
5778
|
+
bucket: string;
|
|
5779
|
+
count: number;
|
|
5780
|
+
}[];
|
|
5781
|
+
links: {
|
|
5782
|
+
source: string;
|
|
5783
|
+
target: string;
|
|
5784
|
+
value: number;
|
|
5785
|
+
}[];
|
|
5786
|
+
};
|
|
5596
5787
|
EmailTemplateActivityItemDto: {
|
|
5597
5788
|
id: string;
|
|
5598
5789
|
from_email: string;
|
|
@@ -5816,6 +6007,17 @@ export interface components {
|
|
|
5816
6007
|
breaches: number;
|
|
5817
6008
|
}[];
|
|
5818
6009
|
};
|
|
6010
|
+
SavedReplyDto: {
|
|
6011
|
+
id: string;
|
|
6012
|
+
org_id: string;
|
|
6013
|
+
category: string;
|
|
6014
|
+
title: string;
|
|
6015
|
+
content: string;
|
|
6016
|
+
/** Format: date-time */
|
|
6017
|
+
created_at: string;
|
|
6018
|
+
/** Format: date-time */
|
|
6019
|
+
updated_at: string;
|
|
6020
|
+
};
|
|
5819
6021
|
StartOneOffSequenceOutputDto: {
|
|
5820
6022
|
data?: {
|
|
5821
6023
|
success: boolean;
|
|
@@ -6201,7 +6403,7 @@ export interface components {
|
|
|
6201
6403
|
summary: string;
|
|
6202
6404
|
explanation: string | null;
|
|
6203
6405
|
sentiment: ("angry" | "happy" | "neutral") | null;
|
|
6204
|
-
reasons: ("based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
6406
|
+
reasons: ("ai_implied_handoff" | "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
6205
6407
|
references: components["schemas"]["InvestigationReferenceItem"][];
|
|
6206
6408
|
referenced_documents: components["schemas"]["InvestigationReferenceBuckets"];
|
|
6207
6409
|
} | null;
|
|
@@ -6408,6 +6610,11 @@ export interface components {
|
|
|
6408
6610
|
max_capacity_in_group: number | null;
|
|
6409
6611
|
is_available_globally: boolean;
|
|
6410
6612
|
is_available_in_group: boolean;
|
|
6613
|
+
/** @default [] */
|
|
6614
|
+
missing_required_skills: {
|
|
6615
|
+
id: string;
|
|
6616
|
+
name: string;
|
|
6617
|
+
}[];
|
|
6411
6618
|
} | null;
|
|
6412
6619
|
peers: {
|
|
6413
6620
|
agent_id: number;
|
|
@@ -6420,6 +6627,16 @@ export interface components {
|
|
|
6420
6627
|
max_capacity_in_group: number | null;
|
|
6421
6628
|
is_available_globally: boolean;
|
|
6422
6629
|
is_available_in_group: boolean;
|
|
6630
|
+
/** @default [] */
|
|
6631
|
+
missing_required_skills: {
|
|
6632
|
+
id: string;
|
|
6633
|
+
name: string;
|
|
6634
|
+
}[];
|
|
6635
|
+
}[];
|
|
6636
|
+
/** @default [] */
|
|
6637
|
+
required_skills: {
|
|
6638
|
+
id: string;
|
|
6639
|
+
name: string;
|
|
6423
6640
|
}[];
|
|
6424
6641
|
} | null;
|
|
6425
6642
|
destination_id?: string;
|
|
@@ -6588,6 +6805,12 @@ export interface components {
|
|
|
6588
6805
|
/** @constant */
|
|
6589
6806
|
type: "sub_status_removed_by_api";
|
|
6590
6807
|
sub_status_id: string | null;
|
|
6808
|
+
} | {
|
|
6809
|
+
/** @enum {string} */
|
|
6810
|
+
type: "tag_added_by_system" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_removed_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration";
|
|
6811
|
+
tags: {
|
|
6812
|
+
name: string;
|
|
6813
|
+
}[];
|
|
6591
6814
|
} | {
|
|
6592
6815
|
/** @constant */
|
|
6593
6816
|
type: "ai_resolved_issue";
|
|
@@ -6624,6 +6847,9 @@ export interface components {
|
|
|
6624
6847
|
type: "system_reopened_session";
|
|
6625
6848
|
workflow_id: string | null;
|
|
6626
6849
|
workflow_run_id: string | null;
|
|
6850
|
+
} | {
|
|
6851
|
+
/** @constant */
|
|
6852
|
+
type: "integration_reopened_session";
|
|
6627
6853
|
} | {
|
|
6628
6854
|
/** @constant */
|
|
6629
6855
|
type: "ai_reopened_session";
|
|
@@ -6652,6 +6878,10 @@ export interface components {
|
|
|
6652
6878
|
/** @constant */
|
|
6653
6879
|
type: "agent_assigned_by_system";
|
|
6654
6880
|
assigned_agent_id?: number;
|
|
6881
|
+
} | {
|
|
6882
|
+
/** @constant */
|
|
6883
|
+
type: "agent_assigned_by_integration";
|
|
6884
|
+
assigned_agent_id?: number;
|
|
6655
6885
|
} | {
|
|
6656
6886
|
/** @constant */
|
|
6657
6887
|
type: "agent_assigned_by_user";
|
|
@@ -6661,6 +6891,10 @@ export interface components {
|
|
|
6661
6891
|
/** @constant */
|
|
6662
6892
|
type: "agent_unassigned_by_system";
|
|
6663
6893
|
unassigned_agent_id?: number;
|
|
6894
|
+
} | {
|
|
6895
|
+
/** @constant */
|
|
6896
|
+
type: "agent_unassigned_by_integration";
|
|
6897
|
+
unassigned_agent_id?: number;
|
|
6664
6898
|
} | {
|
|
6665
6899
|
/** @constant */
|
|
6666
6900
|
type: "agent_unassigned_by_user";
|
|
@@ -6865,7 +7099,7 @@ export interface components {
|
|
|
6865
7099
|
/** @enum {string} */
|
|
6866
7100
|
source_type: "custom_training" | "help_center" | "integration" | "website";
|
|
6867
7101
|
/** @description External source the item was synced from (present when listing). */
|
|
6868
|
-
data_source?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "ai_instructions" | "custom_training" | "website") | null;
|
|
7102
|
+
data_source?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website") | null;
|
|
6869
7103
|
stream?: string | null;
|
|
6870
7104
|
source_url: string | null;
|
|
6871
7105
|
/** @description Contact segment ids this item is restricted to. Empty = available to all contacts. */
|
|
@@ -6923,12 +7157,12 @@ export interface components {
|
|
|
6923
7157
|
end_date: string;
|
|
6924
7158
|
reasons: {
|
|
6925
7159
|
/** @enum {string} */
|
|
6926
|
-
reason: "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance";
|
|
7160
|
+
reason: "ai_implied_handoff" | "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance";
|
|
6927
7161
|
count: number;
|
|
6928
7162
|
percentage: number;
|
|
6929
7163
|
}[];
|
|
6930
7164
|
reason_combinations: {
|
|
6931
|
-
reasons: ("based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
7165
|
+
reasons: ("ai_implied_handoff" | "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
6932
7166
|
session_count: number;
|
|
6933
7167
|
percentage: number;
|
|
6934
7168
|
}[];
|
|
@@ -7013,6 +7247,38 @@ export interface components {
|
|
|
7013
7247
|
/** @description When the organization was last updated. */
|
|
7014
7248
|
updated_at: string | null;
|
|
7015
7249
|
};
|
|
7250
|
+
PublicResourceUsageConversationsDto: {
|
|
7251
|
+
conversations: {
|
|
7252
|
+
session_id: string;
|
|
7253
|
+
/** @description Inbox ticket number, if assigned */
|
|
7254
|
+
ticket_number: number | null;
|
|
7255
|
+
/** @description The conversation’s most recent message */
|
|
7256
|
+
last_message: string | null;
|
|
7257
|
+
/** @description AI replies in this conversation that used the resource */
|
|
7258
|
+
reply_count: number;
|
|
7259
|
+
/** @description ISO 8601 timestamp of first use in this conversation */
|
|
7260
|
+
first_used_at: string;
|
|
7261
|
+
/** @description ISO 8601 timestamp of most recent use */
|
|
7262
|
+
last_used_at: string;
|
|
7263
|
+
}[];
|
|
7264
|
+
/** @description Distinct conversations matching the lookup */
|
|
7265
|
+
total_sessions: number;
|
|
7266
|
+
};
|
|
7267
|
+
PublicResourceUsageSummaryDto: {
|
|
7268
|
+
/** @description Distinct conversations that used this resource */
|
|
7269
|
+
session_count: number;
|
|
7270
|
+
/** @description Distinct conversations where the resource was applied */
|
|
7271
|
+
applied_sessions: number;
|
|
7272
|
+
/** @description Total applications/invocations */
|
|
7273
|
+
applied_replies: number;
|
|
7274
|
+
/** @description Distinct conversations where an instruction was in context (instructions only) */
|
|
7275
|
+
available_sessions: number;
|
|
7276
|
+
available_replies: number;
|
|
7277
|
+
/** @description ISO 8601 timestamp of first use */
|
|
7278
|
+
first_used_at: string | null;
|
|
7279
|
+
/** @description ISO 8601 timestamp of most recent use */
|
|
7280
|
+
last_used_at: string | null;
|
|
7281
|
+
};
|
|
7016
7282
|
AddContactsToSequenceOutput: {
|
|
7017
7283
|
run_id: string;
|
|
7018
7284
|
};
|
|
@@ -7365,7 +7631,7 @@ export interface components {
|
|
|
7365
7631
|
*/
|
|
7366
7632
|
type: "Unary" | "Binary" | "Logical";
|
|
7367
7633
|
/** @description Field types this operator can be applied to */
|
|
7368
|
-
applies_to: ("String" | "Number" | "Boolean" | "Array" | "Object" | "DateTime" | "LongText" | "Url" | "Email" | "Select" | "LazySelect" | "Code" | "MultiSelect" | "JsonSchema" | "Any" | "AnyObject" | "RichText" | "File" | "PhoneNumber" | "DateOnly" | "CronExpression" | "Integer")[];
|
|
7634
|
+
applies_to: ("String" | "Number" | "Boolean" | "Array" | "Object" | "DateTime" | "LongText" | "Url" | "Email" | "Select" | "LazySelect" | "Code" | "MultiSelect" | "LazyMultiSelect" | "JsonSchema" | "Any" | "AnyObject" | "RichText" | "File" | "PhoneNumber" | "DateOnly" | "CronExpression" | "Integer")[];
|
|
7369
7635
|
};
|
|
7370
7636
|
WorkflowDefinitionsPublicDto: {
|
|
7371
7637
|
/** @description Available action types with their input/output schemas */
|
|
@@ -7380,7 +7646,7 @@ export interface components {
|
|
|
7380
7646
|
}[];
|
|
7381
7647
|
/** @description Condition operators for if-else blocks, from the engine registry. This is the complete set the runtime evaluates — always pick "operatorName" from this list. */
|
|
7382
7648
|
operators: components["schemas"]["OperatorPublicDto"][];
|
|
7383
|
-
/** @description Field schemas for the extra reference scopes available in every run, beyond the trigger payload and step outputs. Each entry's "name" is the scope root and its "properties" are the referenceable fields: {{metadata.<field>}} (date/time of the run), {{run.<field>}}, {{workflow.<field>}}, {{organization.<field>}}, and {{variables.<key>}} for the organization's global variables. */
|
|
7649
|
+
/** @description Field schemas for the extra reference scopes available in every run, beyond the trigger payload and step outputs. Each entry's "name" is the scope root and its "properties" are the referenceable fields: {{metadata.<field>}} (date/time of the run), {{run.<field>}}, {{workflow.<field>}}, {{organization.<field>}}, and {{variables.<key>}} for the organization's global variables. Leaf scopes have no "properties" and are referenced directly, e.g. {{routingSkills}} — a JSON string of every org skill (name + description). */
|
|
7384
7650
|
extra_variables: unknown[];
|
|
7385
7651
|
};
|
|
7386
7652
|
TestWorkflowPublicOutput: {
|
|
@@ -7479,7 +7745,7 @@ export interface components {
|
|
|
7479
7745
|
summary: string;
|
|
7480
7746
|
explanation: string | null;
|
|
7481
7747
|
sentiment: string | null;
|
|
7482
|
-
reasons: ("based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
7748
|
+
reasons: ("ai_implied_handoff" | "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
7483
7749
|
references: {
|
|
7484
7750
|
/** @enum {string} */
|
|
7485
7751
|
reference_type: "ai_profile" | "instruction" | "knowledge" | "prohibited_topic" | "tool";
|
|
@@ -7569,12 +7835,13 @@ export interface components {
|
|
|
7569
7835
|
records: unknown | null;
|
|
7570
7836
|
}[];
|
|
7571
7837
|
ListEmailTemplatesOutput: components["schemas"]["EmailTemplateDto"][];
|
|
7838
|
+
ListMacrosOutput: components["schemas"]["SavedReplyDto"][];
|
|
7572
7839
|
ListHandoffEventsOutput: {
|
|
7573
7840
|
items: {
|
|
7574
7841
|
session_id: string;
|
|
7575
7842
|
summary: string;
|
|
7576
7843
|
explanation: string | null;
|
|
7577
|
-
reasons: ("based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
7844
|
+
reasons: ("ai_implied_handoff" | "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance")[];
|
|
7578
7845
|
sentiment: ("angry" | "happy" | "neutral") | null;
|
|
7579
7846
|
created_at: string;
|
|
7580
7847
|
}[];
|
|
@@ -7651,7 +7918,7 @@ export interface components {
|
|
|
7651
7918
|
updated_at: string;
|
|
7652
7919
|
content?: string;
|
|
7653
7920
|
/** @enum {string} */
|
|
7654
|
-
data_source: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "ai_instructions" | "custom_training" | "website";
|
|
7921
|
+
data_source: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website";
|
|
7655
7922
|
stream: string | null;
|
|
7656
7923
|
relevance_score: number;
|
|
7657
7924
|
directory_id: string | null;
|
|
@@ -9437,7 +9704,7 @@ export interface operations {
|
|
|
9437
9704
|
/** @description Full-text search over item titles/content */
|
|
9438
9705
|
search?: string;
|
|
9439
9706
|
/** @description Filter to a specific external data source (e.g. website, confluence, notion) */
|
|
9440
|
-
data_source?: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "ai_instructions" | "custom_training" | "website";
|
|
9707
|
+
data_source?: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website";
|
|
9441
9708
|
visibility?: "internal" | "public";
|
|
9442
9709
|
page?: number;
|
|
9443
9710
|
limit?: number;
|
|
@@ -10329,13 +10596,173 @@ export interface operations {
|
|
|
10329
10596
|
};
|
|
10330
10597
|
};
|
|
10331
10598
|
};
|
|
10599
|
+
listMacros: {
|
|
10600
|
+
parameters: {
|
|
10601
|
+
query?: never;
|
|
10602
|
+
header?: never;
|
|
10603
|
+
path?: never;
|
|
10604
|
+
cookie?: never;
|
|
10605
|
+
};
|
|
10606
|
+
requestBody?: never;
|
|
10607
|
+
responses: {
|
|
10608
|
+
/** @description Default Response */
|
|
10609
|
+
200: {
|
|
10610
|
+
headers: {
|
|
10611
|
+
[name: string]: unknown;
|
|
10612
|
+
};
|
|
10613
|
+
content: {
|
|
10614
|
+
"application/json": components["schemas"]["ListMacrosOutput"];
|
|
10615
|
+
};
|
|
10616
|
+
};
|
|
10617
|
+
/** @description Internal Server Error */
|
|
10618
|
+
500: {
|
|
10619
|
+
headers: {
|
|
10620
|
+
[name: string]: unknown;
|
|
10621
|
+
};
|
|
10622
|
+
content: {
|
|
10623
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10624
|
+
};
|
|
10625
|
+
};
|
|
10626
|
+
};
|
|
10627
|
+
};
|
|
10628
|
+
createMacro: {
|
|
10629
|
+
parameters: {
|
|
10630
|
+
query?: never;
|
|
10631
|
+
header?: never;
|
|
10632
|
+
path?: never;
|
|
10633
|
+
cookie?: never;
|
|
10634
|
+
};
|
|
10635
|
+
requestBody: {
|
|
10636
|
+
content: {
|
|
10637
|
+
"application/json": components["schemas"]["CreateMacroInput"];
|
|
10638
|
+
};
|
|
10639
|
+
};
|
|
10640
|
+
responses: {
|
|
10641
|
+
/** @description Default Response */
|
|
10642
|
+
201: {
|
|
10643
|
+
headers: {
|
|
10644
|
+
[name: string]: unknown;
|
|
10645
|
+
};
|
|
10646
|
+
content: {
|
|
10647
|
+
"application/json": components["schemas"]["SavedReplyDto"];
|
|
10648
|
+
};
|
|
10649
|
+
};
|
|
10650
|
+
/** @description Internal Server Error */
|
|
10651
|
+
500: {
|
|
10652
|
+
headers: {
|
|
10653
|
+
[name: string]: unknown;
|
|
10654
|
+
};
|
|
10655
|
+
content: {
|
|
10656
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10657
|
+
};
|
|
10658
|
+
};
|
|
10659
|
+
};
|
|
10660
|
+
};
|
|
10661
|
+
getMacro: {
|
|
10662
|
+
parameters: {
|
|
10663
|
+
query?: never;
|
|
10664
|
+
header?: never;
|
|
10665
|
+
path: {
|
|
10666
|
+
/** @description Macro ID */
|
|
10667
|
+
id: string;
|
|
10668
|
+
};
|
|
10669
|
+
cookie?: never;
|
|
10670
|
+
};
|
|
10671
|
+
requestBody?: never;
|
|
10672
|
+
responses: {
|
|
10673
|
+
/** @description Default Response */
|
|
10674
|
+
200: {
|
|
10675
|
+
headers: {
|
|
10676
|
+
[name: string]: unknown;
|
|
10677
|
+
};
|
|
10678
|
+
content: {
|
|
10679
|
+
"application/json": components["schemas"]["SavedReplyDto"];
|
|
10680
|
+
};
|
|
10681
|
+
};
|
|
10682
|
+
/** @description Internal Server Error */
|
|
10683
|
+
500: {
|
|
10684
|
+
headers: {
|
|
10685
|
+
[name: string]: unknown;
|
|
10686
|
+
};
|
|
10687
|
+
content: {
|
|
10688
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10689
|
+
};
|
|
10690
|
+
};
|
|
10691
|
+
};
|
|
10692
|
+
};
|
|
10693
|
+
deleteMacro: {
|
|
10694
|
+
parameters: {
|
|
10695
|
+
query?: never;
|
|
10696
|
+
header?: never;
|
|
10697
|
+
path: {
|
|
10698
|
+
/** @description Macro ID */
|
|
10699
|
+
id: string;
|
|
10700
|
+
};
|
|
10701
|
+
cookie?: never;
|
|
10702
|
+
};
|
|
10703
|
+
requestBody?: never;
|
|
10704
|
+
responses: {
|
|
10705
|
+
/** @description Default Response */
|
|
10706
|
+
204: {
|
|
10707
|
+
headers: {
|
|
10708
|
+
[name: string]: unknown;
|
|
10709
|
+
};
|
|
10710
|
+
content?: never;
|
|
10711
|
+
};
|
|
10712
|
+
/** @description Internal Server Error */
|
|
10713
|
+
500: {
|
|
10714
|
+
headers: {
|
|
10715
|
+
[name: string]: unknown;
|
|
10716
|
+
};
|
|
10717
|
+
content: {
|
|
10718
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10719
|
+
};
|
|
10720
|
+
};
|
|
10721
|
+
};
|
|
10722
|
+
};
|
|
10723
|
+
updateMacro: {
|
|
10724
|
+
parameters: {
|
|
10725
|
+
query?: never;
|
|
10726
|
+
header?: never;
|
|
10727
|
+
path: {
|
|
10728
|
+
/** @description Macro ID */
|
|
10729
|
+
id: string;
|
|
10730
|
+
};
|
|
10731
|
+
cookie?: never;
|
|
10732
|
+
};
|
|
10733
|
+
requestBody: {
|
|
10734
|
+
content: {
|
|
10735
|
+
"application/json": components["schemas"]["UpdateMacroInput"];
|
|
10736
|
+
};
|
|
10737
|
+
};
|
|
10738
|
+
responses: {
|
|
10739
|
+
/** @description Default Response */
|
|
10740
|
+
200: {
|
|
10741
|
+
headers: {
|
|
10742
|
+
[name: string]: unknown;
|
|
10743
|
+
};
|
|
10744
|
+
content: {
|
|
10745
|
+
"application/json": components["schemas"]["SavedReplyDto"];
|
|
10746
|
+
};
|
|
10747
|
+
};
|
|
10748
|
+
/** @description Internal Server Error */
|
|
10749
|
+
500: {
|
|
10750
|
+
headers: {
|
|
10751
|
+
[name: string]: unknown;
|
|
10752
|
+
};
|
|
10753
|
+
content: {
|
|
10754
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10755
|
+
};
|
|
10756
|
+
};
|
|
10757
|
+
};
|
|
10758
|
+
};
|
|
10332
10759
|
listHandoffEvents: {
|
|
10333
10760
|
parameters: {
|
|
10334
10761
|
query?: {
|
|
10335
10762
|
/** @description Pagination cursor from a previous response */
|
|
10336
10763
|
cursor?: string;
|
|
10337
10764
|
/** @description Only return handoffs that include this reason */
|
|
10338
|
-
reason?: "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance";
|
|
10765
|
+
reason?: "ai_implied_handoff" | "based_on_instructions" | "instructions_not_clear" | "insufficient_knowledge" | "insufficient_tools" | "prohibited_topic" | "user_requested_human_assistance";
|
|
10339
10766
|
/** @description Start date in ISO 8601 format (defaults to 30 days ago) */
|
|
10340
10767
|
start_date?: string;
|
|
10341
10768
|
/** @description End date in ISO 8601 format (defaults to now) */
|
|
@@ -10437,6 +10864,44 @@ export interface operations {
|
|
|
10437
10864
|
};
|
|
10438
10865
|
};
|
|
10439
10866
|
};
|
|
10867
|
+
getConversationSankey: {
|
|
10868
|
+
parameters: {
|
|
10869
|
+
query: {
|
|
10870
|
+
/** @description Comma-separated dimension keys, e.g. "replied_by,outcome". 1–6 allowed. */
|
|
10871
|
+
dimensions: string;
|
|
10872
|
+
/** @description Contact custom_data key to read when the contact_custom_data dimension is used. */
|
|
10873
|
+
custom_data_key?: string;
|
|
10874
|
+
/** @description Start date in ISO 8601 format (defaults to 30 days ago) */
|
|
10875
|
+
start_date?: string;
|
|
10876
|
+
/** @description End date in ISO 8601 format (defaults to now) */
|
|
10877
|
+
end_date?: string;
|
|
10878
|
+
};
|
|
10879
|
+
header?: never;
|
|
10880
|
+
path?: never;
|
|
10881
|
+
cookie?: never;
|
|
10882
|
+
};
|
|
10883
|
+
requestBody?: never;
|
|
10884
|
+
responses: {
|
|
10885
|
+
/** @description Default Response */
|
|
10886
|
+
200: {
|
|
10887
|
+
headers: {
|
|
10888
|
+
[name: string]: unknown;
|
|
10889
|
+
};
|
|
10890
|
+
content: {
|
|
10891
|
+
"application/json": components["schemas"]["SankeyReportResDto"];
|
|
10892
|
+
};
|
|
10893
|
+
};
|
|
10894
|
+
/** @description Internal Server Error */
|
|
10895
|
+
500: {
|
|
10896
|
+
headers: {
|
|
10897
|
+
[name: string]: unknown;
|
|
10898
|
+
};
|
|
10899
|
+
content: {
|
|
10900
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10901
|
+
};
|
|
10902
|
+
};
|
|
10903
|
+
};
|
|
10904
|
+
};
|
|
10440
10905
|
listOfficeHours: {
|
|
10441
10906
|
parameters: {
|
|
10442
10907
|
query?: never;
|
|
@@ -12012,6 +12477,79 @@ export interface operations {
|
|
|
12012
12477
|
};
|
|
12013
12478
|
};
|
|
12014
12479
|
};
|
|
12480
|
+
listResourceConversations: {
|
|
12481
|
+
parameters: {
|
|
12482
|
+
query?: {
|
|
12483
|
+
usageKind?: "applied" | "available";
|
|
12484
|
+
from?: unknown;
|
|
12485
|
+
to?: unknown;
|
|
12486
|
+
limit?: number;
|
|
12487
|
+
offset?: number;
|
|
12488
|
+
};
|
|
12489
|
+
header?: never;
|
|
12490
|
+
path: {
|
|
12491
|
+
resource_type: "action" | "instruction" | "knowledge";
|
|
12492
|
+
resource_id: string;
|
|
12493
|
+
};
|
|
12494
|
+
cookie?: never;
|
|
12495
|
+
};
|
|
12496
|
+
requestBody?: never;
|
|
12497
|
+
responses: {
|
|
12498
|
+
/** @description Default Response */
|
|
12499
|
+
200: {
|
|
12500
|
+
headers: {
|
|
12501
|
+
[name: string]: unknown;
|
|
12502
|
+
};
|
|
12503
|
+
content: {
|
|
12504
|
+
"application/json": components["schemas"]["PublicResourceUsageConversationsDto"];
|
|
12505
|
+
};
|
|
12506
|
+
};
|
|
12507
|
+
/** @description Internal Server Error */
|
|
12508
|
+
500: {
|
|
12509
|
+
headers: {
|
|
12510
|
+
[name: string]: unknown;
|
|
12511
|
+
};
|
|
12512
|
+
content: {
|
|
12513
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
12514
|
+
};
|
|
12515
|
+
};
|
|
12516
|
+
};
|
|
12517
|
+
};
|
|
12518
|
+
getResourceUsageSummary: {
|
|
12519
|
+
parameters: {
|
|
12520
|
+
query?: {
|
|
12521
|
+
from?: unknown;
|
|
12522
|
+
to?: unknown;
|
|
12523
|
+
};
|
|
12524
|
+
header?: never;
|
|
12525
|
+
path: {
|
|
12526
|
+
resource_type: "action" | "instruction" | "knowledge";
|
|
12527
|
+
resource_id: string;
|
|
12528
|
+
};
|
|
12529
|
+
cookie?: never;
|
|
12530
|
+
};
|
|
12531
|
+
requestBody?: never;
|
|
12532
|
+
responses: {
|
|
12533
|
+
/** @description Default Response */
|
|
12534
|
+
200: {
|
|
12535
|
+
headers: {
|
|
12536
|
+
[name: string]: unknown;
|
|
12537
|
+
};
|
|
12538
|
+
content: {
|
|
12539
|
+
"application/json": components["schemas"]["PublicResourceUsageSummaryDto"];
|
|
12540
|
+
};
|
|
12541
|
+
};
|
|
12542
|
+
/** @description Internal Server Error */
|
|
12543
|
+
500: {
|
|
12544
|
+
headers: {
|
|
12545
|
+
[name: string]: unknown;
|
|
12546
|
+
};
|
|
12547
|
+
content: {
|
|
12548
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
12549
|
+
};
|
|
12550
|
+
};
|
|
12551
|
+
};
|
|
12552
|
+
};
|
|
12015
12553
|
createSequence: {
|
|
12016
12554
|
parameters: {
|
|
12017
12555
|
query?: never;
|