@opencx/mcp 1.15.52 → 1.15.54
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/email-tools.spec.js +24 -0
- package/dist/email-tools.spec.js.map +1 -1
- package/dist/schema.d.ts +244 -12
- package/dist/schema.d.ts.map +1 -1
- package/dist/tools/audit-logs.d.ts.map +1 -1
- package/dist/tools/audit-logs.js +14 -1
- package/dist/tools/audit-logs.js.map +1 -1
- package/dist/tools/email.d.ts.map +1 -1
- package/dist/tools/email.js +8 -3
- package/dist/tools/email.js.map +1 -1
- package/dist/tools/structured-fields.d.ts.map +1 -1
- package/dist/tools/structured-fields.js +54 -2
- package/dist/tools/structured-fields.js.map +1 -1
- package/package.json +1 -1
package/dist/email-tools.spec.js
CHANGED
|
@@ -56,6 +56,30 @@ describe('email tools', () => {
|
|
|
56
56
|
const { tools } = await client.listTools();
|
|
57
57
|
return tools.find((t) => t.name === name);
|
|
58
58
|
};
|
|
59
|
+
describe('add_email_domain', () => {
|
|
60
|
+
it.each([undefined, 'eu-west-1', 'us-east-1'])('forwards region %s, leaving the omitted default to the API', async (region) => {
|
|
61
|
+
const result = await client.callTool({
|
|
62
|
+
name: 'add_email_domain',
|
|
63
|
+
arguments: { domain_name: 'support.example.com', ...(region ? { region } : {}) },
|
|
64
|
+
});
|
|
65
|
+
expect(result.isError).not.toBe(true);
|
|
66
|
+
expect(fetchSpy).toHaveBeenCalledTimes(1);
|
|
67
|
+
const call = fetchSpy.mock.calls[0];
|
|
68
|
+
if (!call)
|
|
69
|
+
throw new Error('Expected a domain creation request');
|
|
70
|
+
expect(requestUrl(call)).toContain('/email/domains');
|
|
71
|
+
expect(await requestBody(call)).toEqual({
|
|
72
|
+
domainName: 'support.example.com',
|
|
73
|
+
...(region ? { region } : {}),
|
|
74
|
+
});
|
|
75
|
+
const invalid = await client.callTool({
|
|
76
|
+
name: 'add_email_domain',
|
|
77
|
+
arguments: { domain_name: 'support.example.com', region: 'sa-east-1' },
|
|
78
|
+
});
|
|
79
|
+
expect(invalid.isError).toBe(true);
|
|
80
|
+
expect(fetchSpy).toHaveBeenCalledTimes(1);
|
|
81
|
+
});
|
|
82
|
+
});
|
|
59
83
|
describe('send_email', () => {
|
|
60
84
|
it('declares recipients by to_email, never by contact_id', async () => {
|
|
61
85
|
const tool = await toolNamed('send_email');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"email-tools.spec.js","sourceRoot":"","sources":["../src/email-tools.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,mDAAmD;AACnD,EAAE;AACF,+EAA+E;AAC/E,8EAA8E;AAC9E,8EAA8E;AAC9E,6EAA6E;AAC7E,mCAAmC;AAEnC,SAAS,YAAY,CAAC,IAAa,EAAE,MAAM,GAAG,GAAG;IAC/C,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,UAAU,CAAC,IAAe;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACxD,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,IAAe;IACxC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACrB,IACE,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAC7B,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,MAAc,CAAC;IACnB,IAAI,OAA4B,CAAC;IACjC,IAAI,QAAkC,CAAC;IAEvC,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACjE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEjC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;QACpE,MAAM,CAAC,eAAe,EAAE,eAAe,CAAC,GAAG,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;QAChF,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACtC,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACtC,OAAO,GAAG,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;YACrB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,OAAO,EAAE,CAAC;QAChB,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;QACvC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC;IAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAK,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC5E,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACpB,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE;oBACT,UAAU,EAAE,0BAA0B;oBACtC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC;iBAClD;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAChE,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACzB,UAAU,EAAE,0BAA0B;gBACtC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC;aAClD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;YACnF,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACpB,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE;oBACT,UAAU,EAAE,0BAA0B;oBACtC,UAAU,EAAE;wBACV;4BACE,QAAQ,EAAE,eAAe;4BACzB,aAAa,EAAE,cAAc;4BAC7B,UAAU,EAAE,kBAAkB;4BAC9B,iBAAiB,EAAE,cAAc;4BACjC,sBAAsB,EAAE,IAAI;yBAC7B;wBACD,EAAE,QAAQ,EAAE,eAAe,EAAE;qBAC9B;oBACD,gBAAgB,EAAE,CAAC;oBACnB,sBAAsB,EAAE,kBAAkB;iBAC3C;aACF,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBACnB,UAAU,EAAE,0BAA0B;gBACtC,UAAU,EAAE;oBACV;wBACE,QAAQ,EAAE,eAAe;wBACzB,aAAa,EAAE,cAAc;wBAC7B,UAAU,EAAE,kBAAkB;wBAC9B,iBAAiB,EAAE,cAAc;wBACjC,sBAAsB,EAAE,IAAI;qBAC7B;oBACD,EAAE,QAAQ,EAAE,eAAe,EAAE;iBAC9B;gBACD,gBAAgB,EAAE,CAAC;gBACnB,sBAAsB,EAAE,kBAAkB;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;YAC3F,wEAAwE;YACxE,yEAAyE;YACzE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACnC,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE;oBACT,UAAU,EAAE,0BAA0B;oBACtC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,sCAAsC,EAAE,CAAC;iBACnE;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;YACrG,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YACpD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YACxD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC,CAAC;YACnD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YACxD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"email-tools.spec.js","sourceRoot":"","sources":["../src/email-tools.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,mDAAmD;AACnD,EAAE;AACF,+EAA+E;AAC/E,8EAA8E;AAC9E,8EAA8E;AAC9E,6EAA6E;AAC7E,mCAAmC;AAEnC,SAAS,YAAY,CAAC,IAAa,EAAE,MAAM,GAAG,GAAG;IAC/C,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,UAAU,CAAC,IAAe;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACxD,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,IAAe;IACxC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACrB,IACE,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAC7B,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,MAAc,CAAC;IACnB,IAAI,OAA4B,CAAC;IACjC,IAAI,QAAkC,CAAC;IAEvC,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACjE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEjC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;QACpE,MAAM,CAAC,eAAe,EAAE,eAAe,CAAC,GAAG,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;QAChF,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACtC,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACtC,OAAO,GAAG,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;YACrB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,OAAO,EAAE,CAAC;QAChB,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;QACvC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC;IAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAU,CAAC,CACrD,4DAA4D,EAC5D,KAAK,EAAE,MAAM,EAAE,EAAE;YACf,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACnC,IAAI,EAAE,kBAAkB;gBACxB,SAAS,EAAE,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;aACjF,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACjE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;gBACtC,UAAU,EAAE,qBAAqB;gBACjC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9B,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACpC,IAAI,EAAE,kBAAkB;gBACxB,SAAS,EAAE,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,EAAE,WAAW,EAAE;aACvE,CAAC,CAAC;YACH,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAK,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC5E,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACpB,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE;oBACT,UAAU,EAAE,0BAA0B;oBACtC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC;iBAClD;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAChE,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACzB,UAAU,EAAE,0BAA0B;gBACtC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC;aAClD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;YACnF,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACpB,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE;oBACT,UAAU,EAAE,0BAA0B;oBACtC,UAAU,EAAE;wBACV;4BACE,QAAQ,EAAE,eAAe;4BACzB,aAAa,EAAE,cAAc;4BAC7B,UAAU,EAAE,kBAAkB;4BAC9B,iBAAiB,EAAE,cAAc;4BACjC,sBAAsB,EAAE,IAAI;yBAC7B;wBACD,EAAE,QAAQ,EAAE,eAAe,EAAE;qBAC9B;oBACD,gBAAgB,EAAE,CAAC;oBACnB,sBAAsB,EAAE,kBAAkB;iBAC3C;aACF,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBACnB,UAAU,EAAE,0BAA0B;gBACtC,UAAU,EAAE;oBACV;wBACE,QAAQ,EAAE,eAAe;wBACzB,aAAa,EAAE,cAAc;wBAC7B,UAAU,EAAE,kBAAkB;wBAC9B,iBAAiB,EAAE,cAAc;wBACjC,sBAAsB,EAAE,IAAI;qBAC7B;oBACD,EAAE,QAAQ,EAAE,eAAe,EAAE;iBAC9B;gBACD,gBAAgB,EAAE,CAAC;gBACnB,sBAAsB,EAAE,kBAAkB;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;YAC3F,wEAAwE;YACxE,yEAAyE;YACzE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC;gBACnC,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE;oBACT,UAAU,EAAE,0BAA0B;oBACtC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,sCAAsC,EAAE,CAAC;iBACnE;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;YACrG,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YACpD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YACxD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC,CAAC;YACnD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YACxD,MAAM,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/schema.d.ts
CHANGED
|
@@ -164,7 +164,7 @@ export interface paths {
|
|
|
164
164
|
};
|
|
165
165
|
/**
|
|
166
166
|
* List audit logs
|
|
167
|
-
* @description Query the audit log to see who changed what and when. Returns
|
|
167
|
+
* @description Query the audit log to see who changed what and when, including teammate sign-ins and sign-outs. Returns change events newest first with before/after diffs. Page with `page`, or pass the `next_cursor` of the previous response as `cursor` for stable, faster paging.
|
|
168
168
|
*/
|
|
169
169
|
get: operations["listAuditLogs"];
|
|
170
170
|
put?: never;
|
|
@@ -1416,7 +1416,7 @@ export interface paths {
|
|
|
1416
1416
|
put?: never;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* Create a structured field
|
|
1419
|
-
* @description Create a new structured field definition. `key` is its immutable, API-safe identifier (lowercase letters, numbers, underscores) — workflows reference it by this key, so choose carefully; neither `key` nor `type` can be changed after creation. Enum choices are authored separately. Field definitions never accept a default value.
|
|
1419
|
+
* @description Create a new structured field definition. `key` is its immutable, API-safe identifier (lowercase letters, numbers, underscores) — workflows reference it by this key, so choose carefully; neither `key` nor `type` can be changed after creation. Enum choices are authored separately. Field definitions never accept a default value. Pass `group_id` to file it under a structured field group; a `show_when` parent must be in the same group.
|
|
1420
1420
|
*/
|
|
1421
1421
|
post: operations["createStructuredField"];
|
|
1422
1422
|
delete?: never;
|
|
@@ -1444,7 +1444,7 @@ export interface paths {
|
|
|
1444
1444
|
head?: never;
|
|
1445
1445
|
/**
|
|
1446
1446
|
* Update a structured field
|
|
1447
|
-
* @description Update a structured field’s display name
|
|
1447
|
+
* @description Update a structured field’s display name, description, `show_when` rule, or group (`group_id`, `null` to ungroup). The key and type are immutable, and field definitions never accept a default value. A field can only depend on, or be depended on by, fields in its own group, so to move linked fields, remove the rule, move each field, then add the rule back.
|
|
1448
1448
|
*/
|
|
1449
1449
|
patch: operations["updateStructuredField"];
|
|
1450
1450
|
trace?: never;
|
|
@@ -1493,6 +1493,54 @@ export interface paths {
|
|
|
1493
1493
|
patch: operations["updateStructuredFieldChoice"];
|
|
1494
1494
|
trace?: never;
|
|
1495
1495
|
};
|
|
1496
|
+
"/structured-fields/groups": {
|
|
1497
|
+
parameters: {
|
|
1498
|
+
query?: never;
|
|
1499
|
+
header?: never;
|
|
1500
|
+
path?: never;
|
|
1501
|
+
cookie?: never;
|
|
1502
|
+
};
|
|
1503
|
+
/**
|
|
1504
|
+
* List structured field groups
|
|
1505
|
+
* @description List the organization’s structured field groups in display order. A field’s `group_id` points at one of these; `null` means ungrouped.
|
|
1506
|
+
*/
|
|
1507
|
+
get: operations["listStructuredFieldGroups"];
|
|
1508
|
+
put?: never;
|
|
1509
|
+
/**
|
|
1510
|
+
* Create a structured field group
|
|
1511
|
+
* @description Create a named group to organize structured fields (for example "QA" or "Session details"). Names are unique per organization, case-insensitively. Groups only organize fields: a field behaves the same in any group. `description` is optional; a blank value stores none.
|
|
1512
|
+
*/
|
|
1513
|
+
post: operations["createStructuredFieldGroup"];
|
|
1514
|
+
delete?: never;
|
|
1515
|
+
options?: never;
|
|
1516
|
+
head?: never;
|
|
1517
|
+
patch?: never;
|
|
1518
|
+
trace?: never;
|
|
1519
|
+
};
|
|
1520
|
+
"/structured-fields/groups/{groupId}": {
|
|
1521
|
+
parameters: {
|
|
1522
|
+
query?: never;
|
|
1523
|
+
header?: never;
|
|
1524
|
+
path?: never;
|
|
1525
|
+
cookie?: never;
|
|
1526
|
+
};
|
|
1527
|
+
get?: never;
|
|
1528
|
+
put?: never;
|
|
1529
|
+
post?: never;
|
|
1530
|
+
/**
|
|
1531
|
+
* Delete a structured field group
|
|
1532
|
+
* @description Delete a structured field group. It must hold no structured fields first — move each field to another group (or ungroup it) or delete it.
|
|
1533
|
+
*/
|
|
1534
|
+
delete: operations["deleteStructuredFieldGroup"];
|
|
1535
|
+
options?: never;
|
|
1536
|
+
head?: never;
|
|
1537
|
+
/**
|
|
1538
|
+
* Update a structured field group
|
|
1539
|
+
* @description Rename a structured field group or change its description. Pass `description: null` (or a blank string) to remove it.
|
|
1540
|
+
*/
|
|
1541
|
+
patch: operations["updateStructuredFieldGroup"];
|
|
1542
|
+
trace?: never;
|
|
1543
|
+
};
|
|
1496
1544
|
"/autopilot": {
|
|
1497
1545
|
parameters: {
|
|
1498
1546
|
query?: never;
|
|
@@ -1852,6 +1900,7 @@ export interface paths {
|
|
|
1852
1900
|
* Add or update a custom domain for email sending
|
|
1853
1901
|
* @description
|
|
1854
1902
|
* Add or update a custom domain for sending emails. After adding a domain, you'll need to verify it by adding the provided DNS records.
|
|
1903
|
+
* New domains default to EU (Ireland). Choose eu-west-1 or us-east-1 at creation; the sending region cannot be changed afterward. Adding an existing domain returns its existing configuration.
|
|
1855
1904
|
*
|
|
1856
1905
|
*/
|
|
1857
1906
|
put: operations["putCustomDomain"];
|
|
@@ -6814,6 +6863,14 @@ export interface components {
|
|
|
6814
6863
|
SetSessionStructuredFieldValuesDto: {
|
|
6815
6864
|
values: components["schemas"]["SessionStructuredFieldValueInputDto"][];
|
|
6816
6865
|
};
|
|
6866
|
+
CreateStructuredFieldGroupDto: {
|
|
6867
|
+
name: string;
|
|
6868
|
+
description?: string | null;
|
|
6869
|
+
};
|
|
6870
|
+
UpdateStructuredFieldGroupDto: {
|
|
6871
|
+
name?: string;
|
|
6872
|
+
description?: string | null;
|
|
6873
|
+
};
|
|
6817
6874
|
/** @enum {string} */
|
|
6818
6875
|
StructuredFieldTypeDto: "enum" | "text" | "number" | "boolean" | "date" | "user" | "team" | "tag";
|
|
6819
6876
|
StructuredFieldShowWhenDto: {
|
|
@@ -6827,11 +6884,13 @@ export interface components {
|
|
|
6827
6884
|
description: string;
|
|
6828
6885
|
type?: components["schemas"]["StructuredFieldTypeDto"];
|
|
6829
6886
|
show_when?: components["schemas"]["StructuredFieldShowWhenDto"] | null;
|
|
6887
|
+
group_id?: string | null;
|
|
6830
6888
|
};
|
|
6831
6889
|
UpdateStructuredFieldDto: {
|
|
6832
6890
|
name?: string;
|
|
6833
6891
|
description?: string;
|
|
6834
6892
|
show_when?: components["schemas"]["StructuredFieldShowWhenDto"] | null;
|
|
6893
|
+
group_id?: string | null;
|
|
6835
6894
|
};
|
|
6836
6895
|
CreateStructuredFieldVariantDto: {
|
|
6837
6896
|
value: string;
|
|
@@ -8481,6 +8540,11 @@ export interface components {
|
|
|
8481
8540
|
};
|
|
8482
8541
|
PutCustomDomainInput: {
|
|
8483
8542
|
domainName: string;
|
|
8543
|
+
/**
|
|
8544
|
+
* @description Sending region: EU (Ireland) or US (North Virginia). Defaults to eu-west-1 for new domains. Cannot be changed after creation.
|
|
8545
|
+
* @enum {string}
|
|
8546
|
+
*/
|
|
8547
|
+
region?: "eu-west-1" | "us-east-1";
|
|
8484
8548
|
};
|
|
8485
8549
|
CreateOfficeHoursPublicDto: {
|
|
8486
8550
|
/** @description Schedule name (e.g. "Business Hours", "Weekend Support") */
|
|
@@ -9869,7 +9933,18 @@ export interface components {
|
|
|
9869
9933
|
}) | null;
|
|
9870
9934
|
knowledgebase_called?: boolean | null;
|
|
9871
9935
|
/** @enum {string} */
|
|
9872
|
-
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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
9936
|
+
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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "ivr_selection" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
9937
|
+
ivr_selection?: {
|
|
9938
|
+
/** Format: uuid */
|
|
9939
|
+
runId: string;
|
|
9940
|
+
seq: number;
|
|
9941
|
+
detail: {
|
|
9942
|
+
/** @enum {string} */
|
|
9943
|
+
kind: "prompt" | "keypad" | "result";
|
|
9944
|
+
key?: string;
|
|
9945
|
+
accepted?: boolean;
|
|
9946
|
+
};
|
|
9947
|
+
} | null;
|
|
9873
9948
|
extra_params?: {
|
|
9874
9949
|
[key: string]: unknown;
|
|
9875
9950
|
} | null;
|
|
@@ -10061,6 +10136,20 @@ export interface components {
|
|
|
10061
10136
|
data: components["schemas"]["SessionStructuredFieldValueDto"][];
|
|
10062
10137
|
applicable_field_ids: string[];
|
|
10063
10138
|
};
|
|
10139
|
+
StructuredFieldGroupDto: {
|
|
10140
|
+
/** Format: uuid */
|
|
10141
|
+
id: string;
|
|
10142
|
+
org_id: string;
|
|
10143
|
+
name: string;
|
|
10144
|
+
description: string | null;
|
|
10145
|
+
position: number;
|
|
10146
|
+
archived_at: string | null;
|
|
10147
|
+
/** Format: date-time */
|
|
10148
|
+
created_at: string;
|
|
10149
|
+
/** Format: date-time */
|
|
10150
|
+
updated_at: string;
|
|
10151
|
+
};
|
|
10152
|
+
StructuredFieldGroupListDto: components["schemas"]["StructuredFieldGroupDto"][];
|
|
10064
10153
|
StructuredFieldSystemOptionDto: {
|
|
10065
10154
|
value: string;
|
|
10066
10155
|
label: string;
|
|
@@ -10101,6 +10190,7 @@ export interface components {
|
|
|
10101
10190
|
updated_at: string;
|
|
10102
10191
|
show_when_field_id: string | null;
|
|
10103
10192
|
show_when_values: string[] | null;
|
|
10193
|
+
group_id: string | null;
|
|
10104
10194
|
variants: components["schemas"]["StructuredFieldVariantTreeDto"][];
|
|
10105
10195
|
system_options: components["schemas"]["StructuredFieldSystemOptionDto"][];
|
|
10106
10196
|
};
|
|
@@ -12073,10 +12163,10 @@ export interface components {
|
|
|
12073
12163
|
AddSequenceContactsOutputDto: {
|
|
12074
12164
|
results: {
|
|
12075
12165
|
/**
|
|
12076
|
-
* @description enrolled: new row created · updated: existing candidate refreshed — or a parked person given new data, who resumes their step: armed immediately on a live sequence, back to candidate on a draft or when their judged fit is below the cutoff; a parked person given ONLY session_custom_data keeps it merged and stays parked · already_enrolled: already active/completed here (or parked with nothing new supplied), no-op · skipped_previously_exited: exited here — an exit is terminal, enrolling never restarts a concluded journey · skipped_suppressed: on the do-not-contact list · skipped_active_elsewhere: active in another campaign (block-toggle) · skipped_contacted_before: some campaign already messaged them (block-toggle) · no_identity: no valid phone, email, or whatsapp_user_id after normalization · extra_data_too_large: the extra_data bag exceeds its budget (detail carries size and budget), nothing written — trim and retry just this person · session_custom_data_too_large: the session bag — or its per-key merge with what the person already holds (detail.merged=true) — exceeds 50 keys / 8,000 characters (detail carries keys, size and the caps), nothing written — trim and retry just this person · conflict: handles match two different existing people (detail.matches carries their contact ids), nothing written · error: this row failed unexpectedly, retry just this person
|
|
12166
|
+
* @description enrolled: new row created · updated: existing candidate refreshed — or a parked person given new data, who resumes their step: armed immediately on a live sequence, back to candidate on a draft or when their judged fit is below the cutoff; a parked person given ONLY session_custom_data keeps it merged and stays parked · already_enrolled: already active/completed here (or parked with nothing new supplied), no-op · skipped_previously_exited: exited here — an exit is terminal, enrolling never restarts a concluded journey · skipped_suppressed: on the do-not-contact list · skipped_active_elsewhere: active in another campaign (block-toggle) · skipped_contacted_before: some campaign already messaged them (block-toggle) · no_identity: no valid phone, email, or whatsapp_user_id after normalization · skipped_cannot_create_contact: matched no existing contact and the caller lacks contacts:write, so no contact was created — nothing written ·extra_data_too_large: the extra_data bag exceeds its budget (detail carries size and budget), nothing written — trim and retry just this person · session_custom_data_too_large: the session bag — or its per-key merge with what the person already holds (detail.merged=true) — exceeds 50 keys / 8,000 characters (detail carries keys, size and the caps), nothing written — trim and retry just this person · conflict: handles match two different existing people (detail.matches carries their contact ids), nothing written · error: this row failed unexpectedly, retry just this person
|
|
12077
12167
|
* @enum {string}
|
|
12078
12168
|
*/
|
|
12079
|
-
outcome: "enrolled" | "updated" | "already_enrolled" | "skipped_previously_exited" | "skipped_suppressed" | "skipped_active_elsewhere" | "skipped_contacted_before" | "no_identity" | "extra_data_too_large" | "session_custom_data_too_large" | "conflict" | "error";
|
|
12169
|
+
outcome: "enrolled" | "updated" | "already_enrolled" | "skipped_previously_exited" | "skipped_suppressed" | "skipped_active_elsewhere" | "skipped_contacted_before" | "no_identity" | "skipped_cannot_create_contact" | "extra_data_too_large" | "session_custom_data_too_large" | "conflict" | "error";
|
|
12080
12170
|
/**
|
|
12081
12171
|
* Format: uuid
|
|
12082
12172
|
* @description The person's CRM contact — the identifier every person-scoped op takes. Present whenever a row exists (enrolled, updated, already_enrolled, skipped_previously_exited, and suppressed people who already held a row); absent for outcomes that never touched a row.
|
|
@@ -12914,6 +13004,8 @@ export interface components {
|
|
|
12914
13004
|
limit: number;
|
|
12915
13005
|
totalPages: number;
|
|
12916
13006
|
};
|
|
13007
|
+
/** @description Pass as `cursor` to fetch the next page; null on the last page. */
|
|
13008
|
+
next_cursor: string | null;
|
|
12917
13009
|
};
|
|
12918
13010
|
ResolvedAvailabilityStatusDto: {
|
|
12919
13011
|
/**
|
|
@@ -13036,7 +13128,7 @@ export interface components {
|
|
|
13036
13128
|
*/
|
|
13037
13129
|
type: "unmapped_event";
|
|
13038
13130
|
/** @enum {string} */
|
|
13039
|
-
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13131
|
+
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "ivr_selection" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13040
13132
|
content: {
|
|
13041
13133
|
/** @constant */
|
|
13042
13134
|
type: "text";
|
|
@@ -13325,7 +13417,7 @@ export interface components {
|
|
|
13325
13417
|
*/
|
|
13326
13418
|
type: "unmapped_event";
|
|
13327
13419
|
/** @enum {string} */
|
|
13328
|
-
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13420
|
+
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "ivr_selection" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13329
13421
|
content: {
|
|
13330
13422
|
/** @constant */
|
|
13331
13423
|
type: "text";
|
|
@@ -13607,7 +13699,7 @@ export interface components {
|
|
|
13607
13699
|
* @description Stored event type used by include/exclude filters; it can differ from the normalized event.type.
|
|
13608
13700
|
* @enum {string}
|
|
13609
13701
|
*/
|
|
13610
|
-
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13702
|
+
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "ivr_selection" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "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_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13611
13703
|
actor: {
|
|
13612
13704
|
/** @enum {string} */
|
|
13613
13705
|
type: "human" | "api" | "workflow" | "system" | "integration" | "ai" | "contact" | "unknown";
|
|
@@ -15548,6 +15640,8 @@ export interface components {
|
|
|
15548
15640
|
};
|
|
15549
15641
|
GetCustomDomainsOutput: {
|
|
15550
15642
|
domainName: string;
|
|
15643
|
+
/** @description Saved sending region, or null for older domains without a recorded region. */
|
|
15644
|
+
region: ("eu-west-1" | "us-east-1") | null;
|
|
15551
15645
|
domainNameVerificationStatus: string | null;
|
|
15552
15646
|
records: unknown | null;
|
|
15553
15647
|
}[];
|
|
@@ -16035,11 +16129,19 @@ export interface operations {
|
|
|
16035
16129
|
query?: {
|
|
16036
16130
|
startDate?: string;
|
|
16037
16131
|
endDate?: string;
|
|
16038
|
-
|
|
16039
|
-
|
|
16040
|
-
|
|
16132
|
+
/** @description Repeat to match any of several. Known values: organization, chat_session, custom_session_status, chat_history, consumer, user, group, group_user, role, user_role, skill, user_skills, action, workflow, flow_variable, api_key, openapi_spec, twilio_credential, twitter_account, sunshine_integration, shopify_settings, airbyte_connection, email_channel, custom_domain, sequence, outbound_email, help_center, help_center_category, help_center_article, ai_instruction, website_data_source, pdf_data_source, ai_phone_agent, call_history, teammate_call, analytics, voc_insight, ai_evaluation, organization_model_version, organization_tags_definition, organization_draft_mode_settings, webhook_endpoint, agent_availability, csat_score, csat_settings, agent_assignment_settings, ai_context_custom_data_filters, alert_rule, pii_redaction_settings, security_notification_settings, mini_app, mini_app_version, mcp_server, mcp_connection, organization_secret. */
|
|
16133
|
+
entityType?: string | string[];
|
|
16134
|
+
entityId?: string;
|
|
16135
|
+
/** @description Repeat to match any of several. Known values: create, update, delete, archive, restore, delete_multiple, unpublish, login, logout, password_change, password_reset, token_create, token_revoke, settings_update, handoff_settings_update, translation_settings_update, integration_connect, mcp_tool_call, access_token_retrieved, integration_disconnect, webhook_create, webhook_update, webhook_delete, permission_grant, permission_revoke, api_key_create, api_key_delete, twitter_chat_passcode_reveal, user_invite, user_invite_accept, user_remove, email_send, message_send, teammate_call_started, teammate_call_ended, conference_participant_invited, conference_participant_removed, session_takeover, session_assignee_update, organization_update, organization_ai_profile_update, organization_global_variable_delete, update_agent_availability_status, redaction, user_invite_delete, user_invite_resend, user_invite_link_copied, alert_rule.created, alert_rule.updated, alert_rule.deleted, publish, share. */
|
|
16136
|
+
eventType?: string | string[];
|
|
16137
|
+
/** @description Repeat to match any of several. */
|
|
16138
|
+
eventCategory?: ("access" | "agent_availability" | "communication" | "configuration" | "data" | "security") | ("access" | "agent_availability" | "communication" | "configuration" | "data" | "security")[];
|
|
16041
16139
|
actorId?: number;
|
|
16140
|
+
/** @description Events by or about this teammate: everything they did, plus sign-outs the system ended for them. */
|
|
16141
|
+
userId?: number;
|
|
16042
16142
|
actorType?: "api" | "system" | "user";
|
|
16143
|
+
/** @description `next_cursor` from the previous response. When set, `page` is ignored. */
|
|
16144
|
+
cursor?: string;
|
|
16043
16145
|
page?: number;
|
|
16044
16146
|
limit?: number;
|
|
16045
16147
|
};
|
|
@@ -18981,6 +19083,136 @@ export interface operations {
|
|
|
18981
19083
|
};
|
|
18982
19084
|
};
|
|
18983
19085
|
};
|
|
19086
|
+
listStructuredFieldGroups: {
|
|
19087
|
+
parameters: {
|
|
19088
|
+
query?: never;
|
|
19089
|
+
header?: never;
|
|
19090
|
+
path?: never;
|
|
19091
|
+
cookie?: never;
|
|
19092
|
+
};
|
|
19093
|
+
requestBody?: never;
|
|
19094
|
+
responses: {
|
|
19095
|
+
/** @description Default Response */
|
|
19096
|
+
200: {
|
|
19097
|
+
headers: {
|
|
19098
|
+
[name: string]: unknown;
|
|
19099
|
+
};
|
|
19100
|
+
content: {
|
|
19101
|
+
"application/json": components["schemas"]["StructuredFieldGroupListDto"];
|
|
19102
|
+
};
|
|
19103
|
+
};
|
|
19104
|
+
/** @description Internal Server Error */
|
|
19105
|
+
500: {
|
|
19106
|
+
headers: {
|
|
19107
|
+
[name: string]: unknown;
|
|
19108
|
+
};
|
|
19109
|
+
content: {
|
|
19110
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
19111
|
+
};
|
|
19112
|
+
};
|
|
19113
|
+
};
|
|
19114
|
+
};
|
|
19115
|
+
createStructuredFieldGroup: {
|
|
19116
|
+
parameters: {
|
|
19117
|
+
query?: never;
|
|
19118
|
+
header?: never;
|
|
19119
|
+
path?: never;
|
|
19120
|
+
cookie?: never;
|
|
19121
|
+
};
|
|
19122
|
+
requestBody: {
|
|
19123
|
+
content: {
|
|
19124
|
+
"application/json": components["schemas"]["CreateStructuredFieldGroupDto"];
|
|
19125
|
+
};
|
|
19126
|
+
};
|
|
19127
|
+
responses: {
|
|
19128
|
+
/** @description Default Response */
|
|
19129
|
+
201: {
|
|
19130
|
+
headers: {
|
|
19131
|
+
[name: string]: unknown;
|
|
19132
|
+
};
|
|
19133
|
+
content: {
|
|
19134
|
+
"application/json": components["schemas"]["StructuredFieldGroupDto"];
|
|
19135
|
+
};
|
|
19136
|
+
};
|
|
19137
|
+
/** @description Internal Server Error */
|
|
19138
|
+
500: {
|
|
19139
|
+
headers: {
|
|
19140
|
+
[name: string]: unknown;
|
|
19141
|
+
};
|
|
19142
|
+
content: {
|
|
19143
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
19144
|
+
};
|
|
19145
|
+
};
|
|
19146
|
+
};
|
|
19147
|
+
};
|
|
19148
|
+
deleteStructuredFieldGroup: {
|
|
19149
|
+
parameters: {
|
|
19150
|
+
query?: never;
|
|
19151
|
+
header?: never;
|
|
19152
|
+
path: {
|
|
19153
|
+
/** @description Structured Field Group ID */
|
|
19154
|
+
groupId: string;
|
|
19155
|
+
};
|
|
19156
|
+
cookie?: never;
|
|
19157
|
+
};
|
|
19158
|
+
requestBody?: never;
|
|
19159
|
+
responses: {
|
|
19160
|
+
/** @description Default Response */
|
|
19161
|
+
200: {
|
|
19162
|
+
headers: {
|
|
19163
|
+
[name: string]: unknown;
|
|
19164
|
+
};
|
|
19165
|
+
content: {
|
|
19166
|
+
"application/json": components["schemas"]["StructuredFieldsPublicMessageDto"];
|
|
19167
|
+
};
|
|
19168
|
+
};
|
|
19169
|
+
/** @description Internal Server Error */
|
|
19170
|
+
500: {
|
|
19171
|
+
headers: {
|
|
19172
|
+
[name: string]: unknown;
|
|
19173
|
+
};
|
|
19174
|
+
content: {
|
|
19175
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
19176
|
+
};
|
|
19177
|
+
};
|
|
19178
|
+
};
|
|
19179
|
+
};
|
|
19180
|
+
updateStructuredFieldGroup: {
|
|
19181
|
+
parameters: {
|
|
19182
|
+
query?: never;
|
|
19183
|
+
header?: never;
|
|
19184
|
+
path: {
|
|
19185
|
+
/** @description Structured Field Group ID */
|
|
19186
|
+
groupId: string;
|
|
19187
|
+
};
|
|
19188
|
+
cookie?: never;
|
|
19189
|
+
};
|
|
19190
|
+
requestBody: {
|
|
19191
|
+
content: {
|
|
19192
|
+
"application/json": components["schemas"]["UpdateStructuredFieldGroupDto"];
|
|
19193
|
+
};
|
|
19194
|
+
};
|
|
19195
|
+
responses: {
|
|
19196
|
+
/** @description Default Response */
|
|
19197
|
+
200: {
|
|
19198
|
+
headers: {
|
|
19199
|
+
[name: string]: unknown;
|
|
19200
|
+
};
|
|
19201
|
+
content: {
|
|
19202
|
+
"application/json": components["schemas"]["StructuredFieldGroupDto"];
|
|
19203
|
+
};
|
|
19204
|
+
};
|
|
19205
|
+
/** @description Internal Server Error */
|
|
19206
|
+
500: {
|
|
19207
|
+
headers: {
|
|
19208
|
+
[name: string]: unknown;
|
|
19209
|
+
};
|
|
19210
|
+
content: {
|
|
19211
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
19212
|
+
};
|
|
19213
|
+
};
|
|
19214
|
+
};
|
|
19215
|
+
};
|
|
18984
19216
|
getAutopilotStatus: {
|
|
18985
19217
|
parameters: {
|
|
18986
19218
|
query?: never;
|