@opencx/mcp 1.15.12 → 1.15.14
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/add-session-comment.spec.d.ts +2 -0
- package/dist/add-session-comment.spec.d.ts.map +1 -0
- package/dist/add-session-comment.spec.js +108 -0
- package/dist/add-session-comment.spec.js.map +1 -0
- package/dist/phone-tools.spec.d.ts +2 -0
- package/dist/phone-tools.spec.d.ts.map +1 -0
- package/dist/phone-tools.spec.js +156 -0
- package/dist/phone-tools.spec.js.map +1 -0
- package/dist/schema.d.ts +406 -96
- package/dist/schema.d.ts.map +1 -1
- package/dist/tools/phone.d.ts.map +1 -1
- package/dist/tools/phone.js +65 -25
- package/dist/tools/phone.js.map +1 -1
- package/dist/tools/sessions.d.ts.map +1 -1
- package/dist/tools/sessions.js +7 -3
- package/dist/tools/sessions.js.map +1 -1
- package/dist/tools/training.d.ts.map +1 -1
- package/dist/tools/training.js +26 -9
- package/dist/tools/training.js.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -502,7 +502,7 @@ export interface paths {
|
|
|
502
502
|
put?: never;
|
|
503
503
|
/**
|
|
504
504
|
* Create a session comment
|
|
505
|
-
* @description Creates an internal
|
|
505
|
+
* @description Creates an internal note on the chat session, visible to agents only. Pass thread_id to attach it to a message; omit it for a session-level note.
|
|
506
506
|
*/
|
|
507
507
|
post: operations["createChatSessionComment"];
|
|
508
508
|
delete?: never;
|
|
@@ -511,6 +511,30 @@ export interface paths {
|
|
|
511
511
|
patch?: never;
|
|
512
512
|
trace?: never;
|
|
513
513
|
};
|
|
514
|
+
"/chat/sessions/{session_id}/comments/{comment_uuid}": {
|
|
515
|
+
parameters: {
|
|
516
|
+
query?: never;
|
|
517
|
+
header?: never;
|
|
518
|
+
path?: never;
|
|
519
|
+
cookie?: never;
|
|
520
|
+
};
|
|
521
|
+
get?: never;
|
|
522
|
+
put?: never;
|
|
523
|
+
post?: never;
|
|
524
|
+
/**
|
|
525
|
+
* Delete a session comment
|
|
526
|
+
* @description Soft-deletes an internal comment. Only the comment's author may delete it. The acting agent is passed as the `agent_id` query parameter.
|
|
527
|
+
*/
|
|
528
|
+
delete: operations["deleteChatSessionComment"];
|
|
529
|
+
options?: never;
|
|
530
|
+
head?: never;
|
|
531
|
+
/**
|
|
532
|
+
* Update a session comment
|
|
533
|
+
* @description Replaces the content of an internal comment. Only the comment's author may edit it, and a deleted comment can no longer be edited.
|
|
534
|
+
*/
|
|
535
|
+
patch: operations["updateChatSessionComment"];
|
|
536
|
+
trace?: never;
|
|
537
|
+
};
|
|
514
538
|
"/chat/sessions/{session_id}/history": {
|
|
515
539
|
parameters: {
|
|
516
540
|
query?: never;
|
|
@@ -603,7 +627,7 @@ export interface paths {
|
|
|
603
627
|
put?: never;
|
|
604
628
|
/**
|
|
605
629
|
* Link many contacts to companies
|
|
606
|
-
* @description Links up to 100 contacts in one call. Failures are isolated: a contact that cannot be linked returns an error in its own result entry and does not affect the others, so the call succeeds even when some links do not. Results come back in request order.
|
|
630
|
+
* @description Links up to 100 contacts in one call. Name each contact by `contact_id`, `contact_email`, or `contact_phone` — exactly one — so a sync can link straight from the identifiers it already holds. Each result carries the resolved `contact_id`. Failures are isolated: a contact that cannot be linked returns an error in its own result entry and does not affect the others, so the call succeeds even when some links do not. Results come back in request order.
|
|
607
631
|
*/
|
|
608
632
|
post: operations["bulkLinkContactsToCompanies"];
|
|
609
633
|
delete?: never;
|
|
@@ -2410,7 +2434,7 @@ export interface paths {
|
|
|
2410
2434
|
};
|
|
2411
2435
|
/**
|
|
2412
2436
|
* List available voices
|
|
2413
|
-
* @description List
|
|
2437
|
+
* @description List the curated voices available for AI phone agents. Supports filtering by language, gender, accent, use_case, and free-text search. Use limit/offset for pagination. Use the voice_id when creating or updating a phone agent.
|
|
2414
2438
|
*/
|
|
2415
2439
|
get: operations["listVoices"];
|
|
2416
2440
|
put?: never;
|
|
@@ -2445,6 +2469,26 @@ export interface paths {
|
|
|
2445
2469
|
patch?: never;
|
|
2446
2470
|
trace?: never;
|
|
2447
2471
|
};
|
|
2472
|
+
"/phone/transfer-destinations": {
|
|
2473
|
+
parameters: {
|
|
2474
|
+
query?: never;
|
|
2475
|
+
header?: never;
|
|
2476
|
+
path?: never;
|
|
2477
|
+
cookie?: never;
|
|
2478
|
+
};
|
|
2479
|
+
/**
|
|
2480
|
+
* List transfer destinations
|
|
2481
|
+
* @description List the transfer destinations configured for your organization (phone numbers, SIP endpoints, teams, or hang-up handbacks). Reference their IDs in transfer_destination_ids when creating or updating a phone agent; the agent can then transfer calls to them by name. Destinations are created and edited in the dashboard (Settings → SIP).
|
|
2482
|
+
*/
|
|
2483
|
+
get: operations["listPhoneTransferDestinations"];
|
|
2484
|
+
put?: never;
|
|
2485
|
+
post?: never;
|
|
2486
|
+
delete?: never;
|
|
2487
|
+
options?: never;
|
|
2488
|
+
head?: never;
|
|
2489
|
+
patch?: never;
|
|
2490
|
+
trace?: never;
|
|
2491
|
+
};
|
|
2448
2492
|
"/phone/{phone_agent_id}/knowledge-sources": {
|
|
2449
2493
|
parameters: {
|
|
2450
2494
|
query?: never;
|
|
@@ -2954,7 +2998,7 @@ export interface paths {
|
|
|
2954
2998
|
put?: never;
|
|
2955
2999
|
/**
|
|
2956
3000
|
* Create a training directory
|
|
2957
|
-
* @description Create a new directory for organizing trainings.
|
|
3001
|
+
* @description Create a new directory for organizing trainings. Pass parent_id to create it as a sub-directory.
|
|
2958
3002
|
*/
|
|
2959
3003
|
post: operations["createTrainingDirectory"];
|
|
2960
3004
|
delete?: never;
|
|
@@ -2973,7 +3017,7 @@ export interface paths {
|
|
|
2973
3017
|
get?: never;
|
|
2974
3018
|
/**
|
|
2975
3019
|
* Update a training directory
|
|
2976
|
-
* @description Rename a training directory.
|
|
3020
|
+
* @description Rename and/or move a training directory. parent_id null moves it to the top level. Moving a directory under itself or one of its own sub-directories is rejected.
|
|
2977
3021
|
*/
|
|
2978
3022
|
put: operations["updateTrainingDirectory"];
|
|
2979
3023
|
post?: never;
|
|
@@ -3273,6 +3317,30 @@ export interface paths {
|
|
|
3273
3317
|
get: operations["getOrgUser"];
|
|
3274
3318
|
put?: never;
|
|
3275
3319
|
post?: never;
|
|
3320
|
+
/**
|
|
3321
|
+
* Remove a user from the organization
|
|
3322
|
+
* @description Remove a user's organization membership. Also removes their team memberships and availability in this organization and signs them out everywhere. Their account and historical activity are preserved, and memberships in other organizations are unaffected. The organization owner cannot be removed.
|
|
3323
|
+
*/
|
|
3324
|
+
delete: operations["deleteOrgUser"];
|
|
3325
|
+
options?: never;
|
|
3326
|
+
head?: never;
|
|
3327
|
+
patch?: never;
|
|
3328
|
+
trace?: never;
|
|
3329
|
+
};
|
|
3330
|
+
"/users/batch-delete": {
|
|
3331
|
+
parameters: {
|
|
3332
|
+
query?: never;
|
|
3333
|
+
header?: never;
|
|
3334
|
+
path?: never;
|
|
3335
|
+
cookie?: never;
|
|
3336
|
+
};
|
|
3337
|
+
get?: never;
|
|
3338
|
+
put?: never;
|
|
3339
|
+
/**
|
|
3340
|
+
* Remove multiple users from the organization
|
|
3341
|
+
* @description Remove up to 25 users from the organization in one call. Users are processed independently — one failure never aborts the rest — and the response reports a status per user. Same semantics as removing a single user.
|
|
3342
|
+
*/
|
|
3343
|
+
post: operations["batchDeleteOrgUsers"];
|
|
3276
3344
|
delete?: never;
|
|
3277
3345
|
options?: never;
|
|
3278
3346
|
head?: never;
|
|
@@ -5150,6 +5218,34 @@ export interface components {
|
|
|
5150
5218
|
}[];
|
|
5151
5219
|
})[];
|
|
5152
5220
|
};
|
|
5221
|
+
UpsertCompanyDto: {
|
|
5222
|
+
external_id: string;
|
|
5223
|
+
name?: string;
|
|
5224
|
+
custom_data?: {
|
|
5225
|
+
[key: string]: string | number | boolean | null;
|
|
5226
|
+
};
|
|
5227
|
+
};
|
|
5228
|
+
BulkLinkContactsDto: {
|
|
5229
|
+
links: {
|
|
5230
|
+
/**
|
|
5231
|
+
* Format: uuid
|
|
5232
|
+
* @description The OpenCX contact id, if you already hold it
|
|
5233
|
+
*/
|
|
5234
|
+
contact_id?: string;
|
|
5235
|
+
/**
|
|
5236
|
+
* Format: email
|
|
5237
|
+
* @description Look the contact up by email instead of id
|
|
5238
|
+
*/
|
|
5239
|
+
contact_email?: string;
|
|
5240
|
+
/** @description Look the contact up by phone instead of id. `+15551234567` and `15551234567` both match */
|
|
5241
|
+
contact_phone?: string;
|
|
5242
|
+
/** @description The company to link, by the same `external_id` you upserted it with */
|
|
5243
|
+
external_id: string;
|
|
5244
|
+
}[];
|
|
5245
|
+
};
|
|
5246
|
+
LinkContactCompanyDto: {
|
|
5247
|
+
external_id: string;
|
|
5248
|
+
};
|
|
5153
5249
|
MakeOutboundCallDto: {
|
|
5154
5250
|
phoneAgentId: string;
|
|
5155
5251
|
contact: {
|
|
@@ -5782,15 +5878,22 @@ export interface components {
|
|
|
5782
5878
|
CreateSessionCommentInput: {
|
|
5783
5879
|
/**
|
|
5784
5880
|
* Format: uuid
|
|
5785
|
-
* @description Message UUID to comment
|
|
5881
|
+
* @description Message UUID to attach the comment to. Omit to create a session-level note (not attached to any message).
|
|
5786
5882
|
*/
|
|
5787
|
-
thread_id
|
|
5883
|
+
thread_id?: string;
|
|
5788
5884
|
/** @description Comment text content */
|
|
5789
5885
|
content: string;
|
|
5790
5886
|
/** @description Agent user ID that authors the comment */
|
|
5791
5887
|
agent_id: number;
|
|
5792
5888
|
attachments?: components["schemas"]["ChatAttachmentInput"][];
|
|
5793
5889
|
};
|
|
5890
|
+
UpdateSessionCommentInput: {
|
|
5891
|
+
/** @description Replacement comment text content */
|
|
5892
|
+
content: string;
|
|
5893
|
+
/** @description Agent user ID performing the edit. Only the note's author may edit it. */
|
|
5894
|
+
agent_id: number;
|
|
5895
|
+
attachments?: components["schemas"]["ChatAttachmentInput"][];
|
|
5896
|
+
};
|
|
5794
5897
|
FilterSessionsPublicDto: {
|
|
5795
5898
|
/** @default {} */
|
|
5796
5899
|
filters: {
|
|
@@ -5858,23 +5961,6 @@ export interface components {
|
|
|
5858
5961
|
*/
|
|
5859
5962
|
limit: number;
|
|
5860
5963
|
};
|
|
5861
|
-
UpsertCompanyDto: {
|
|
5862
|
-
external_id: string;
|
|
5863
|
-
name?: string;
|
|
5864
|
-
custom_data?: {
|
|
5865
|
-
[key: string]: string | number | boolean | null;
|
|
5866
|
-
};
|
|
5867
|
-
};
|
|
5868
|
-
BulkLinkContactsDto: {
|
|
5869
|
-
links: {
|
|
5870
|
-
/** Format: uuid */
|
|
5871
|
-
contact_id: string;
|
|
5872
|
-
external_id: string;
|
|
5873
|
-
}[];
|
|
5874
|
-
};
|
|
5875
|
-
LinkContactCompanyDto: {
|
|
5876
|
-
external_id: string;
|
|
5877
|
-
};
|
|
5878
5964
|
UpdatePublicKnowledgebaseItem: {
|
|
5879
5965
|
/** @description Contact segment ids this item should be restricted to. Pass [] to make it available to all contacts. */
|
|
5880
5966
|
restricted_to_segments?: string[];
|
|
@@ -5965,18 +6051,24 @@ export interface components {
|
|
|
5965
6051
|
type?: "inbound" | "outbound";
|
|
5966
6052
|
/** @description Voice ID from the /phone/voices endpoint. Omit for default voice. */
|
|
5967
6053
|
voice_id?: string | null;
|
|
5968
|
-
/** @description ISO-639-1 language codes the agent should speak. A subset of {en, es, fr, de, hi, ru, pt, ja, it, nl} can be combined freely. Any other code (e.g. "ar", "tr", "zh") must be the only entry. */
|
|
6054
|
+
/** @description ISO-639-1 language codes the agent should speak. A subset of {en, es, fr, de, hi, ru, pt, ja, it, nl} can be combined freely. Any other code (e.g. "ar", "tr", "zh") must be the only entry; Arabic accepts dialect tags such as "ar-SA". */
|
|
5969
6055
|
language?: string[];
|
|
5970
6056
|
/** @description What the agent says when it picks up (default: "Hello?") */
|
|
5971
6057
|
first_message?: string | null;
|
|
5972
|
-
/** @description
|
|
6058
|
+
/** @description The call prompt as an array of instruction blocks. Joined in order into the system prompt at call time. Sending this on update replaces the whole array. */
|
|
5973
6059
|
instructions?: string[] | null;
|
|
5974
|
-
/** @description
|
|
5975
|
-
handoff_phone_number?: string | null;
|
|
5976
|
-
/** @description Whether the agent can search your knowledge base during calls (default: false) */
|
|
5977
|
-
use_org_knowledgebase?: boolean | null;
|
|
5978
|
-
/** @description Action IDs the agent can call during conversations */
|
|
6060
|
+
/** @description HTTP actions the agent can call as tools during calls (action IDs from GET /actions). The full set is replaced on every write; send [] to detach all, omit or send null to leave it unchanged. IDs must belong to your organization. */
|
|
5979
6061
|
actionIds?: string[] | null;
|
|
6062
|
+
/** @description Transfer destinations the agent may transfer calls to (IDs from GET /phone/transfer-destinations). The full set is replaced on every write; send [] to detach all. Destinations themselves are managed in the dashboard. */
|
|
6063
|
+
transfer_destination_ids?: string[];
|
|
6064
|
+
/** @description Destination the call is transferred to if the voice pipeline fails mid-call. Any destination of your organization; null falls back to the first allowed destination, then to a graceful hangup. */
|
|
6065
|
+
failover_transfer_destination_id?: string | null;
|
|
6066
|
+
/** @description Speaking speed on a 1-100 scale (null = the voice default). Lower is slower; natural-sounding voices in some languages (e.g. Dutch) run best around 80-85. */
|
|
6067
|
+
tts_speed_pct?: number | null;
|
|
6068
|
+
/** @description Custom vocabulary to boost in speech recognition: brand and product names, jargon, spellings the transcriber typically mishears. The agent name and transfer destination names are merged in automatically. */
|
|
6069
|
+
stt_keyterms?: string[] | null;
|
|
6070
|
+
/** @description Record calls handled by this agent (default: false). */
|
|
6071
|
+
recording_enabled?: boolean;
|
|
5980
6072
|
};
|
|
5981
6073
|
UpdatePhoneAgentPublicDto: {
|
|
5982
6074
|
/** @description Agent display name */
|
|
@@ -5988,18 +6080,24 @@ export interface components {
|
|
|
5988
6080
|
type?: "inbound" | "outbound";
|
|
5989
6081
|
/** @description Voice ID from the /phone/voices endpoint. Omit for default voice. */
|
|
5990
6082
|
voice_id?: string | null;
|
|
5991
|
-
/** @description ISO-639-1 language codes the agent should speak. A subset of {en, es, fr, de, hi, ru, pt, ja, it, nl} can be combined freely. Any other code (e.g. "ar", "tr", "zh") must be the only entry. */
|
|
6083
|
+
/** @description ISO-639-1 language codes the agent should speak. A subset of {en, es, fr, de, hi, ru, pt, ja, it, nl} can be combined freely. Any other code (e.g. "ar", "tr", "zh") must be the only entry; Arabic accepts dialect tags such as "ar-SA". */
|
|
5992
6084
|
language?: string[];
|
|
5993
6085
|
/** @description What the agent says when it picks up (default: "Hello?") */
|
|
5994
6086
|
first_message?: string | null;
|
|
5995
|
-
/** @description
|
|
6087
|
+
/** @description The call prompt as an array of instruction blocks. Joined in order into the system prompt at call time. Sending this on update replaces the whole array. */
|
|
5996
6088
|
instructions?: string[] | null;
|
|
5997
|
-
/** @description
|
|
5998
|
-
handoff_phone_number?: string | null;
|
|
5999
|
-
/** @description Whether the agent can search your knowledge base during calls (default: false) */
|
|
6000
|
-
use_org_knowledgebase?: boolean | null;
|
|
6001
|
-
/** @description Action IDs the agent can call during conversations */
|
|
6089
|
+
/** @description HTTP actions the agent can call as tools during calls (action IDs from GET /actions). The full set is replaced on every write; send [] to detach all, omit or send null to leave it unchanged. IDs must belong to your organization. */
|
|
6002
6090
|
actionIds?: string[] | null;
|
|
6091
|
+
/** @description Transfer destinations the agent may transfer calls to (IDs from GET /phone/transfer-destinations). The full set is replaced on every write; send [] to detach all. Destinations themselves are managed in the dashboard. */
|
|
6092
|
+
transfer_destination_ids?: string[];
|
|
6093
|
+
/** @description Destination the call is transferred to if the voice pipeline fails mid-call. Any destination of your organization; null falls back to the first allowed destination, then to a graceful hangup. */
|
|
6094
|
+
failover_transfer_destination_id?: string | null;
|
|
6095
|
+
/** @description Speaking speed on a 1-100 scale (null = the voice default). Lower is slower; natural-sounding voices in some languages (e.g. Dutch) run best around 80-85. */
|
|
6096
|
+
tts_speed_pct?: number | null;
|
|
6097
|
+
/** @description Custom vocabulary to boost in speech recognition: brand and product names, jargon, spellings the transcriber typically mishears. The agent name and transfer destination names are merged in automatically. */
|
|
6098
|
+
stt_keyterms?: string[] | null;
|
|
6099
|
+
/** @description Record calls handled by this agent (default: false). */
|
|
6100
|
+
recording_enabled?: boolean;
|
|
6003
6101
|
};
|
|
6004
6102
|
WriteSecretInputDto: {
|
|
6005
6103
|
/** @description The reference key actions and workflows use as {{secrets.<name>}}. Unique per organization, and immutable — writing the same name replaces its value rather than renaming anything. */
|
|
@@ -6108,6 +6206,10 @@ export interface components {
|
|
|
6108
6206
|
/** @description Pre-rendered TipTap diff HTML */
|
|
6109
6207
|
diff_html: string;
|
|
6110
6208
|
};
|
|
6209
|
+
BatchDeleteOrgUsersDto: {
|
|
6210
|
+
/** @description Organization user IDs to remove (duplicates are collapsed) */
|
|
6211
|
+
user_ids: number[];
|
|
6212
|
+
};
|
|
6111
6213
|
PublicApproveSuggestionDto: {
|
|
6112
6214
|
/**
|
|
6113
6215
|
* Format: uuid
|
|
@@ -6440,10 +6542,14 @@ export interface components {
|
|
|
6440
6542
|
CreateTrainingDirectoryInputDto: {
|
|
6441
6543
|
/** @description The directory name */
|
|
6442
6544
|
name: string;
|
|
6545
|
+
/** @description Parent directory id. Omit or null for a top-level directory. */
|
|
6546
|
+
parent_id?: string | null;
|
|
6443
6547
|
};
|
|
6444
6548
|
UpdateTrainingDirectoryInputDto: {
|
|
6445
6549
|
/** @description The new directory name */
|
|
6446
|
-
name
|
|
6550
|
+
name?: string;
|
|
6551
|
+
/** @description New parent directory id, or null for top level. Omit to keep the current parent. */
|
|
6552
|
+
parent_id?: string | null;
|
|
6447
6553
|
};
|
|
6448
6554
|
UpdateAiProfileInput: {
|
|
6449
6555
|
name?: string;
|
|
@@ -6636,6 +6742,7 @@ export interface components {
|
|
|
6636
6742
|
})[];
|
|
6637
6743
|
})[] | null;
|
|
6638
6744
|
rejected_reason?: string | null;
|
|
6745
|
+
message_send_ttl_seconds?: number | null;
|
|
6639
6746
|
};
|
|
6640
6747
|
PhoneCallEventDto: {
|
|
6641
6748
|
/** Format: uuid */
|
|
@@ -6743,7 +6850,7 @@ export interface components {
|
|
|
6743
6850
|
/** @constant */
|
|
6744
6851
|
type: "response_skipped";
|
|
6745
6852
|
/** @enum {string} */
|
|
6746
|
-
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "superseded_by_newer_run" | "flagged_as_spam";
|
|
6853
|
+
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "assist_human_handling_recommended" | "superseded_by_newer_run" | "flagged_as_spam";
|
|
6747
6854
|
reasoning?: ({
|
|
6748
6855
|
/** @constant */
|
|
6749
6856
|
type: "reasoning";
|
|
@@ -7237,6 +7344,8 @@ export interface components {
|
|
|
7237
7344
|
id: string;
|
|
7238
7345
|
name: string;
|
|
7239
7346
|
org_id: string;
|
|
7347
|
+
/** @description Parent folder id; null for a top-level folder. */
|
|
7348
|
+
parent_id: string | null;
|
|
7240
7349
|
};
|
|
7241
7350
|
SankeyReportResDto: {
|
|
7242
7351
|
nodes: {
|
|
@@ -7279,6 +7388,81 @@ export interface components {
|
|
|
7279
7388
|
customDataKeys?: string[];
|
|
7280
7389
|
}[];
|
|
7281
7390
|
};
|
|
7391
|
+
Company: {
|
|
7392
|
+
/** Format: uuid */
|
|
7393
|
+
id: string;
|
|
7394
|
+
/** @description The organization's own key for this company */
|
|
7395
|
+
external_id: string;
|
|
7396
|
+
name: string;
|
|
7397
|
+
custom_data: {
|
|
7398
|
+
[key: string]: string | number | boolean;
|
|
7399
|
+
} | null;
|
|
7400
|
+
/** @description ISO 8601 timestamp of when the company was created */
|
|
7401
|
+
created_at: string;
|
|
7402
|
+
/** @description ISO 8601 timestamp of when the company was last updated */
|
|
7403
|
+
updated_at: string;
|
|
7404
|
+
};
|
|
7405
|
+
ListCompaniesOutput: {
|
|
7406
|
+
data: components["schemas"]["Company"][];
|
|
7407
|
+
total: number;
|
|
7408
|
+
page: number;
|
|
7409
|
+
limit: number;
|
|
7410
|
+
};
|
|
7411
|
+
GetContactCompaniesOutput: {
|
|
7412
|
+
/** @description Empty when the contact belongs to no company */
|
|
7413
|
+
companies: components["schemas"]["Company"][];
|
|
7414
|
+
};
|
|
7415
|
+
LinkContactCompanyOutput: {
|
|
7416
|
+
/**
|
|
7417
|
+
* @description `unchanged` means the contact was already in this company.
|
|
7418
|
+
* @enum {string}
|
|
7419
|
+
*/
|
|
7420
|
+
outcome: "linked" | "unchanged";
|
|
7421
|
+
company: components["schemas"]["Company"];
|
|
7422
|
+
};
|
|
7423
|
+
BulkLinkContactsOutput: {
|
|
7424
|
+
/** @description One entry per requested link, in request order */
|
|
7425
|
+
results: {
|
|
7426
|
+
/** @description The resolved contact id. Null when the identifier did not resolve. */
|
|
7427
|
+
contact_id: string | null;
|
|
7428
|
+
external_id: string;
|
|
7429
|
+
outcome: ("linked" | "unchanged") | null;
|
|
7430
|
+
/** @description Null when this contact linked successfully */
|
|
7431
|
+
error: string | null;
|
|
7432
|
+
company: components["schemas"]["Company"] | null;
|
|
7433
|
+
}[];
|
|
7434
|
+
summary: {
|
|
7435
|
+
total: number;
|
|
7436
|
+
linked: number;
|
|
7437
|
+
unchanged: number;
|
|
7438
|
+
failed: number;
|
|
7439
|
+
};
|
|
7440
|
+
};
|
|
7441
|
+
UnlinkContactCompanyOutput: {
|
|
7442
|
+
/**
|
|
7443
|
+
* @description `unchanged` means the contact was not in that company.
|
|
7444
|
+
* @enum {string}
|
|
7445
|
+
*/
|
|
7446
|
+
outcome: "unlinked" | "unchanged";
|
|
7447
|
+
};
|
|
7448
|
+
TransferDestinationDto: {
|
|
7449
|
+
/** Format: uuid */
|
|
7450
|
+
id: string;
|
|
7451
|
+
name: string;
|
|
7452
|
+
/** @enum {string} */
|
|
7453
|
+
type: "hangup" | "phone" | "sip" | "team";
|
|
7454
|
+
value: string | null;
|
|
7455
|
+
sipUsername: string | null;
|
|
7456
|
+
hasSipPassword: boolean;
|
|
7457
|
+
sipHost: string | null;
|
|
7458
|
+
sipPort: number | null;
|
|
7459
|
+
sipExtension: string | null;
|
|
7460
|
+
sipTransport: ("udp" | "tcp" | "tls") | null;
|
|
7461
|
+
sipCallerId: string | null;
|
|
7462
|
+
routingGroupId: string | null;
|
|
7463
|
+
createdAt: string;
|
|
7464
|
+
updatedAt: string;
|
|
7465
|
+
};
|
|
7282
7466
|
PhoneAgentDto: {
|
|
7283
7467
|
id: string;
|
|
7284
7468
|
org_id: string;
|
|
@@ -7313,6 +7497,8 @@ export interface components {
|
|
|
7313
7497
|
stt_model: ("deepgram/flux-general" | "deepgram/nova-3" | "deepgram/nova-3-medical" | "cartesia/ink-whisper" | "elevenlabs/scribe_v2_realtime" | "xai/stt-1" | "assemblyai/universal-3-5-pro" | "speechmatics/enhanced" | "soniox/stt-rt-v5") | null;
|
|
7314
7498
|
tts_speed_pct: number | null;
|
|
7315
7499
|
failover_transfer_destination_id: string | null;
|
|
7500
|
+
/** @description Transfer destinations the agent may transfer to (`transfer_call` targets). */
|
|
7501
|
+
transfer_destination_ids: string[];
|
|
7316
7502
|
};
|
|
7317
7503
|
PhoneAgentVoiceDto: {
|
|
7318
7504
|
voice_id: string;
|
|
@@ -7354,6 +7540,8 @@ export interface components {
|
|
|
7354
7540
|
KnowledgeSourceDirectoryDto: {
|
|
7355
7541
|
id: string;
|
|
7356
7542
|
name: string;
|
|
7543
|
+
/** @description Parent directory id; null for a top-level directory */
|
|
7544
|
+
parent_id: string | null;
|
|
7357
7545
|
items: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
7358
7546
|
/** @description Whether the entire directory is selected (all current and future instructions included) */
|
|
7359
7547
|
selected: boolean;
|
|
@@ -9230,62 +9418,6 @@ export interface components {
|
|
|
9230
9418
|
};
|
|
9231
9419
|
};
|
|
9232
9420
|
};
|
|
9233
|
-
Company: {
|
|
9234
|
-
/** Format: uuid */
|
|
9235
|
-
id: string;
|
|
9236
|
-
/** @description The organization's own key for this company */
|
|
9237
|
-
external_id: string;
|
|
9238
|
-
name: string;
|
|
9239
|
-
custom_data: {
|
|
9240
|
-
[key: string]: string | number | boolean;
|
|
9241
|
-
} | null;
|
|
9242
|
-
/** @description ISO 8601 timestamp of when the company was created */
|
|
9243
|
-
created_at: string;
|
|
9244
|
-
/** @description ISO 8601 timestamp of when the company was last updated */
|
|
9245
|
-
updated_at: string;
|
|
9246
|
-
};
|
|
9247
|
-
ListCompaniesOutput: {
|
|
9248
|
-
data: components["schemas"]["Company"][];
|
|
9249
|
-
total: number;
|
|
9250
|
-
page: number;
|
|
9251
|
-
limit: number;
|
|
9252
|
-
};
|
|
9253
|
-
GetContactCompaniesOutput: {
|
|
9254
|
-
/** @description Empty when the contact belongs to no company */
|
|
9255
|
-
companies: components["schemas"]["Company"][];
|
|
9256
|
-
};
|
|
9257
|
-
LinkContactCompanyOutput: {
|
|
9258
|
-
/**
|
|
9259
|
-
* @description `unchanged` means the contact was already in this company.
|
|
9260
|
-
* @enum {string}
|
|
9261
|
-
*/
|
|
9262
|
-
outcome: "linked" | "unchanged";
|
|
9263
|
-
company: components["schemas"]["Company"];
|
|
9264
|
-
};
|
|
9265
|
-
BulkLinkContactsOutput: {
|
|
9266
|
-
/** @description One entry per requested link, in request order */
|
|
9267
|
-
results: {
|
|
9268
|
-
contact_id: string;
|
|
9269
|
-
external_id: string;
|
|
9270
|
-
outcome: ("linked" | "unchanged") | null;
|
|
9271
|
-
/** @description Null when this contact linked successfully */
|
|
9272
|
-
error: string | null;
|
|
9273
|
-
company: components["schemas"]["Company"] | null;
|
|
9274
|
-
}[];
|
|
9275
|
-
summary: {
|
|
9276
|
-
total: number;
|
|
9277
|
-
linked: number;
|
|
9278
|
-
unchanged: number;
|
|
9279
|
-
failed: number;
|
|
9280
|
-
};
|
|
9281
|
-
};
|
|
9282
|
-
UnlinkContactCompanyOutput: {
|
|
9283
|
-
/**
|
|
9284
|
-
* @description `unchanged` means the contact was not in that company.
|
|
9285
|
-
* @enum {string}
|
|
9286
|
-
*/
|
|
9287
|
-
outcome: "unlinked" | "unchanged";
|
|
9288
|
-
};
|
|
9289
9421
|
ContactSegment: {
|
|
9290
9422
|
id: string;
|
|
9291
9423
|
name: string;
|
|
@@ -9848,6 +9980,8 @@ export interface components {
|
|
|
9848
9980
|
id: string;
|
|
9849
9981
|
name: string;
|
|
9850
9982
|
org_id: string;
|
|
9983
|
+
/** @description Parent folder id; null for a top-level folder. */
|
|
9984
|
+
parent_id: string | null;
|
|
9851
9985
|
items: components["schemas"]["TrainingPublicResponseDto"][];
|
|
9852
9986
|
};
|
|
9853
9987
|
TrainingDirectoryTreePublicDto: {
|
|
@@ -9876,6 +10010,16 @@ export interface components {
|
|
|
9876
10010
|
is_user_available_on_group: boolean;
|
|
9877
10011
|
}[];
|
|
9878
10012
|
};
|
|
10013
|
+
BatchDeleteOrgUsersResultDto: {
|
|
10014
|
+
results: {
|
|
10015
|
+
user_id: number;
|
|
10016
|
+
/**
|
|
10017
|
+
* @description deleted: membership removed; not_found: not a member of this organization; owner_blocked: the organization owner cannot be removed; error: removal failed, retry later
|
|
10018
|
+
* @enum {string}
|
|
10019
|
+
*/
|
|
10020
|
+
status: "deleted" | "not_found" | "owner_blocked" | "error";
|
|
10021
|
+
}[];
|
|
10022
|
+
};
|
|
9879
10023
|
PublicInsight: {
|
|
9880
10024
|
/** Format: uuid */
|
|
9881
10025
|
id: string;
|
|
@@ -10456,6 +10600,7 @@ export interface components {
|
|
|
10456
10600
|
GetWorkflowRunLogsOutput: components["schemas"]["WorkflowRunLogEntryDto"][];
|
|
10457
10601
|
ListVoicesOutput: components["schemas"]["PhoneAgentVoiceDto"][];
|
|
10458
10602
|
ListPhoneAgentsOutput: components["schemas"]["PhoneAgentDto"][];
|
|
10603
|
+
ListTransferDestinationsOutput: components["schemas"]["TransferDestinationDto"][];
|
|
10459
10604
|
GetSequenceOutput: components["schemas"]["SequenceDto"];
|
|
10460
10605
|
ListTrainingsOutput: {
|
|
10461
10606
|
items: components["schemas"]["TrainingPublicResponseDto"][];
|
|
@@ -11582,6 +11727,79 @@ export interface operations {
|
|
|
11582
11727
|
};
|
|
11583
11728
|
};
|
|
11584
11729
|
};
|
|
11730
|
+
deleteChatSessionComment: {
|
|
11731
|
+
parameters: {
|
|
11732
|
+
query: {
|
|
11733
|
+
/** @description Agent user ID performing the deletion. Only the note's author may delete it. */
|
|
11734
|
+
agent_id: number;
|
|
11735
|
+
};
|
|
11736
|
+
header?: never;
|
|
11737
|
+
path: {
|
|
11738
|
+
/** @description The unique identifier of the chat session */
|
|
11739
|
+
session_id: string;
|
|
11740
|
+
/** @description The unique identifier of the comment */
|
|
11741
|
+
comment_uuid: string;
|
|
11742
|
+
};
|
|
11743
|
+
cookie?: never;
|
|
11744
|
+
};
|
|
11745
|
+
requestBody?: never;
|
|
11746
|
+
responses: {
|
|
11747
|
+
/** @description Default Response */
|
|
11748
|
+
204: {
|
|
11749
|
+
headers: {
|
|
11750
|
+
[name: string]: unknown;
|
|
11751
|
+
};
|
|
11752
|
+
content?: never;
|
|
11753
|
+
};
|
|
11754
|
+
/** @description Internal Server Error */
|
|
11755
|
+
500: {
|
|
11756
|
+
headers: {
|
|
11757
|
+
[name: string]: unknown;
|
|
11758
|
+
};
|
|
11759
|
+
content: {
|
|
11760
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
11761
|
+
};
|
|
11762
|
+
};
|
|
11763
|
+
};
|
|
11764
|
+
};
|
|
11765
|
+
updateChatSessionComment: {
|
|
11766
|
+
parameters: {
|
|
11767
|
+
query?: never;
|
|
11768
|
+
header?: never;
|
|
11769
|
+
path: {
|
|
11770
|
+
/** @description The unique identifier of the chat session */
|
|
11771
|
+
session_id: string;
|
|
11772
|
+
/** @description The unique identifier of the comment */
|
|
11773
|
+
comment_uuid: string;
|
|
11774
|
+
};
|
|
11775
|
+
cookie?: never;
|
|
11776
|
+
};
|
|
11777
|
+
requestBody: {
|
|
11778
|
+
content: {
|
|
11779
|
+
"application/json": components["schemas"]["UpdateSessionCommentInput"];
|
|
11780
|
+
};
|
|
11781
|
+
};
|
|
11782
|
+
responses: {
|
|
11783
|
+
/** @description Default Response */
|
|
11784
|
+
200: {
|
|
11785
|
+
headers: {
|
|
11786
|
+
[name: string]: unknown;
|
|
11787
|
+
};
|
|
11788
|
+
content: {
|
|
11789
|
+
"application/json": components["schemas"]["ChatHistoryDto"];
|
|
11790
|
+
};
|
|
11791
|
+
};
|
|
11792
|
+
/** @description Internal Server Error */
|
|
11793
|
+
500: {
|
|
11794
|
+
headers: {
|
|
11795
|
+
[name: string]: unknown;
|
|
11796
|
+
};
|
|
11797
|
+
content: {
|
|
11798
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
11799
|
+
};
|
|
11800
|
+
};
|
|
11801
|
+
};
|
|
11802
|
+
};
|
|
11585
11803
|
listChatHistory: {
|
|
11586
11804
|
parameters: {
|
|
11587
11805
|
query?: {
|
|
@@ -15667,6 +15885,35 @@ export interface operations {
|
|
|
15667
15885
|
};
|
|
15668
15886
|
};
|
|
15669
15887
|
};
|
|
15888
|
+
listPhoneTransferDestinations: {
|
|
15889
|
+
parameters: {
|
|
15890
|
+
query?: never;
|
|
15891
|
+
header?: never;
|
|
15892
|
+
path?: never;
|
|
15893
|
+
cookie?: never;
|
|
15894
|
+
};
|
|
15895
|
+
requestBody?: never;
|
|
15896
|
+
responses: {
|
|
15897
|
+
/** @description Default Response */
|
|
15898
|
+
200: {
|
|
15899
|
+
headers: {
|
|
15900
|
+
[name: string]: unknown;
|
|
15901
|
+
};
|
|
15902
|
+
content: {
|
|
15903
|
+
"application/json": components["schemas"]["ListTransferDestinationsOutput"];
|
|
15904
|
+
};
|
|
15905
|
+
};
|
|
15906
|
+
/** @description Internal Server Error */
|
|
15907
|
+
500: {
|
|
15908
|
+
headers: {
|
|
15909
|
+
[name: string]: unknown;
|
|
15910
|
+
};
|
|
15911
|
+
content: {
|
|
15912
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
15913
|
+
};
|
|
15914
|
+
};
|
|
15915
|
+
};
|
|
15916
|
+
};
|
|
15670
15917
|
getPhoneAgentKnowledgeSources: {
|
|
15671
15918
|
parameters: {
|
|
15672
15919
|
query?: never;
|
|
@@ -17552,6 +17799,69 @@ export interface operations {
|
|
|
17552
17799
|
};
|
|
17553
17800
|
};
|
|
17554
17801
|
};
|
|
17802
|
+
deleteOrgUser: {
|
|
17803
|
+
parameters: {
|
|
17804
|
+
query?: never;
|
|
17805
|
+
header?: never;
|
|
17806
|
+
path: {
|
|
17807
|
+
/** @description Organization user ID */
|
|
17808
|
+
user_id: number;
|
|
17809
|
+
};
|
|
17810
|
+
cookie?: never;
|
|
17811
|
+
};
|
|
17812
|
+
requestBody?: never;
|
|
17813
|
+
responses: {
|
|
17814
|
+
/** @description Default Response */
|
|
17815
|
+
204: {
|
|
17816
|
+
headers: {
|
|
17817
|
+
[name: string]: unknown;
|
|
17818
|
+
};
|
|
17819
|
+
content?: never;
|
|
17820
|
+
};
|
|
17821
|
+
/** @description Internal Server Error */
|
|
17822
|
+
500: {
|
|
17823
|
+
headers: {
|
|
17824
|
+
[name: string]: unknown;
|
|
17825
|
+
};
|
|
17826
|
+
content: {
|
|
17827
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17828
|
+
};
|
|
17829
|
+
};
|
|
17830
|
+
};
|
|
17831
|
+
};
|
|
17832
|
+
batchDeleteOrgUsers: {
|
|
17833
|
+
parameters: {
|
|
17834
|
+
query?: never;
|
|
17835
|
+
header?: never;
|
|
17836
|
+
path?: never;
|
|
17837
|
+
cookie?: never;
|
|
17838
|
+
};
|
|
17839
|
+
requestBody: {
|
|
17840
|
+
content: {
|
|
17841
|
+
"application/json": components["schemas"]["BatchDeleteOrgUsersDto"];
|
|
17842
|
+
};
|
|
17843
|
+
};
|
|
17844
|
+
responses: {
|
|
17845
|
+
/** @description Default Response */
|
|
17846
|
+
201: {
|
|
17847
|
+
headers: {
|
|
17848
|
+
[name: string]: unknown;
|
|
17849
|
+
};
|
|
17850
|
+
content: {
|
|
17851
|
+
"application/json": components["schemas"]["BatchDeleteOrgUsersResultDto"];
|
|
17852
|
+
};
|
|
17853
|
+
};
|
|
17854
|
+
/** @description Internal Server Error */
|
|
17855
|
+
500: {
|
|
17856
|
+
headers: {
|
|
17857
|
+
[name: string]: unknown;
|
|
17858
|
+
};
|
|
17859
|
+
content: {
|
|
17860
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17861
|
+
};
|
|
17862
|
+
};
|
|
17863
|
+
};
|
|
17864
|
+
};
|
|
17555
17865
|
inviteUser: {
|
|
17556
17866
|
parameters: {
|
|
17557
17867
|
query?: never;
|