@opencx/mcp 1.15.26 → 1.15.27
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/campaign-tools.spec.js +107 -0
- package/dist/campaign-tools.spec.js.map +1 -1
- package/dist/schema.d.ts +616 -3
- 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/skills.spec.d.ts +2 -0
- package/dist/skills.spec.d.ts.map +1 -0
- package/dist/skills.spec.js +175 -0
- package/dist/skills.spec.js.map +1 -0
- package/dist/tools/campaign-personalization.d.ts +4 -0
- package/dist/tools/campaign-personalization.d.ts.map +1 -0
- package/dist/tools/campaign-personalization.js +149 -0
- package/dist/tools/campaign-personalization.js.map +1 -0
- package/dist/tools/skills.d.ts +4 -0
- package/dist/tools/skills.d.ts.map +1 -0
- package/dist/tools/skills.js +80 -0
- package/dist/tools/skills.js.map +1 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1929,6 +1929,82 @@ export interface paths {
|
|
|
1929
1929
|
patch: operations["updateMacro"];
|
|
1930
1930
|
trace?: never;
|
|
1931
1931
|
};
|
|
1932
|
+
"/skills": {
|
|
1933
|
+
parameters: {
|
|
1934
|
+
query?: never;
|
|
1935
|
+
header?: never;
|
|
1936
|
+
path?: never;
|
|
1937
|
+
cookie?: never;
|
|
1938
|
+
};
|
|
1939
|
+
/**
|
|
1940
|
+
* List skills
|
|
1941
|
+
* @description List every routing skill defined for the organization, newest first. Skills power skills-based routing: a session carries required skills (set by the "Assign Skills to Ticket" workflow action) and, when a team-assign action runs with skill-based routing enabled, only agents holding every required skill are eligible. Session skills are not writable through the API.
|
|
1942
|
+
*/
|
|
1943
|
+
get: operations["listSkills"];
|
|
1944
|
+
put?: never;
|
|
1945
|
+
/**
|
|
1946
|
+
* Create a skill
|
|
1947
|
+
* @description Create a routing skill. Names are unique per organization, case-insensitively (400 on conflict). The description is what workflow steps see in the `{{routingSkills}}` variable when an AI step decides which skills a session needs, so write it as the condition under which the skill applies.
|
|
1948
|
+
*/
|
|
1949
|
+
post: operations["createSkill"];
|
|
1950
|
+
delete?: never;
|
|
1951
|
+
options?: never;
|
|
1952
|
+
head?: never;
|
|
1953
|
+
patch?: never;
|
|
1954
|
+
trace?: never;
|
|
1955
|
+
};
|
|
1956
|
+
"/skills/{skill_id}": {
|
|
1957
|
+
parameters: {
|
|
1958
|
+
query?: never;
|
|
1959
|
+
header?: never;
|
|
1960
|
+
path?: never;
|
|
1961
|
+
cookie?: never;
|
|
1962
|
+
};
|
|
1963
|
+
/**
|
|
1964
|
+
* Get a skill
|
|
1965
|
+
* @description Get a single routing skill by ID.
|
|
1966
|
+
*/
|
|
1967
|
+
get: operations["getSkill"];
|
|
1968
|
+
put?: never;
|
|
1969
|
+
post?: never;
|
|
1970
|
+
/**
|
|
1971
|
+
* Delete a skill
|
|
1972
|
+
* @description Delete a routing skill. Agents and sessions that referenced it simply stop requiring / holding it — references are dropped at read time.
|
|
1973
|
+
*/
|
|
1974
|
+
delete: operations["deleteSkill"];
|
|
1975
|
+
options?: never;
|
|
1976
|
+
head?: never;
|
|
1977
|
+
/**
|
|
1978
|
+
* Update a skill
|
|
1979
|
+
* @description Rename a routing skill and/or change its description. Renaming is safe: agents and sessions reference skills by ID. 400 if the new name already exists (case-insensitive).
|
|
1980
|
+
*/
|
|
1981
|
+
patch: operations["updateSkill"];
|
|
1982
|
+
trace?: never;
|
|
1983
|
+
};
|
|
1984
|
+
"/skills/users/{user_id}": {
|
|
1985
|
+
parameters: {
|
|
1986
|
+
query?: never;
|
|
1987
|
+
header?: never;
|
|
1988
|
+
path?: never;
|
|
1989
|
+
cookie?: never;
|
|
1990
|
+
};
|
|
1991
|
+
/**
|
|
1992
|
+
* Get an agent's skills
|
|
1993
|
+
* @description List the routing skills an organization member holds. Skills deleted after assignment are omitted. 404 if the user is not a member of the organization.
|
|
1994
|
+
*/
|
|
1995
|
+
get: operations["getUserSkills"];
|
|
1996
|
+
/**
|
|
1997
|
+
* Replace an agent's skills
|
|
1998
|
+
* @description Replace the full set of routing skills an organization member holds (skills not in `skill_ids` are removed). 400 if any ID is not a skill of this organization; 404 if the user is not a member. Returns the resolved skills now assigned.
|
|
1999
|
+
*/
|
|
2000
|
+
put: operations["setUserSkills"];
|
|
2001
|
+
post?: never;
|
|
2002
|
+
delete?: never;
|
|
2003
|
+
options?: never;
|
|
2004
|
+
head?: never;
|
|
2005
|
+
patch?: never;
|
|
2006
|
+
trace?: never;
|
|
2007
|
+
};
|
|
1932
2008
|
"/handoff-analytics/events": {
|
|
1933
2009
|
parameters: {
|
|
1934
2010
|
query?: never;
|
|
@@ -3347,6 +3423,50 @@ export interface paths {
|
|
|
3347
3423
|
patch?: never;
|
|
3348
3424
|
trace?: never;
|
|
3349
3425
|
};
|
|
3426
|
+
"/sequences/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/preview": {
|
|
3427
|
+
parameters: {
|
|
3428
|
+
query?: never;
|
|
3429
|
+
header?: never;
|
|
3430
|
+
path?: never;
|
|
3431
|
+
cookie?: never;
|
|
3432
|
+
};
|
|
3433
|
+
/**
|
|
3434
|
+
* What one person will get at one step, rendered
|
|
3435
|
+
* @description Rendered by the same code the send path runs: the step's template filled in for this person, their personalization if they have one, or — once the step went out — the send record of what they actually received. A blocked render names the reason the person would park (missing data, an unsendable value, an unreadable template).
|
|
3436
|
+
*/
|
|
3437
|
+
get: operations["previewSequenceStepForContact"];
|
|
3438
|
+
put?: never;
|
|
3439
|
+
post?: never;
|
|
3440
|
+
delete?: never;
|
|
3441
|
+
options?: never;
|
|
3442
|
+
head?: never;
|
|
3443
|
+
patch?: never;
|
|
3444
|
+
trace?: never;
|
|
3445
|
+
};
|
|
3446
|
+
"/sequences/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/personalization": {
|
|
3447
|
+
parameters: {
|
|
3448
|
+
query?: never;
|
|
3449
|
+
header?: never;
|
|
3450
|
+
path?: never;
|
|
3451
|
+
cookie?: never;
|
|
3452
|
+
};
|
|
3453
|
+
get?: never;
|
|
3454
|
+
/**
|
|
3455
|
+
* Hand-write one step for one person
|
|
3456
|
+
* @description Stores a rendered snapshot the sequence sends to this person INSTEAD of the step: email as subject + html (text derived when omitted), a voice call brief, or literal slot values on the step's own WhatsApp template. Only for steps the person has not reached. A person parked on this step for missing data is released — the snapshot has no holes. Editing the step later never touches it; clear it to go back to the template.
|
|
3457
|
+
*/
|
|
3458
|
+
put: operations["setSequenceStepPersonalization"];
|
|
3459
|
+
post?: never;
|
|
3460
|
+
/**
|
|
3461
|
+
* Remove a person's hand-written step — back to the template
|
|
3462
|
+
* @description Idempotent: nothing to clear returns cleared=false, never an error.
|
|
3463
|
+
*/
|
|
3464
|
+
delete: operations["clearSequenceStepPersonalization"];
|
|
3465
|
+
options?: never;
|
|
3466
|
+
head?: never;
|
|
3467
|
+
patch?: never;
|
|
3468
|
+
trace?: never;
|
|
3469
|
+
};
|
|
3350
3470
|
"/sequences/{sequenceId}/contacts/{contactId}/include": {
|
|
3351
3471
|
parameters: {
|
|
3352
3472
|
query?: never;
|
|
@@ -6187,6 +6307,28 @@ export interface components {
|
|
|
6187
6307
|
/** @description Only needed when the org has more than one WABA; otherwise resolved. */
|
|
6188
6308
|
waba_id?: string;
|
|
6189
6309
|
};
|
|
6310
|
+
SetSequenceStepPersonalizationDto: {
|
|
6311
|
+
content: {
|
|
6312
|
+
/** @constant */
|
|
6313
|
+
type: "email";
|
|
6314
|
+
subject: string;
|
|
6315
|
+
html: string;
|
|
6316
|
+
/** @description Plain-text alternative. Derived from html when omitted. */
|
|
6317
|
+
text?: string;
|
|
6318
|
+
} | {
|
|
6319
|
+
/** @constant */
|
|
6320
|
+
type: "voice_call";
|
|
6321
|
+
extra_instructions: string | null;
|
|
6322
|
+
} | {
|
|
6323
|
+
/** @constant */
|
|
6324
|
+
type: "whatsapp_template";
|
|
6325
|
+
template_name: string;
|
|
6326
|
+
template_language: string;
|
|
6327
|
+
values: {
|
|
6328
|
+
[key: string]: string;
|
|
6329
|
+
};
|
|
6330
|
+
};
|
|
6331
|
+
};
|
|
6190
6332
|
ExitSequenceContactDto: {
|
|
6191
6333
|
/** Format: uuid */
|
|
6192
6334
|
contact_id?: string;
|
|
@@ -6465,7 +6607,7 @@ export interface components {
|
|
|
6465
6607
|
type: "email";
|
|
6466
6608
|
subject: string;
|
|
6467
6609
|
html: string;
|
|
6468
|
-
text
|
|
6610
|
+
text?: string;
|
|
6469
6611
|
/** @default {} */
|
|
6470
6612
|
variables: {
|
|
6471
6613
|
[key: string]: {
|
|
@@ -6582,6 +6724,17 @@ export interface components {
|
|
|
6582
6724
|
tlds?: ("com" | "org")[];
|
|
6583
6725
|
limit?: number;
|
|
6584
6726
|
};
|
|
6727
|
+
CreateSkillDto: {
|
|
6728
|
+
name: string;
|
|
6729
|
+
description?: string | null;
|
|
6730
|
+
};
|
|
6731
|
+
UpdateSkillDto: {
|
|
6732
|
+
name?: string;
|
|
6733
|
+
description?: string | null;
|
|
6734
|
+
};
|
|
6735
|
+
UpdateUserSkillsDto: {
|
|
6736
|
+
skill_ids: string[];
|
|
6737
|
+
};
|
|
6585
6738
|
EditArticleDto: {
|
|
6586
6739
|
title: string;
|
|
6587
6740
|
content_markdown?: string;
|
|
@@ -9106,6 +9259,7 @@ export interface components {
|
|
|
9106
9259
|
};
|
|
9107
9260
|
description: string | null;
|
|
9108
9261
|
preview_url: string | null;
|
|
9262
|
+
default_speed_pct: number | null;
|
|
9109
9263
|
};
|
|
9110
9264
|
KnowledgeSourceTreeItemDto: {
|
|
9111
9265
|
id: string;
|
|
@@ -9446,6 +9600,108 @@ export interface components {
|
|
|
9446
9600
|
/** @description Effectively always false on create: Meta review takes minutes to hours. Reference it from a step now — a pending template does not block launch; sends start the moment it clears. */
|
|
9447
9601
|
sendable: boolean;
|
|
9448
9602
|
};
|
|
9603
|
+
SequenceStepPersonalizationDto: {
|
|
9604
|
+
step_index: number;
|
|
9605
|
+
content: ({
|
|
9606
|
+
/** @constant */
|
|
9607
|
+
type: "email";
|
|
9608
|
+
subject: string;
|
|
9609
|
+
html: string;
|
|
9610
|
+
text: string;
|
|
9611
|
+
} | {
|
|
9612
|
+
/** @constant */
|
|
9613
|
+
type: "voice_call";
|
|
9614
|
+
extra_instructions: string | null;
|
|
9615
|
+
} | {
|
|
9616
|
+
/** @constant */
|
|
9617
|
+
type: "whatsapp_template";
|
|
9618
|
+
template_name: string;
|
|
9619
|
+
template_language: string;
|
|
9620
|
+
values: {
|
|
9621
|
+
[key: string]: string;
|
|
9622
|
+
};
|
|
9623
|
+
}) | null;
|
|
9624
|
+
edited_at: string | null;
|
|
9625
|
+
edited_by: number | null;
|
|
9626
|
+
stale: boolean;
|
|
9627
|
+
unreadable: boolean;
|
|
9628
|
+
};
|
|
9629
|
+
SetSequenceStepPersonalizationOutputDto: {
|
|
9630
|
+
personalization: components["schemas"]["SequenceStepPersonalizationDto"];
|
|
9631
|
+
unparked: boolean;
|
|
9632
|
+
armed: boolean;
|
|
9633
|
+
};
|
|
9634
|
+
ClearSequenceStepPersonalizationOutputDto: {
|
|
9635
|
+
cleared: boolean;
|
|
9636
|
+
};
|
|
9637
|
+
SequenceStepPreviewDto: {
|
|
9638
|
+
step_index: number;
|
|
9639
|
+
/** @enum {string} */
|
|
9640
|
+
channel: "whatsapp" | "voice" | "email";
|
|
9641
|
+
/** @enum {string} */
|
|
9642
|
+
source: "template" | "personalized" | "sent";
|
|
9643
|
+
stale_personalization: boolean;
|
|
9644
|
+
sender_id: string | null;
|
|
9645
|
+
editable: boolean;
|
|
9646
|
+
journey: {
|
|
9647
|
+
step_index: number;
|
|
9648
|
+
channel: string;
|
|
9649
|
+
/** @enum {string} */
|
|
9650
|
+
state: "not_reached" | "waiting" | "parked" | "deferred" | "skipped" | "sent" | "delivered" | "read" | "replied" | "answered" | "no_answer" | "busy" | "failed";
|
|
9651
|
+
at: string | null;
|
|
9652
|
+
session_id: string | null;
|
|
9653
|
+
session_ticket_number: number | null;
|
|
9654
|
+
reason?: string;
|
|
9655
|
+
};
|
|
9656
|
+
render: {
|
|
9657
|
+
/** @constant */
|
|
9658
|
+
status: "rendered";
|
|
9659
|
+
content: {
|
|
9660
|
+
/** @constant */
|
|
9661
|
+
type: "email";
|
|
9662
|
+
subject: string;
|
|
9663
|
+
html: string;
|
|
9664
|
+
text: string;
|
|
9665
|
+
} | {
|
|
9666
|
+
/** @constant */
|
|
9667
|
+
type: "voice_call";
|
|
9668
|
+
extra_instructions: string | null;
|
|
9669
|
+
} | {
|
|
9670
|
+
/** @constant */
|
|
9671
|
+
type: "whatsapp_template";
|
|
9672
|
+
template_name: string;
|
|
9673
|
+
template_language: string;
|
|
9674
|
+
values: {
|
|
9675
|
+
[key: string]: string;
|
|
9676
|
+
};
|
|
9677
|
+
rendered_text: string | null;
|
|
9678
|
+
};
|
|
9679
|
+
} | {
|
|
9680
|
+
/** @constant */
|
|
9681
|
+
status: "needs_data";
|
|
9682
|
+
missing: {
|
|
9683
|
+
[key: string]: string;
|
|
9684
|
+
};
|
|
9685
|
+
} | {
|
|
9686
|
+
/** @constant */
|
|
9687
|
+
status: "unsendable_person";
|
|
9688
|
+
invalid: {
|
|
9689
|
+
[key: string]: string;
|
|
9690
|
+
};
|
|
9691
|
+
} | {
|
|
9692
|
+
/** @constant */
|
|
9693
|
+
status: "too_long";
|
|
9694
|
+
length: number;
|
|
9695
|
+
max: number;
|
|
9696
|
+
} | {
|
|
9697
|
+
/** @constant */
|
|
9698
|
+
status: "template_unavailable";
|
|
9699
|
+
detail: string;
|
|
9700
|
+
} | {
|
|
9701
|
+
/** @constant */
|
|
9702
|
+
status: "send_record_unreadable";
|
|
9703
|
+
};
|
|
9704
|
+
};
|
|
9449
9705
|
ListSequenceContactsDto: {
|
|
9450
9706
|
contacts: {
|
|
9451
9707
|
/** Format: uuid */
|
|
@@ -9494,6 +9750,7 @@ export interface components {
|
|
|
9494
9750
|
session_ticket_number: number | null;
|
|
9495
9751
|
reason?: string;
|
|
9496
9752
|
}[];
|
|
9753
|
+
personalized_steps: number;
|
|
9497
9754
|
/** Format: date-time */
|
|
9498
9755
|
created_at: string;
|
|
9499
9756
|
/** Format: date-time */
|
|
@@ -9545,6 +9802,7 @@ export interface components {
|
|
|
9545
9802
|
session_ticket_number: number | null;
|
|
9546
9803
|
reason?: string;
|
|
9547
9804
|
}[];
|
|
9805
|
+
personalized_steps: number;
|
|
9548
9806
|
/** Format: date-time */
|
|
9549
9807
|
created_at: string;
|
|
9550
9808
|
/** Format: date-time */
|
|
@@ -9605,6 +9863,7 @@ export interface components {
|
|
|
9605
9863
|
} | null;
|
|
9606
9864
|
next_eligible_at: string | null;
|
|
9607
9865
|
next_channel: string | null;
|
|
9866
|
+
personalizations: components["schemas"]["SequenceStepPersonalizationDto"][];
|
|
9608
9867
|
};
|
|
9609
9868
|
ExitSequenceContactOutputDto: {
|
|
9610
9869
|
/** @enum {string} */
|
|
@@ -10134,6 +10393,17 @@ export interface components {
|
|
|
10134
10393
|
};
|
|
10135
10394
|
};
|
|
10136
10395
|
};
|
|
10396
|
+
SkillDto: {
|
|
10397
|
+
/** Format: uuid */
|
|
10398
|
+
id: string;
|
|
10399
|
+
org_id: string;
|
|
10400
|
+
name: string;
|
|
10401
|
+
description: string | null;
|
|
10402
|
+
/** Format: date-time */
|
|
10403
|
+
created_at: string;
|
|
10404
|
+
/** Format: date-time */
|
|
10405
|
+
updated_at: string;
|
|
10406
|
+
};
|
|
10137
10407
|
CustomTrainingDirectoriesDto: {
|
|
10138
10408
|
id: string;
|
|
10139
10409
|
name: string;
|
|
@@ -12489,7 +12759,7 @@ export interface components {
|
|
|
12489
12759
|
/** Format: email */
|
|
12490
12760
|
email: string;
|
|
12491
12761
|
avatar_url?: string | null;
|
|
12492
|
-
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "workflows:execute" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "companion:read" | "companion:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields:write" | "settings-webhooks:read" | "settings-webhooks:write" | "settings-secrets:read" | "settings-secrets:write" | "settings-handoff:read" | "settings-handoff:write" | "settings-translations:read" | "settings-translations:write" | "settings-sso:read" | "settings-sso:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-reports:read" | "settings-reports:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
12762
|
+
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "workflows:execute" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "companion:read" | "companion:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields:write" | "settings-webhooks:read" | "settings-webhooks:write" | "settings-secrets:read" | "settings-secrets:write" | "settings-handoff:read" | "settings-handoff:write" | "settings-translations:read" | "settings-translations:write" | "settings-sso:read" | "settings-sso:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-reports:read" | "settings-reports:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-personal-profile:read" | "settings-personal-profile:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
12493
12763
|
};
|
|
12494
12764
|
OrgUserDetail: {
|
|
12495
12765
|
id: number;
|
|
@@ -12498,7 +12768,7 @@ export interface components {
|
|
|
12498
12768
|
/** Format: email */
|
|
12499
12769
|
email: string;
|
|
12500
12770
|
avatar_url?: string | null;
|
|
12501
|
-
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "workflows:execute" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "companion:read" | "companion:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields:write" | "settings-webhooks:read" | "settings-webhooks:write" | "settings-secrets:read" | "settings-secrets:write" | "settings-handoff:read" | "settings-handoff:write" | "settings-translations:read" | "settings-translations:write" | "settings-sso:read" | "settings-sso:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-reports:read" | "settings-reports:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
12771
|
+
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "workflows:execute" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "companion:read" | "companion:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields:write" | "settings-webhooks:read" | "settings-webhooks:write" | "settings-secrets:read" | "settings-secrets:write" | "settings-handoff:read" | "settings-handoff:write" | "settings-translations:read" | "settings-translations:write" | "settings-sso:read" | "settings-sso:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-reports:read" | "settings-reports:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-personal-profile:read" | "settings-personal-profile:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
12502
12772
|
teams: {
|
|
12503
12773
|
group: components["schemas"]["GroupDto"];
|
|
12504
12774
|
is_user_available_on_group: boolean;
|
|
@@ -12914,6 +13184,9 @@ export interface components {
|
|
|
12914
13184
|
}[];
|
|
12915
13185
|
ListEmailTemplatesOutput: components["schemas"]["EmailTemplateDto"][];
|
|
12916
13186
|
ListMacrosOutput: components["schemas"]["SavedReplyDto"][];
|
|
13187
|
+
ListSkillsOutput: components["schemas"]["SkillDto"][];
|
|
13188
|
+
GetUserSkillsOutput: components["schemas"]["SkillDto"][];
|
|
13189
|
+
SetUserSkillsOutput: components["schemas"]["SkillDto"][];
|
|
12917
13190
|
ListHandoffEventsOutput: {
|
|
12918
13191
|
items: {
|
|
12919
13192
|
session_id: string;
|
|
@@ -17270,6 +17543,234 @@ export interface operations {
|
|
|
17270
17543
|
};
|
|
17271
17544
|
};
|
|
17272
17545
|
};
|
|
17546
|
+
listSkills: {
|
|
17547
|
+
parameters: {
|
|
17548
|
+
query?: never;
|
|
17549
|
+
header?: never;
|
|
17550
|
+
path?: never;
|
|
17551
|
+
cookie?: never;
|
|
17552
|
+
};
|
|
17553
|
+
requestBody?: never;
|
|
17554
|
+
responses: {
|
|
17555
|
+
/** @description Default Response */
|
|
17556
|
+
200: {
|
|
17557
|
+
headers: {
|
|
17558
|
+
[name: string]: unknown;
|
|
17559
|
+
};
|
|
17560
|
+
content: {
|
|
17561
|
+
"application/json": components["schemas"]["ListSkillsOutput"];
|
|
17562
|
+
};
|
|
17563
|
+
};
|
|
17564
|
+
/** @description Internal Server Error */
|
|
17565
|
+
500: {
|
|
17566
|
+
headers: {
|
|
17567
|
+
[name: string]: unknown;
|
|
17568
|
+
};
|
|
17569
|
+
content: {
|
|
17570
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17571
|
+
};
|
|
17572
|
+
};
|
|
17573
|
+
};
|
|
17574
|
+
};
|
|
17575
|
+
createSkill: {
|
|
17576
|
+
parameters: {
|
|
17577
|
+
query?: never;
|
|
17578
|
+
header?: never;
|
|
17579
|
+
path?: never;
|
|
17580
|
+
cookie?: never;
|
|
17581
|
+
};
|
|
17582
|
+
requestBody: {
|
|
17583
|
+
content: {
|
|
17584
|
+
"application/json": components["schemas"]["CreateSkillDto"];
|
|
17585
|
+
};
|
|
17586
|
+
};
|
|
17587
|
+
responses: {
|
|
17588
|
+
/** @description Default Response */
|
|
17589
|
+
201: {
|
|
17590
|
+
headers: {
|
|
17591
|
+
[name: string]: unknown;
|
|
17592
|
+
};
|
|
17593
|
+
content: {
|
|
17594
|
+
"application/json": components["schemas"]["SkillDto"];
|
|
17595
|
+
};
|
|
17596
|
+
};
|
|
17597
|
+
/** @description Internal Server Error */
|
|
17598
|
+
500: {
|
|
17599
|
+
headers: {
|
|
17600
|
+
[name: string]: unknown;
|
|
17601
|
+
};
|
|
17602
|
+
content: {
|
|
17603
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17604
|
+
};
|
|
17605
|
+
};
|
|
17606
|
+
};
|
|
17607
|
+
};
|
|
17608
|
+
getSkill: {
|
|
17609
|
+
parameters: {
|
|
17610
|
+
query?: never;
|
|
17611
|
+
header?: never;
|
|
17612
|
+
path: {
|
|
17613
|
+
/** @description Skill ID */
|
|
17614
|
+
skill_id: string;
|
|
17615
|
+
};
|
|
17616
|
+
cookie?: never;
|
|
17617
|
+
};
|
|
17618
|
+
requestBody?: never;
|
|
17619
|
+
responses: {
|
|
17620
|
+
/** @description Default Response */
|
|
17621
|
+
200: {
|
|
17622
|
+
headers: {
|
|
17623
|
+
[name: string]: unknown;
|
|
17624
|
+
};
|
|
17625
|
+
content: {
|
|
17626
|
+
"application/json": components["schemas"]["SkillDto"];
|
|
17627
|
+
};
|
|
17628
|
+
};
|
|
17629
|
+
/** @description Internal Server Error */
|
|
17630
|
+
500: {
|
|
17631
|
+
headers: {
|
|
17632
|
+
[name: string]: unknown;
|
|
17633
|
+
};
|
|
17634
|
+
content: {
|
|
17635
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17636
|
+
};
|
|
17637
|
+
};
|
|
17638
|
+
};
|
|
17639
|
+
};
|
|
17640
|
+
deleteSkill: {
|
|
17641
|
+
parameters: {
|
|
17642
|
+
query?: never;
|
|
17643
|
+
header?: never;
|
|
17644
|
+
path: {
|
|
17645
|
+
/** @description Skill ID */
|
|
17646
|
+
skill_id: string;
|
|
17647
|
+
};
|
|
17648
|
+
cookie?: never;
|
|
17649
|
+
};
|
|
17650
|
+
requestBody?: never;
|
|
17651
|
+
responses: {
|
|
17652
|
+
/** @description Default Response */
|
|
17653
|
+
204: {
|
|
17654
|
+
headers: {
|
|
17655
|
+
[name: string]: unknown;
|
|
17656
|
+
};
|
|
17657
|
+
content?: never;
|
|
17658
|
+
};
|
|
17659
|
+
/** @description Internal Server Error */
|
|
17660
|
+
500: {
|
|
17661
|
+
headers: {
|
|
17662
|
+
[name: string]: unknown;
|
|
17663
|
+
};
|
|
17664
|
+
content: {
|
|
17665
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17666
|
+
};
|
|
17667
|
+
};
|
|
17668
|
+
};
|
|
17669
|
+
};
|
|
17670
|
+
updateSkill: {
|
|
17671
|
+
parameters: {
|
|
17672
|
+
query?: never;
|
|
17673
|
+
header?: never;
|
|
17674
|
+
path: {
|
|
17675
|
+
/** @description Skill ID */
|
|
17676
|
+
skill_id: string;
|
|
17677
|
+
};
|
|
17678
|
+
cookie?: never;
|
|
17679
|
+
};
|
|
17680
|
+
requestBody: {
|
|
17681
|
+
content: {
|
|
17682
|
+
"application/json": components["schemas"]["UpdateSkillDto"];
|
|
17683
|
+
};
|
|
17684
|
+
};
|
|
17685
|
+
responses: {
|
|
17686
|
+
/** @description Default Response */
|
|
17687
|
+
200: {
|
|
17688
|
+
headers: {
|
|
17689
|
+
[name: string]: unknown;
|
|
17690
|
+
};
|
|
17691
|
+
content: {
|
|
17692
|
+
"application/json": components["schemas"]["SkillDto"];
|
|
17693
|
+
};
|
|
17694
|
+
};
|
|
17695
|
+
/** @description Internal Server Error */
|
|
17696
|
+
500: {
|
|
17697
|
+
headers: {
|
|
17698
|
+
[name: string]: unknown;
|
|
17699
|
+
};
|
|
17700
|
+
content: {
|
|
17701
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17702
|
+
};
|
|
17703
|
+
};
|
|
17704
|
+
};
|
|
17705
|
+
};
|
|
17706
|
+
getUserSkills: {
|
|
17707
|
+
parameters: {
|
|
17708
|
+
query?: never;
|
|
17709
|
+
header?: never;
|
|
17710
|
+
path: {
|
|
17711
|
+
/** @description Organization user ID */
|
|
17712
|
+
user_id: number;
|
|
17713
|
+
};
|
|
17714
|
+
cookie?: never;
|
|
17715
|
+
};
|
|
17716
|
+
requestBody?: never;
|
|
17717
|
+
responses: {
|
|
17718
|
+
/** @description Default Response */
|
|
17719
|
+
200: {
|
|
17720
|
+
headers: {
|
|
17721
|
+
[name: string]: unknown;
|
|
17722
|
+
};
|
|
17723
|
+
content: {
|
|
17724
|
+
"application/json": components["schemas"]["GetUserSkillsOutput"];
|
|
17725
|
+
};
|
|
17726
|
+
};
|
|
17727
|
+
/** @description Internal Server Error */
|
|
17728
|
+
500: {
|
|
17729
|
+
headers: {
|
|
17730
|
+
[name: string]: unknown;
|
|
17731
|
+
};
|
|
17732
|
+
content: {
|
|
17733
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17734
|
+
};
|
|
17735
|
+
};
|
|
17736
|
+
};
|
|
17737
|
+
};
|
|
17738
|
+
setUserSkills: {
|
|
17739
|
+
parameters: {
|
|
17740
|
+
query?: never;
|
|
17741
|
+
header?: never;
|
|
17742
|
+
path: {
|
|
17743
|
+
/** @description Organization user ID */
|
|
17744
|
+
user_id: number;
|
|
17745
|
+
};
|
|
17746
|
+
cookie?: never;
|
|
17747
|
+
};
|
|
17748
|
+
requestBody: {
|
|
17749
|
+
content: {
|
|
17750
|
+
"application/json": components["schemas"]["UpdateUserSkillsDto"];
|
|
17751
|
+
};
|
|
17752
|
+
};
|
|
17753
|
+
responses: {
|
|
17754
|
+
/** @description Default Response */
|
|
17755
|
+
200: {
|
|
17756
|
+
headers: {
|
|
17757
|
+
[name: string]: unknown;
|
|
17758
|
+
};
|
|
17759
|
+
content: {
|
|
17760
|
+
"application/json": components["schemas"]["SetUserSkillsOutput"];
|
|
17761
|
+
};
|
|
17762
|
+
};
|
|
17763
|
+
/** @description Internal Server Error */
|
|
17764
|
+
500: {
|
|
17765
|
+
headers: {
|
|
17766
|
+
[name: string]: unknown;
|
|
17767
|
+
};
|
|
17768
|
+
content: {
|
|
17769
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
17770
|
+
};
|
|
17771
|
+
};
|
|
17772
|
+
};
|
|
17773
|
+
};
|
|
17273
17774
|
listHandoffEvents: {
|
|
17274
17775
|
parameters: {
|
|
17275
17776
|
query?: {
|
|
@@ -20409,6 +20910,118 @@ export interface operations {
|
|
|
20409
20910
|
};
|
|
20410
20911
|
};
|
|
20411
20912
|
};
|
|
20913
|
+
previewSequenceStepForContact: {
|
|
20914
|
+
parameters: {
|
|
20915
|
+
query?: never;
|
|
20916
|
+
header?: never;
|
|
20917
|
+
path: {
|
|
20918
|
+
/** @description The unique identifier of the sequence */
|
|
20919
|
+
sequenceId: string;
|
|
20920
|
+
/** @description The person's contact id (from enroll results or the people list) */
|
|
20921
|
+
contactId: string;
|
|
20922
|
+
/** @description Zero-based position in the step list */
|
|
20923
|
+
stepIndex: number;
|
|
20924
|
+
};
|
|
20925
|
+
cookie?: never;
|
|
20926
|
+
};
|
|
20927
|
+
requestBody?: never;
|
|
20928
|
+
responses: {
|
|
20929
|
+
/** @description Default Response */
|
|
20930
|
+
200: {
|
|
20931
|
+
headers: {
|
|
20932
|
+
[name: string]: unknown;
|
|
20933
|
+
};
|
|
20934
|
+
content: {
|
|
20935
|
+
"application/json": components["schemas"]["SequenceStepPreviewDto"];
|
|
20936
|
+
};
|
|
20937
|
+
};
|
|
20938
|
+
/** @description Internal Server Error */
|
|
20939
|
+
500: {
|
|
20940
|
+
headers: {
|
|
20941
|
+
[name: string]: unknown;
|
|
20942
|
+
};
|
|
20943
|
+
content: {
|
|
20944
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
20945
|
+
};
|
|
20946
|
+
};
|
|
20947
|
+
};
|
|
20948
|
+
};
|
|
20949
|
+
setSequenceStepPersonalization: {
|
|
20950
|
+
parameters: {
|
|
20951
|
+
query?: never;
|
|
20952
|
+
header?: never;
|
|
20953
|
+
path: {
|
|
20954
|
+
/** @description The unique identifier of the sequence */
|
|
20955
|
+
sequenceId: string;
|
|
20956
|
+
/** @description The person's contact id (from enroll results or the people list) */
|
|
20957
|
+
contactId: string;
|
|
20958
|
+
/** @description Zero-based position in the step list */
|
|
20959
|
+
stepIndex: number;
|
|
20960
|
+
};
|
|
20961
|
+
cookie?: never;
|
|
20962
|
+
};
|
|
20963
|
+
requestBody: {
|
|
20964
|
+
content: {
|
|
20965
|
+
"application/json": components["schemas"]["SetSequenceStepPersonalizationDto"];
|
|
20966
|
+
};
|
|
20967
|
+
};
|
|
20968
|
+
responses: {
|
|
20969
|
+
/** @description Default Response */
|
|
20970
|
+
200: {
|
|
20971
|
+
headers: {
|
|
20972
|
+
[name: string]: unknown;
|
|
20973
|
+
};
|
|
20974
|
+
content: {
|
|
20975
|
+
"application/json": components["schemas"]["SetSequenceStepPersonalizationOutputDto"];
|
|
20976
|
+
};
|
|
20977
|
+
};
|
|
20978
|
+
/** @description Internal Server Error */
|
|
20979
|
+
500: {
|
|
20980
|
+
headers: {
|
|
20981
|
+
[name: string]: unknown;
|
|
20982
|
+
};
|
|
20983
|
+
content: {
|
|
20984
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
20985
|
+
};
|
|
20986
|
+
};
|
|
20987
|
+
};
|
|
20988
|
+
};
|
|
20989
|
+
clearSequenceStepPersonalization: {
|
|
20990
|
+
parameters: {
|
|
20991
|
+
query?: never;
|
|
20992
|
+
header?: never;
|
|
20993
|
+
path: {
|
|
20994
|
+
/** @description The unique identifier of the sequence */
|
|
20995
|
+
sequenceId: string;
|
|
20996
|
+
/** @description The person's contact id (from enroll results or the people list) */
|
|
20997
|
+
contactId: string;
|
|
20998
|
+
/** @description Zero-based position in the step list */
|
|
20999
|
+
stepIndex: number;
|
|
21000
|
+
};
|
|
21001
|
+
cookie?: never;
|
|
21002
|
+
};
|
|
21003
|
+
requestBody?: never;
|
|
21004
|
+
responses: {
|
|
21005
|
+
/** @description Default Response */
|
|
21006
|
+
200: {
|
|
21007
|
+
headers: {
|
|
21008
|
+
[name: string]: unknown;
|
|
21009
|
+
};
|
|
21010
|
+
content: {
|
|
21011
|
+
"application/json": components["schemas"]["ClearSequenceStepPersonalizationOutputDto"];
|
|
21012
|
+
};
|
|
21013
|
+
};
|
|
21014
|
+
/** @description Internal Server Error */
|
|
21015
|
+
500: {
|
|
21016
|
+
headers: {
|
|
21017
|
+
[name: string]: unknown;
|
|
21018
|
+
};
|
|
21019
|
+
content: {
|
|
21020
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
21021
|
+
};
|
|
21022
|
+
};
|
|
21023
|
+
};
|
|
21024
|
+
};
|
|
20412
21025
|
includeSequenceContact: {
|
|
20413
21026
|
parameters: {
|
|
20414
21027
|
query?: never;
|