@opencx/mcp 1.15.86 → 1.15.87
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/deactivate-org-user.spec.d.ts +2 -0
- package/dist/deactivate-org-user.spec.d.ts.map +1 -0
- package/dist/deactivate-org-user.spec.js +43 -0
- package/dist/deactivate-org-user.spec.js.map +1 -0
- package/dist/schema.d.ts +123 -5
- package/dist/schema.d.ts.map +1 -1
- package/dist/tools/users.d.ts.map +1 -1
- package/dist/tools/users.js +22 -0
- package/dist/tools/users.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deactivate-org-user.spec.d.ts","sourceRoot":"","sources":["../src/deactivate-org-user.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { connectInMemory, fetchCallHeaders, fetchCallUrl, toolTextResultSchema, } from './spec-helpers.js';
|
|
3
|
+
describe.each([
|
|
4
|
+
{ tool: 'deactivate_org_user', path: 'deactivate' },
|
|
5
|
+
{ tool: 'reactivate_org_user', path: 'reactivate' },
|
|
6
|
+
])('$tool', ({ tool, path }) => {
|
|
7
|
+
let client;
|
|
8
|
+
let cleanup;
|
|
9
|
+
let fetchSpy;
|
|
10
|
+
beforeEach(async () => {
|
|
11
|
+
fetchSpy = vi.fn();
|
|
12
|
+
vi.stubGlobal('fetch', fetchSpy);
|
|
13
|
+
({ client, cleanup } = await connectInMemory({ coworkerSessionId: 'companion-session' }));
|
|
14
|
+
});
|
|
15
|
+
afterEach(async () => {
|
|
16
|
+
await cleanup();
|
|
17
|
+
vi.unstubAllGlobals();
|
|
18
|
+
});
|
|
19
|
+
it('posts to its own endpoint with caller auth and attribution, never to removal', async () => {
|
|
20
|
+
fetchSpy.mockResolvedValueOnce(new Response(null, { status: 204 }));
|
|
21
|
+
const result = toolTextResultSchema.parse(await client.callTool({ name: tool, arguments: { user_id: 42 } }));
|
|
22
|
+
expect(fetchSpy).toHaveBeenCalledOnce();
|
|
23
|
+
const [call] = fetchSpy.mock.calls;
|
|
24
|
+
if (!call)
|
|
25
|
+
throw new Error('The tool did not call the API');
|
|
26
|
+
expect(fetchCallUrl(call)).toBe(`https://api.test.com/users/42/${path}`);
|
|
27
|
+
const [input, init] = call;
|
|
28
|
+
expect(input instanceof Request ? input.method : init?.method).toBe('POST');
|
|
29
|
+
expect(fetchCallHeaders(call).get('authorization')).toBe('Bearer test-api-key');
|
|
30
|
+
expect(fetchCallHeaders(call).get('x-opencx-coworker-session-id')).toBe('companion-session');
|
|
31
|
+
expect(result.isError ?? false).toBe(false);
|
|
32
|
+
});
|
|
33
|
+
it.each([{}, { user_id: 0 }, { user_id: 1.5 }, { user_id: '42' }])('rejects invalid input %j before calling the API', async (args) => {
|
|
34
|
+
fetchSpy.mockResolvedValueOnce(new Response(null, { status: 204 }));
|
|
35
|
+
const valid = await client.callTool({ name: tool, arguments: { user_id: 42 } });
|
|
36
|
+
expect(valid.isError ?? false).toBe(false);
|
|
37
|
+
expect(fetchSpy).toHaveBeenCalledOnce();
|
|
38
|
+
const result = await client.callTool({ name: tool, arguments: args });
|
|
39
|
+
expect(result.isError).toBe(true);
|
|
40
|
+
expect(fetchSpy).toHaveBeenCalledOnce();
|
|
41
|
+
});
|
|
42
|
+
});
|
|
43
|
+
//# sourceMappingURL=deactivate-org-user.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deactivate-org-user.spec.js","sourceRoot":"","sources":["../src/deactivate-org-user.spec.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B,QAAQ,CAAC,IAAI,CAAC;IACZ,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,YAAY,EAAE;IACnD,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,YAAY,EAAE;CACpD,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;IAC7B,IAAI,MAAc,CAAC;IACnB,IAAI,OAA4B,CAAC;IACjC,IAAI,QAAgD,CAAC;IAErD,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAgB,CAAC;QACjC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACjC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,eAAe,CAAC,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,OAAO,EAAE,CAAC;QAChB,EAAE,CAAC,gBAAgB,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;QAC5F,QAAQ,CAAC,qBAAqB,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAEpE,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,CACvC,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,CAClE,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QACnC,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAC5D,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;QAC3B,MAAM,CAAC,KAAK,YAAY,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5E,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChF,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC7F,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAChE,iDAAiD,EACjD,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,QAAQ,CAAC,qBAAqB,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAChF,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,EAAE,CAAC;IAC1C,CAAC,CACF,CAAC;AACJ,CAAC,CAAC,CAAC"}
|
package/dist/schema.d.ts
CHANGED
|
@@ -5085,7 +5085,7 @@ export interface paths {
|
|
|
5085
5085
|
};
|
|
5086
5086
|
/**
|
|
5087
5087
|
* List organization users
|
|
5088
|
-
* @description Retrieve users who belong to the organization. Use the optional query to search by name or email.
|
|
5088
|
+
* @description Retrieve users who belong to the organization, including deactivated users (see `status`). Use the optional query to search by name or email.
|
|
5089
5089
|
*/
|
|
5090
5090
|
get: operations["listOrgUsers"];
|
|
5091
5091
|
put?: never;
|
|
@@ -5120,6 +5120,46 @@ export interface paths {
|
|
|
5120
5120
|
patch?: never;
|
|
5121
5121
|
trace?: never;
|
|
5122
5122
|
};
|
|
5123
|
+
"/users/{user_id}/deactivate": {
|
|
5124
|
+
parameters: {
|
|
5125
|
+
query?: never;
|
|
5126
|
+
header?: never;
|
|
5127
|
+
path?: never;
|
|
5128
|
+
cookie?: never;
|
|
5129
|
+
};
|
|
5130
|
+
get?: never;
|
|
5131
|
+
put?: never;
|
|
5132
|
+
/**
|
|
5133
|
+
* Deactivate a user in the organization
|
|
5134
|
+
* @description Keep the user's membership but block their access to this organization and clear their roles. Their team memberships, assigned sessions and history stay as they are. A user deactivated in every organization they belong to can no longer sign in. The organization owner cannot be deactivated. Unlike removing a user, this can be undone with the reactivate endpoint.
|
|
5135
|
+
*/
|
|
5136
|
+
post: operations["deactivateOrgUser"];
|
|
5137
|
+
delete?: never;
|
|
5138
|
+
options?: never;
|
|
5139
|
+
head?: never;
|
|
5140
|
+
patch?: never;
|
|
5141
|
+
trace?: never;
|
|
5142
|
+
};
|
|
5143
|
+
"/users/{user_id}/reactivate": {
|
|
5144
|
+
parameters: {
|
|
5145
|
+
query?: never;
|
|
5146
|
+
header?: never;
|
|
5147
|
+
path?: never;
|
|
5148
|
+
cookie?: never;
|
|
5149
|
+
};
|
|
5150
|
+
get?: never;
|
|
5151
|
+
put?: never;
|
|
5152
|
+
/**
|
|
5153
|
+
* Reactivate a deactivated user
|
|
5154
|
+
* @description Restore access for a deactivated user. They come back without roles, unless directory role sync manages them, in which case they get their mapped roles. Reactivating an active user changes nothing.
|
|
5155
|
+
*/
|
|
5156
|
+
post: operations["reactivateOrgUser"];
|
|
5157
|
+
delete?: never;
|
|
5158
|
+
options?: never;
|
|
5159
|
+
head?: never;
|
|
5160
|
+
patch?: never;
|
|
5161
|
+
trace?: never;
|
|
5162
|
+
};
|
|
5123
5163
|
"/users/batch-delete": {
|
|
5124
5164
|
parameters: {
|
|
5125
5165
|
query?: never;
|
|
@@ -17571,6 +17611,8 @@ export interface components {
|
|
|
17571
17611
|
/** Format: uuid */
|
|
17572
17612
|
id: string;
|
|
17573
17613
|
name: string;
|
|
17614
|
+
/** @description Whether the role is inherited from the main billing organization. Use role IDs to distinguish roles with the same name. */
|
|
17615
|
+
is_inherited?: boolean;
|
|
17574
17616
|
};
|
|
17575
17617
|
OrgUserSummary: {
|
|
17576
17618
|
id: number;
|
|
@@ -17579,8 +17621,15 @@ export interface components {
|
|
|
17579
17621
|
/** Format: email */
|
|
17580
17622
|
email: string;
|
|
17581
17623
|
avatar_url?: string | null;
|
|
17582
|
-
permissions?: ("*" | "sessions:read" | "sessions:write" | "team-sessions:read" | "team-sessions:write" | "assigned-sessions:read" | "assigned-sessions:write" | "hybrid-inbox:read" | "phone-outbound-all-numbers:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "merge-sessions:write" | "sessions-delete-own-messages: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" | "help-center-content:read" | "help-center-content: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-security:read" | "settings-security:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-agent-availability:read" | "settings-agent-availability: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;
|
|
17624
|
+
permissions?: ("*" | "sessions:read" | "sessions:write" | "team-sessions:read" | "team-sessions:write" | "assigned-sessions:read" | "assigned-sessions:write" | "hybrid-inbox:read" | "phone-outbound-all-numbers:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "merge-sessions:write" | "sessions-delete-own-messages: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" | "help-center-content:read" | "help-center-content: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-security:read" | "settings-security:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-agent-availability:read" | "settings-agent-availability: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-scim-role-mappings:read" | "settings-scim-role-mappings:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
17583
17625
|
roles: components["schemas"]["OrgUserRole"][];
|
|
17626
|
+
/**
|
|
17627
|
+
* @description deactivated: the user keeps their membership but cannot use the organization until reactivated. Deactivated users have no roles.
|
|
17628
|
+
* @enum {string}
|
|
17629
|
+
*/
|
|
17630
|
+
status: "active" | "deactivated";
|
|
17631
|
+
/** @description When the user was deactivated in this organization, or null while active. */
|
|
17632
|
+
deactivated_at: string | null;
|
|
17584
17633
|
};
|
|
17585
17634
|
OrgUserDetail: {
|
|
17586
17635
|
id: number;
|
|
@@ -17589,8 +17638,15 @@ export interface components {
|
|
|
17589
17638
|
/** Format: email */
|
|
17590
17639
|
email: string;
|
|
17591
17640
|
avatar_url?: string | null;
|
|
17592
|
-
permissions?: ("*" | "sessions:read" | "sessions:write" | "team-sessions:read" | "team-sessions:write" | "assigned-sessions:read" | "assigned-sessions:write" | "hybrid-inbox:read" | "phone-outbound-all-numbers:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "merge-sessions:write" | "sessions-delete-own-messages: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" | "help-center-content:read" | "help-center-content: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-security:read" | "settings-security:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-agent-availability:read" | "settings-agent-availability: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;
|
|
17641
|
+
permissions?: ("*" | "sessions:read" | "sessions:write" | "team-sessions:read" | "team-sessions:write" | "assigned-sessions:read" | "assigned-sessions:write" | "hybrid-inbox:read" | "phone-outbound-all-numbers:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "merge-sessions:write" | "sessions-delete-own-messages: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" | "help-center-content:read" | "help-center-content: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-security:read" | "settings-security:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-agent-availability:read" | "settings-agent-availability: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-scim-role-mappings:read" | "settings-scim-role-mappings:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
17593
17642
|
roles: components["schemas"]["OrgUserRole"][];
|
|
17643
|
+
/**
|
|
17644
|
+
* @description deactivated: the user keeps their membership but cannot use the organization until reactivated. Deactivated users have no roles.
|
|
17645
|
+
* @enum {string}
|
|
17646
|
+
*/
|
|
17647
|
+
status: "active" | "deactivated";
|
|
17648
|
+
/** @description When the user was deactivated in this organization, or null while active. */
|
|
17649
|
+
deactivated_at: string | null;
|
|
17594
17650
|
teams: {
|
|
17595
17651
|
group: components["schemas"]["GroupDto"];
|
|
17596
17652
|
is_user_available_on_group: boolean;
|
|
@@ -17610,8 +17666,10 @@ export interface components {
|
|
|
17610
17666
|
/** Format: uuid */
|
|
17611
17667
|
id: string;
|
|
17612
17668
|
name: string;
|
|
17669
|
+
/** @description Inherited roles are read-only in this organization. A local and inherited role may share a name; use their IDs to distinguish them. */
|
|
17670
|
+
is_inherited?: boolean;
|
|
17613
17671
|
description: string | null;
|
|
17614
|
-
permissions: ("*" | "sessions:read" | "sessions:write" | "team-sessions:read" | "team-sessions:write" | "assigned-sessions:read" | "assigned-sessions:write" | "hybrid-inbox:read" | "phone-outbound-all-numbers:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "merge-sessions:write" | "sessions-delete-own-messages: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" | "help-center-content:read" | "help-center-content: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-security:read" | "settings-security:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-agent-availability:read" | "settings-agent-availability: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")[];
|
|
17672
|
+
permissions: ("*" | "sessions:read" | "sessions:write" | "team-sessions:read" | "team-sessions:write" | "assigned-sessions:read" | "assigned-sessions:write" | "hybrid-inbox:read" | "phone-outbound-all-numbers:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "merge-sessions:write" | "sessions-delete-own-messages: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" | "help-center-content:read" | "help-center-content: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-security:read" | "settings-security:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-agent-availability:read" | "settings-agent-availability: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-scim-role-mappings:read" | "settings-scim-role-mappings:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[];
|
|
17615
17673
|
};
|
|
17616
17674
|
PublicInsight: {
|
|
17617
17675
|
/** Format: uuid */
|
|
@@ -18992,7 +19050,7 @@ export interface operations {
|
|
|
18992
19050
|
/** @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, genesys_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_settings, security_notification_settings, mini_app, mini_app_version, mcp_server, mcp_connection, organization_secret, saved_reply_translation, workspace_settings. */
|
|
18993
19051
|
entityType?: string | string[];
|
|
18994
19052
|
entityId?: string;
|
|
18995
|
-
/** @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, idle_exit, settings_update, handoff_settings_update, translation_settings_update, integration_connect, mcp_tool_call, access_token_retrieved, integration_disconnect, secret_rotate, 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, ownership_transfer, organization_ai_profile_update, organization_global_variable_delete, update_agent_availability_status, redaction, message_deleted, user_invite_delete, user_invite_resend, user_invite_link_copied, super_invite_link_created, super_invite_link_used, alert_rule.created, alert_rule.updated, alert_rule.deleted, publish, share. */
|
|
19053
|
+
/** @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, idle_exit, settings_update, handoff_settings_update, translation_settings_update, integration_connect, mcp_tool_call, access_token_retrieved, integration_disconnect, secret_rotate, 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, user_deactivate, user_reactivate, email_send, message_send, teammate_call_started, teammate_call_ended, conference_participant_invited, conference_participant_removed, session_takeover, session_assignee_update, organization_update, ownership_transfer, organization_ai_profile_update, organization_global_variable_delete, update_agent_availability_status, redaction, message_deleted, user_invite_delete, user_invite_resend, user_invite_link_copied, super_invite_link_created, super_invite_link_used, alert_rule.created, alert_rule.updated, alert_rule.deleted, publish, share. */
|
|
18996
19054
|
eventType?: string | string[];
|
|
18997
19055
|
/** @description Repeat to match any of several. */
|
|
18998
19056
|
eventCategory?: ("access" | "agent_availability" | "communication" | "configuration" | "data" | "security") | ("access" | "agent_availability" | "communication" | "configuration" | "data" | "security")[];
|
|
@@ -29901,6 +29959,66 @@ export interface operations {
|
|
|
29901
29959
|
};
|
|
29902
29960
|
};
|
|
29903
29961
|
};
|
|
29962
|
+
deactivateOrgUser: {
|
|
29963
|
+
parameters: {
|
|
29964
|
+
query?: never;
|
|
29965
|
+
header?: never;
|
|
29966
|
+
path: {
|
|
29967
|
+
/** @description Organization user ID */
|
|
29968
|
+
user_id: number;
|
|
29969
|
+
};
|
|
29970
|
+
cookie?: never;
|
|
29971
|
+
};
|
|
29972
|
+
requestBody?: never;
|
|
29973
|
+
responses: {
|
|
29974
|
+
/** @description Default Response */
|
|
29975
|
+
204: {
|
|
29976
|
+
headers: {
|
|
29977
|
+
[name: string]: unknown;
|
|
29978
|
+
};
|
|
29979
|
+
content?: never;
|
|
29980
|
+
};
|
|
29981
|
+
/** @description Internal Server Error */
|
|
29982
|
+
500: {
|
|
29983
|
+
headers: {
|
|
29984
|
+
[name: string]: unknown;
|
|
29985
|
+
};
|
|
29986
|
+
content: {
|
|
29987
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
29988
|
+
};
|
|
29989
|
+
};
|
|
29990
|
+
};
|
|
29991
|
+
};
|
|
29992
|
+
reactivateOrgUser: {
|
|
29993
|
+
parameters: {
|
|
29994
|
+
query?: never;
|
|
29995
|
+
header?: never;
|
|
29996
|
+
path: {
|
|
29997
|
+
/** @description Organization user ID */
|
|
29998
|
+
user_id: number;
|
|
29999
|
+
};
|
|
30000
|
+
cookie?: never;
|
|
30001
|
+
};
|
|
30002
|
+
requestBody?: never;
|
|
30003
|
+
responses: {
|
|
30004
|
+
/** @description Default Response */
|
|
30005
|
+
204: {
|
|
30006
|
+
headers: {
|
|
30007
|
+
[name: string]: unknown;
|
|
30008
|
+
};
|
|
30009
|
+
content?: never;
|
|
30010
|
+
};
|
|
30011
|
+
/** @description Internal Server Error */
|
|
30012
|
+
500: {
|
|
30013
|
+
headers: {
|
|
30014
|
+
[name: string]: unknown;
|
|
30015
|
+
};
|
|
30016
|
+
content: {
|
|
30017
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
30018
|
+
};
|
|
30019
|
+
};
|
|
30020
|
+
};
|
|
30021
|
+
};
|
|
29904
30022
|
batchDeleteOrgUsers: {
|
|
29905
30023
|
parameters: {
|
|
29906
30024
|
query?: never;
|