@sippulse/niva-sdk 0.1.0-rc.8 → 0.1.0
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/dts/src/generated/client.d.ts +59 -7
- package/dts/src/generated/meta.d.ts +1 -1
- package/dts/src/generated/operations.d.ts +1294 -350
- package/dts/src/generated/webhooks.d.ts +24 -1
- package/index.bun.js +272 -173
- package/index.default.js +272 -173
- package/index.deno.js +272 -173
- package/index.node.js +272 -173
- package/package.json +1 -1
|
@@ -10,6 +10,7 @@ export type CallAnalyseId = `ca_${string}`;
|
|
|
10
10
|
export type CallRecordId = `call_${string}`;
|
|
11
11
|
export type CallEventId = `cev_${string}`;
|
|
12
12
|
export type ChannelId = `ch_${string}`;
|
|
13
|
+
export type ConnectorId = `conn_${string}`;
|
|
13
14
|
export type ContactId = `ct_${string}`;
|
|
14
15
|
export type CallTranscriptionId = `ctr_${string}`;
|
|
15
16
|
export type DialerAttemptId = `datt_${string}`;
|
|
@@ -68,7 +69,7 @@ export type AiGetBudgetOutput = {
|
|
|
68
69
|
*
|
|
69
70
|
* Returns the org's current SipPulse AI project budget status (limits and consumption). Requires the ai module and the ai:read scope.
|
|
70
71
|
*/
|
|
71
|
-
export type AiGetBudgetErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
72
|
+
export type AiGetBudgetErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
72
73
|
/**
|
|
73
74
|
* ai.getBudgetOverview input.
|
|
74
75
|
*
|
|
@@ -151,7 +152,7 @@ export type AiGetBudgetOverviewOutput = {
|
|
|
151
152
|
*
|
|
152
153
|
* Returns the current SipPulse AI budget status and percentage-only composition for both budget windows. Breakdown failures are returned as null so the status remains usable. Requires the ai module and the ai:read scope.
|
|
153
154
|
*/
|
|
154
|
-
export type AiGetBudgetOverviewErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
155
|
+
export type AiGetBudgetOverviewErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
155
156
|
/**
|
|
156
157
|
* ai.getCallAnalyses input.
|
|
157
158
|
*
|
|
@@ -215,7 +216,7 @@ export type AiGetCallAnalysesOutput = {
|
|
|
215
216
|
*
|
|
216
217
|
* Returns the custom-analysis results already generated for a call as a plain array (empty when none). Read-only historical data — served even after the AI module is downgraded. Requires the call_record:read scope.
|
|
217
218
|
*/
|
|
218
|
-
export type AiGetCallAnalysesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
219
|
+
export type AiGetCallAnalysesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
219
220
|
/**
|
|
220
221
|
* ai.getTranscription input.
|
|
221
222
|
*
|
|
@@ -242,7 +243,7 @@ export type AiGetTranscriptionOutput = {
|
|
|
242
243
|
id: CallTranscriptionId;
|
|
243
244
|
intent: string | null;
|
|
244
245
|
is_anonymized: boolean;
|
|
245
|
-
key_points
|
|
246
|
+
key_points: string[] | null;
|
|
246
247
|
language: string | null;
|
|
247
248
|
model: string | null;
|
|
248
249
|
range: {
|
|
@@ -261,21 +262,47 @@ export type AiGetTranscriptionOutput = {
|
|
|
261
262
|
start_ms: number;
|
|
262
263
|
to_node: string | null;
|
|
263
264
|
} | null;
|
|
264
|
-
segments
|
|
265
|
-
|
|
266
|
-
|
|
265
|
+
segments: {
|
|
266
|
+
end_time: number;
|
|
267
|
+
initial_time: number;
|
|
268
|
+
speaker: string;
|
|
269
|
+
text: string;
|
|
270
|
+
}[];
|
|
271
|
+
sentiment_overall: {
|
|
272
|
+
label: string;
|
|
273
|
+
score: number;
|
|
274
|
+
} | null;
|
|
275
|
+
sentiment_segments: {
|
|
276
|
+
fragment?: string;
|
|
277
|
+
label: string;
|
|
278
|
+
score: number;
|
|
279
|
+
timestamp?: string;
|
|
280
|
+
}[] | null;
|
|
267
281
|
status: "not_applicable" | "disabled" | "waiting" | "pending" | "processing" | "completed" | "failed" | "skipped" | "purged" | "expired";
|
|
268
282
|
summary: string | null;
|
|
269
|
-
topics
|
|
283
|
+
topics: ({
|
|
284
|
+
confidence: number;
|
|
285
|
+
topic: string;
|
|
286
|
+
} | {
|
|
287
|
+
confidence: number;
|
|
288
|
+
fragment?: string;
|
|
289
|
+
label: string;
|
|
290
|
+
timestamp?: string;
|
|
291
|
+
})[] | null;
|
|
270
292
|
updated_at: string;
|
|
271
|
-
words
|
|
293
|
+
words: {
|
|
294
|
+
end: number;
|
|
295
|
+
speaker: string;
|
|
296
|
+
start: number;
|
|
297
|
+
word: string;
|
|
298
|
+
}[] | null;
|
|
272
299
|
} | null;
|
|
273
300
|
/**
|
|
274
301
|
* ai.getTranscription error codes.
|
|
275
302
|
*
|
|
276
303
|
* Returns the stored transcription for a call (text, segments, language, sentiment, summary and more), or null when none exists. Read-only historical data — served even after the AI module is downgraded. Requires the call_content:read scope.
|
|
277
304
|
*/
|
|
278
|
-
export type AiGetTranscriptionErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
305
|
+
export type AiGetTranscriptionErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
279
306
|
/**
|
|
280
307
|
* ai.getUsage input.
|
|
281
308
|
*
|
|
@@ -309,17 +336,17 @@ export interface AiGetUsageOutput {
|
|
|
309
336
|
*
|
|
310
337
|
* Returns the org's usage metrics for the current billing period (calls, minutes, STT/TTS, LLM and embedding tokens, recording storage, webhook deliveries and peak concurrency). Requires the ai module and the ai:read scope.
|
|
311
338
|
*/
|
|
312
|
-
export type AiGetUsageErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
339
|
+
export type AiGetUsageErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
313
340
|
/**
|
|
314
341
|
* ai.listAgents input.
|
|
315
342
|
*
|
|
316
|
-
* Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
|
|
343
|
+
* Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, with AI_INVALID_API_KEY when SipPulse AI rejects the organization's key, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
|
|
317
344
|
*/
|
|
318
345
|
export type AiListAgentsInput = void;
|
|
319
346
|
/**
|
|
320
347
|
* ai.listAgents output.
|
|
321
348
|
*
|
|
322
|
-
* Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
|
|
349
|
+
* Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, with AI_INVALID_API_KEY when SipPulse AI rejects the organization's key, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
|
|
323
350
|
*/
|
|
324
351
|
export type AiListAgentsOutput = {
|
|
325
352
|
description?: string;
|
|
@@ -334,9 +361,9 @@ export type AiListAgentsOutput = {
|
|
|
334
361
|
/**
|
|
335
362
|
* ai.listAgents error codes.
|
|
336
363
|
*
|
|
337
|
-
* Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
|
|
364
|
+
* Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, with AI_INVALID_API_KEY when SipPulse AI rejects the organization's key, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
|
|
338
365
|
*/
|
|
339
|
-
export type AiListAgentsErrorCode = "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
366
|
+
export type AiListAgentsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
340
367
|
/**
|
|
341
368
|
* ai.listStructuredAnalyses input.
|
|
342
369
|
*
|
|
@@ -387,7 +414,7 @@ export interface AiListStructuredAnalysesOutput {
|
|
|
387
414
|
*
|
|
388
415
|
* Returns the organization-scoped structured-analysis catalog from SipPulse AI. The catalog is cached briefly and a stale copy is returned when the upstream service is unavailable. Set refresh to force a manual refresh.
|
|
389
416
|
*/
|
|
390
|
-
export type AiListStructuredAnalysesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
417
|
+
export type AiListStructuredAnalysesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
391
418
|
/**
|
|
392
419
|
* ai.runAnalysis input.
|
|
393
420
|
*
|
|
@@ -462,7 +489,7 @@ export type AiRunAnalysisOutput = {
|
|
|
462
489
|
*
|
|
463
490
|
* Runs a SipPulse AI structured analysis against the call's transcription and returns the persisted result. The call.analysis_completed webhook contains one item for this manual execution. The legacy templateId input is accepted only during migration. Requires the ai module and the ai:execute scope.
|
|
464
491
|
*/
|
|
465
|
-
export type AiRunAnalysisErrorCode = "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "TRANSCRIPTION_NOT_FOUND" | "UNAUTHORIZED";
|
|
492
|
+
export type AiRunAnalysisErrorCode = "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "TRANSCRIPTION_NOT_FOUND" | "UNAUTHORIZED";
|
|
466
493
|
/**
|
|
467
494
|
* ai.runConfiguredAnalyses input.
|
|
468
495
|
*
|
|
@@ -531,7 +558,7 @@ export type AiRunConfiguredAnalysesOutput = {
|
|
|
531
558
|
*
|
|
532
559
|
* Runs every custom analysis configured by the call's visual plan or organization defaults in parallel, waits for all of them, persists each result independently, and emits one call.analysis_completed webhook containing every completed or failed item. Requires the ai module and the ai:execute scope.
|
|
533
560
|
*/
|
|
534
|
-
export type AiRunConfiguredAnalysesErrorCode = "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "TRANSCRIPTION_NOT_FOUND" | "UNAUTHORIZED";
|
|
561
|
+
export type AiRunConfiguredAnalysesErrorCode = "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "TRANSCRIPTION_NOT_FOUND" | "UNAUTHORIZED";
|
|
535
562
|
/**
|
|
536
563
|
* ai.runSpeechAnalytics input.
|
|
537
564
|
*
|
|
@@ -561,7 +588,7 @@ export interface AiRunSpeechAnalyticsOutput {
|
|
|
561
588
|
*
|
|
562
589
|
* Runs call summary and sentiment over an existing transcription, plus topic and intent classifications for configured legacy lists. Manual execution computes both summary and sentiment regardless of automatic settings. The resulting call.analysis_completed webhook contains one native analysis item, with status completed or failed. Requires the ai module and the ai:execute scope.
|
|
563
590
|
*/
|
|
564
|
-
export type AiRunSpeechAnalyticsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
591
|
+
export type AiRunSpeechAnalyticsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
565
592
|
/**
|
|
566
593
|
* ai.searchTranscriptions input.
|
|
567
594
|
*
|
|
@@ -631,7 +658,7 @@ export type AiSearchTranscriptionsOutput = {
|
|
|
631
658
|
*
|
|
632
659
|
* Semantic (vector) search over call transcriptions. Returns the top matches ranked by similarity (limit top-K, no pagination); results below the similarity threshold are excluded. Optionally scope by date range and visual plan. Requires the ai module, ai:read and call_content:read permissions.
|
|
633
660
|
*/
|
|
634
|
-
export type AiSearchTranscriptionsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
661
|
+
export type AiSearchTranscriptionsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
635
662
|
/**
|
|
636
663
|
* ai.transcribeNow input.
|
|
637
664
|
*
|
|
@@ -668,7 +695,7 @@ export type AiTranscribeNowOutput = {
|
|
|
668
695
|
id: CallTranscriptionId;
|
|
669
696
|
intent: string | null;
|
|
670
697
|
is_anonymized: boolean;
|
|
671
|
-
key_points
|
|
698
|
+
key_points: string[] | null;
|
|
672
699
|
language: string | null;
|
|
673
700
|
model: string | null;
|
|
674
701
|
range: {
|
|
@@ -687,21 +714,47 @@ export type AiTranscribeNowOutput = {
|
|
|
687
714
|
start_ms: number;
|
|
688
715
|
to_node: string | null;
|
|
689
716
|
} | null;
|
|
690
|
-
segments
|
|
691
|
-
|
|
692
|
-
|
|
717
|
+
segments: {
|
|
718
|
+
end_time: number;
|
|
719
|
+
initial_time: number;
|
|
720
|
+
speaker: string;
|
|
721
|
+
text: string;
|
|
722
|
+
}[];
|
|
723
|
+
sentiment_overall: {
|
|
724
|
+
label: string;
|
|
725
|
+
score: number;
|
|
726
|
+
} | null;
|
|
727
|
+
sentiment_segments: {
|
|
728
|
+
fragment?: string;
|
|
729
|
+
label: string;
|
|
730
|
+
score: number;
|
|
731
|
+
timestamp?: string;
|
|
732
|
+
}[] | null;
|
|
693
733
|
status: "not_applicable" | "disabled" | "waiting" | "pending" | "processing" | "completed" | "failed" | "skipped" | "purged" | "expired";
|
|
694
734
|
summary: string | null;
|
|
695
|
-
topics
|
|
735
|
+
topics: ({
|
|
736
|
+
confidence: number;
|
|
737
|
+
topic: string;
|
|
738
|
+
} | {
|
|
739
|
+
confidence: number;
|
|
740
|
+
fragment?: string;
|
|
741
|
+
label: string;
|
|
742
|
+
timestamp?: string;
|
|
743
|
+
})[] | null;
|
|
696
744
|
updated_at: string;
|
|
697
|
-
words
|
|
745
|
+
words: {
|
|
746
|
+
end: number;
|
|
747
|
+
speaker: string;
|
|
748
|
+
start: number;
|
|
749
|
+
word: string;
|
|
750
|
+
}[] | null;
|
|
698
751
|
} | null;
|
|
699
752
|
/**
|
|
700
753
|
* ai.transcribeNow error codes.
|
|
701
754
|
*
|
|
702
755
|
* Transcribes a recorded call on demand and returns the stored text, diarized segments and words. The response status is completed when ASR finishes within the synchronous window, or processing while the transcription continues in the background. An explicit request overrides the plan transcription setting and minimum duration. Pass from_node and/or to_node to transcribe only the stretch of the call between two nodes of the plan, identified by their slug; the response then carries a range block and the cut only ever narrows what the plan already allowed to be transcribed. There is one transcription per call, so a segment run replaces the previous transcript. Requires the ai module, ai:execute and call_content:read permissions.
|
|
703
756
|
*/
|
|
704
|
-
export type AiTranscribeNowErrorCode = "AI_NOT_CONFIGURED" | "CALL_HAS_NO_TRANSCRIPTION_WINDOW" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "NODE_NOT_IN_TRACE" | "NODE_RANGE_INVALID" | "RANGE_HAS_NO_AUDIO" | "RANGE_NOT_APPLICABLE" | "RECORDING_NOT_FOUND" | "UNAUTHORIZED";
|
|
757
|
+
export type AiTranscribeNowErrorCode = "AI_NOT_CONFIGURED" | "CALL_HAS_NO_TRANSCRIPTION_WINDOW" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "NODE_NOT_IN_TRACE" | "NODE_RANGE_INVALID" | "RANGE_HAS_NO_AUDIO" | "RANGE_NOT_APPLICABLE" | "RECORDING_NOT_FOUND" | "TRANSCRIPTION_CAPACITY_EXCEEDED" | "UNAUTHORIZED";
|
|
705
758
|
/**
|
|
706
759
|
* apiKeys.create input.
|
|
707
760
|
*
|
|
@@ -744,7 +797,7 @@ export interface ApiKeysCreateOutput {
|
|
|
744
797
|
*
|
|
745
798
|
* Creates an API key with the given scopes and optional expiry. The response includes plain_key, the full secret shown only once here; store it immediately. Requires the api_key:create scope.
|
|
746
799
|
*/
|
|
747
|
-
export type ApiKeysCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
800
|
+
export type ApiKeysCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
748
801
|
/**
|
|
749
802
|
* apiKeys.finishRotation input.
|
|
750
803
|
*
|
|
@@ -769,7 +822,7 @@ export interface ApiKeysFinishRotationOutput {
|
|
|
769
822
|
*
|
|
770
823
|
* Invalidates the previous API key secret immediately, before its grace period expires. Requires the api_key:revoke scope.
|
|
771
824
|
*/
|
|
772
|
-
export type ApiKeysFinishRotationErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
825
|
+
export type ApiKeysFinishRotationErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
773
826
|
/**
|
|
774
827
|
* apiKeys.get input.
|
|
775
828
|
*
|
|
@@ -804,7 +857,7 @@ export interface ApiKeysGetOutput {
|
|
|
804
857
|
*
|
|
805
858
|
* Fetches one API key's metadata (name, prefix, scopes, timestamps) by id. An unknown or cross-org id returns 404 API_KEY_NOT_FOUND. The secret key material is never exposed. Requires the api_key:read scope.
|
|
806
859
|
*/
|
|
807
|
-
export type ApiKeysGetErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
860
|
+
export type ApiKeysGetErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
808
861
|
/**
|
|
809
862
|
* apiKeys.list input.
|
|
810
863
|
*
|
|
@@ -880,7 +933,7 @@ export interface ApiKeysListOutput {
|
|
|
880
933
|
*
|
|
881
934
|
* Returns the org's API keys as a paginated envelope. Only key metadata (name, prefix, scopes, timestamps) is returned; the secret key material is never exposed after creation. Requires the api_key:read scope.
|
|
882
935
|
*/
|
|
883
|
-
export type ApiKeysListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
936
|
+
export type ApiKeysListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
884
937
|
/**
|
|
885
938
|
* apiKeys.revoke input.
|
|
886
939
|
*
|
|
@@ -905,7 +958,7 @@ export interface ApiKeysRevokeOutput {
|
|
|
905
958
|
*
|
|
906
959
|
* Revokes an API key so it can no longer authenticate, returning { success: true }. An unknown id returns 404 API_KEY_NOT_FOUND. Requires the api_key:revoke scope.
|
|
907
960
|
*/
|
|
908
|
-
export type ApiKeysRevokeErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
961
|
+
export type ApiKeysRevokeErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
909
962
|
/**
|
|
910
963
|
* apiKeys.rotate input.
|
|
911
964
|
*
|
|
@@ -951,7 +1004,7 @@ export interface ApiKeysRotateOutput {
|
|
|
951
1004
|
*
|
|
952
1005
|
* Replaces an API key secret in place, preserving its id, name and scopes. By default the previous secret stops working immediately; an optional grace period keeps it valid for up to 168 hours. Requires the api_key:create scope.
|
|
953
1006
|
*/
|
|
954
|
-
export type ApiKeysRotateErrorCode = "API_KEY_EXPIRED" | "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "SELF_ROTATION_FORBIDDEN" | "UNAUTHORIZED";
|
|
1007
|
+
export type ApiKeysRotateErrorCode = "API_KEY_EXPIRED" | "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "SELF_ROTATION_FORBIDDEN" | "UNAUTHORIZED";
|
|
955
1008
|
/**
|
|
956
1009
|
* apiKeys.update input.
|
|
957
1010
|
*
|
|
@@ -993,7 +1046,7 @@ export interface ApiKeysUpdateOutput {
|
|
|
993
1046
|
*
|
|
994
1047
|
* Changes the key's name and/or scopes. The secret is untouched, and the new values apply to the next request the key makes; use rotate to replace the secret. An unknown or cross-org id returns 404 API_KEY_NOT_FOUND. Requires the api_key:create scope.
|
|
995
1048
|
*/
|
|
996
|
-
export type ApiKeysUpdateErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
1049
|
+
export type ApiKeysUpdateErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
997
1050
|
/**
|
|
998
1051
|
* apiKeys.usage input.
|
|
999
1052
|
*
|
|
@@ -1041,7 +1094,7 @@ export interface ApiKeysUsageOutput {
|
|
|
1041
1094
|
*
|
|
1042
1095
|
* Returns which routes this API key called, how many times per day and when each route was last used, over the last `days` days (1 to 90, default 30). An unknown or cross-org id returns 404 API_KEY_NOT_FOUND. Requires the api_key:read scope.
|
|
1043
1096
|
*/
|
|
1044
|
-
export type ApiKeysUsageErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
1097
|
+
export type ApiKeysUsageErrorCode = "API_KEY_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
1045
1098
|
/**
|
|
1046
1099
|
* archive.listDeleted input.
|
|
1047
1100
|
*
|
|
@@ -1114,7 +1167,7 @@ export interface ArchiveListDeletedOutput {
|
|
|
1114
1167
|
*
|
|
1115
1168
|
* Lists archived (soft-deleted) items of a single `entity_type` in a paginated envelope.
|
|
1116
1169
|
*/
|
|
1117
|
-
export type ArchiveListDeletedErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1170
|
+
export type ArchiveListDeletedErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1118
1171
|
/**
|
|
1119
1172
|
* archive.purge input.
|
|
1120
1173
|
*
|
|
@@ -1143,7 +1196,7 @@ export interface ArchivePurgeOutput {
|
|
|
1143
1196
|
*
|
|
1144
1197
|
* Permanently purges an archived item; this is irreversible. Requires the `archive:purge` permission. Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item does not exist and 409 ARCHIVE_ITEM_IN_USE when the item is still referenced by calls or other records.
|
|
1145
1198
|
*/
|
|
1146
|
-
export type ArchivePurgeErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1199
|
+
export type ArchivePurgeErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1147
1200
|
/**
|
|
1148
1201
|
* archive.restore input.
|
|
1149
1202
|
*
|
|
@@ -1174,7 +1227,7 @@ export interface ArchiveRestoreOutput {
|
|
|
1174
1227
|
*
|
|
1175
1228
|
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the restored channel is unavailable.
|
|
1176
1229
|
*/
|
|
1177
|
-
export type ArchiveRestoreErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1230
|
+
export type ArchiveRestoreErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1178
1231
|
/**
|
|
1179
1232
|
* archive.summary input.
|
|
1180
1233
|
*
|
|
@@ -1195,7 +1248,7 @@ export type ArchiveSummaryOutput = {
|
|
|
1195
1248
|
*
|
|
1196
1249
|
* Returns per-entity-type counts of archived (soft-deleted) items for the organization.
|
|
1197
1250
|
*/
|
|
1198
|
-
export type ArchiveSummaryErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1251
|
+
export type ArchiveSummaryErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1199
1252
|
/**
|
|
1200
1253
|
* audioFiles.content input.
|
|
1201
1254
|
*
|
|
@@ -1212,7 +1265,7 @@ export interface AudioFilesContentInput {
|
|
|
1212
1265
|
*
|
|
1213
1266
|
* Returns the raw audio bytes of the stored file (read into memory in full, not streamed — the library caps files at 10 MB), with the format's media type and the original filename. Supports HTTP Range requests (206 Partial Content) for seeking. Returns 404 AUDIO_FILE_NOT_FOUND when the file does not exist or belongs to another organization, and 404 AUDIO_FILE_CONTENT_MISSING when the record exists but its bytes are gone from storage.
|
|
1214
1267
|
*/
|
|
1215
|
-
export type AudioFilesContentErrorCode = "AUDIO_FILE_CONTENT_MISSING" | "AUDIO_FILE_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
1268
|
+
export type AudioFilesContentErrorCode = "AUDIO_FILE_CONTENT_MISSING" | "AUDIO_FILE_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
1216
1269
|
/**
|
|
1217
1270
|
* audioFiles.delete input.
|
|
1218
1271
|
*
|
|
@@ -1237,7 +1290,7 @@ export interface AudioFilesDeleteOutput {
|
|
|
1237
1290
|
*
|
|
1238
1291
|
* Deletes an audio file. Returns 409 AUDIO_FILE_IN_USE (with the referencing plan names) when the file is still used by one or more plans, and 404 AUDIO_FILE_NOT_FOUND when it does not exist. Returns `{ success: true }` on success.
|
|
1239
1292
|
*/
|
|
1240
|
-
export type AudioFilesDeleteErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1293
|
+
export type AudioFilesDeleteErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1241
1294
|
/**
|
|
1242
1295
|
* audioFiles.generateTts input.
|
|
1243
1296
|
*
|
|
@@ -1321,7 +1374,7 @@ export interface AudioFilesGenerateTtsOutput {
|
|
|
1321
1374
|
*
|
|
1322
1375
|
* Synthesizes speech from the supplied text and stores it as a new TTS audio file. When `voice` and `model` are omitted they are resolved from the organization's language and active provider tier. Returns 422 TTS_VOICE_UNAVAILABLE when no voice is available for that language.
|
|
1323
1376
|
*/
|
|
1324
|
-
export type AudioFilesGenerateTtsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1377
|
+
export type AudioFilesGenerateTtsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1325
1378
|
/**
|
|
1326
1379
|
* audioFiles.getById input.
|
|
1327
1380
|
*
|
|
@@ -1387,7 +1440,7 @@ export type AudioFilesGetByIdOutput = {
|
|
|
1387
1440
|
*
|
|
1388
1441
|
* Returns the audio file, or `null` (HTTP 200) when it does not exist or belongs to another organization.
|
|
1389
1442
|
*/
|
|
1390
|
-
export type AudioFilesGetByIdErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1443
|
+
export type AudioFilesGetByIdErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1391
1444
|
/**
|
|
1392
1445
|
* audioFiles.list input.
|
|
1393
1446
|
*
|
|
@@ -1494,7 +1547,7 @@ export interface AudioFilesListOutput {
|
|
|
1494
1547
|
*
|
|
1495
1548
|
* Returns a paginated list of the organization's audio files (uploaded recordings and TTS-generated clips).
|
|
1496
1549
|
*/
|
|
1497
|
-
export type AudioFilesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
1550
|
+
export type AudioFilesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
1498
1551
|
/**
|
|
1499
1552
|
* audioFiles.previewUrl input.
|
|
1500
1553
|
*
|
|
@@ -1513,7 +1566,7 @@ export interface AudioFilesPreviewUrlInput {
|
|
|
1513
1566
|
*
|
|
1514
1567
|
* Fetches and normalizes a static HTTP(S) audio URL and returns the WAV bytes used for telephony playback.
|
|
1515
1568
|
*/
|
|
1516
|
-
export type AudioFilesPreviewUrlErrorCode = "AUDIO_URL_BLOCKED" | "AUDIO_URL_DECODE_FAILED" | "AUDIO_URL_HTTP_ERROR" | "AUDIO_URL_INVALID" | "AUDIO_URL_TIMEOUT" | "AUDIO_URL_TOO_LARGE" | "AUDIO_URL_UNREACHABLE" | "AUDIO_URL_UNSUPPORTED_FORMAT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
1569
|
+
export type AudioFilesPreviewUrlErrorCode = "AUDIO_URL_BLOCKED" | "AUDIO_URL_DECODE_FAILED" | "AUDIO_URL_HTTP_ERROR" | "AUDIO_URL_INVALID" | "AUDIO_URL_TIMEOUT" | "AUDIO_URL_TOO_LARGE" | "AUDIO_URL_UNREACHABLE" | "AUDIO_URL_UNSUPPORTED_FORMAT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
1517
1570
|
/**
|
|
1518
1571
|
* audioFiles.regenerateTts input.
|
|
1519
1572
|
*
|
|
@@ -1595,7 +1648,7 @@ export interface AudioFilesRegenerateTtsOutput {
|
|
|
1595
1648
|
*
|
|
1596
1649
|
* Re-synthesizes the audio content of an existing TTS audio file, optionally with new text/voice/model. Returns 422 AUDIO_FILE_NOT_TTS when the file was not TTS-generated, 422 TTS_VOICE_UNAVAILABLE when no voice is available, and 404 AUDIO_FILE_NOT_FOUND when it does not exist.
|
|
1597
1650
|
*/
|
|
1598
|
-
export type AudioFilesRegenerateTtsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1651
|
+
export type AudioFilesRegenerateTtsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1599
1652
|
/**
|
|
1600
1653
|
* audioFiles.update input.
|
|
1601
1654
|
*
|
|
@@ -1667,7 +1720,7 @@ export interface AudioFilesUpdateOutput {
|
|
|
1667
1720
|
*
|
|
1668
1721
|
* Updates the audio file's name and/or description only; the audio content itself is not changed. Returns 404 AUDIO_FILE_NOT_FOUND when it does not exist.
|
|
1669
1722
|
*/
|
|
1670
|
-
export type AudioFilesUpdateErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1723
|
+
export type AudioFilesUpdateErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "AUDIO_FILE_IN_USE" | "AUDIO_FILE_NOT_FOUND" | "AUDIO_FILE_NOT_TTS" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
1671
1724
|
/**
|
|
1672
1725
|
* audioFiles.upload input.
|
|
1673
1726
|
*
|
|
@@ -1743,7 +1796,7 @@ export interface AudioFilesUploadOutput {
|
|
|
1743
1796
|
*
|
|
1744
1797
|
* Stores an uploaded audio file (multipart/form-data) in the organization's audio library. Accepts wav, mp3, ogg, flac and m4a up to 10 MB. Returns 400 AUDIO_FILE_INVALID_FORMAT for other extensions and 413 AUDIO_FILE_TOO_LARGE above the size cap.
|
|
1745
1798
|
*/
|
|
1746
|
-
export type AudioFilesUploadErrorCode = "AUDIO_FILE_INVALID_FORMAT" | "AUDIO_FILE_TOO_LARGE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
1799
|
+
export type AudioFilesUploadErrorCode = "AUDIO_FILE_INVALID_FORMAT" | "AUDIO_FILE_TOO_LARGE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
1747
1800
|
/**
|
|
1748
1801
|
* audit.count input.
|
|
1749
1802
|
*
|
|
@@ -1792,7 +1845,7 @@ export interface AuditCountOutput {
|
|
|
1792
1845
|
*
|
|
1793
1846
|
* Returns the exact number of audit-log entries matching the same filters GET /audit-logs accepts, without paging any of them. It exists so a cursor-paginated listing can show a total without paying for count(*) on every page. Requires the enterprise module - callers without it receive 403 MODULE_DISABLED.
|
|
1794
1847
|
*/
|
|
1795
|
-
export type AuditCountErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1848
|
+
export type AuditCountErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1796
1849
|
/**
|
|
1797
1850
|
* audit.exportCsv input.
|
|
1798
1851
|
*
|
|
@@ -1848,7 +1901,7 @@ export interface AuditExportCsvEvent {
|
|
|
1848
1901
|
*
|
|
1849
1902
|
* Streams the matching audit-log entries as Server-Sent Events (`text/event-stream`), one flat JSON object per row - NOT a text/csv file; the caller joins the cells itself. Repeat the multi-valued filters with brackets (`?actions[]=create&actions[]=delete`); a single bracket-less occurrence is read as a string and rejected. Capped at the 100000 most recent entries, and the stream terminates with a done event { emitted, truncated }. Requires the enterprise module - callers without it receive 403 MODULE_DISABLED.
|
|
1850
1903
|
*/
|
|
1851
|
-
export type AuditExportCsvErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1904
|
+
export type AuditExportCsvErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
1852
1905
|
/**
|
|
1853
1906
|
* audit.list input.
|
|
1854
1907
|
*
|
|
@@ -1956,7 +2009,122 @@ export interface AuditListOutput {
|
|
|
1956
2009
|
*
|
|
1957
2010
|
* Lists audit-log entries in a paginated envelope, filterable by action, resource type and date range. A date-only dateFrom/dateTo bound (YYYY-MM-DD) means that calendar day in the organization's timezone, with dateTo fully included; an ISO timestamp is an absolute instant. Deep pages should use keyset pagination: feed next_cursor back as cursor, which ignores page and returns null total/total_pages - ask GET /audit-logs/count for the number. Requires the enterprise module — callers without it receive 403 MODULE_DISABLED.
|
|
1958
2011
|
*/
|
|
1959
|
-
export type AuditListErrorCode = "AUDIT_CURSOR_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
2012
|
+
export type AuditListErrorCode = "AUDIT_CURSOR_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
2013
|
+
/**
|
|
2014
|
+
* bugReports.create input.
|
|
2015
|
+
*
|
|
2016
|
+
* Files a structured problem report. Any member of the organization may report, with no extra permission. The report is rendered as markdown and delivered to the configured sink; the response `reference` identifies the stored record (today the Sentry event id). Answers 409 BUG_REPORTING_DISABLED and sends nothing when error reporting is turned off for the installation.
|
|
2017
|
+
*/
|
|
2018
|
+
export interface BugReportsCreateInput {
|
|
2019
|
+
client_context?: {
|
|
2020
|
+
/**
|
|
2021
|
+
* maxLength: 100
|
|
2022
|
+
*/
|
|
2023
|
+
client_version?: string;
|
|
2024
|
+
failed_requests?: {
|
|
2025
|
+
/**
|
|
2026
|
+
* minLength: 1
|
|
2027
|
+
* maxLength: 64
|
|
2028
|
+
*/
|
|
2029
|
+
at: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* minLength: 1
|
|
2032
|
+
* maxLength: 16
|
|
2033
|
+
*/
|
|
2034
|
+
method: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* minLength: 1
|
|
2037
|
+
* maxLength: 2000
|
|
2038
|
+
*/
|
|
2039
|
+
path: string;
|
|
2040
|
+
/**
|
|
2041
|
+
* minLength: 1
|
|
2042
|
+
* maxLength: 200
|
|
2043
|
+
*/
|
|
2044
|
+
request_id?: string;
|
|
2045
|
+
/**
|
|
2046
|
+
* minimum: -9007199254740991
|
|
2047
|
+
* maximum: 9007199254740991
|
|
2048
|
+
*/
|
|
2049
|
+
status: number;
|
|
2050
|
+
}[];
|
|
2051
|
+
/**
|
|
2052
|
+
* maxLength: 100
|
|
2053
|
+
*/
|
|
2054
|
+
last_event_id?: string;
|
|
2055
|
+
/**
|
|
2056
|
+
* maxLength: 35
|
|
2057
|
+
*/
|
|
2058
|
+
locale?: string;
|
|
2059
|
+
navigation?: string[];
|
|
2060
|
+
recent_errors?: {
|
|
2061
|
+
/**
|
|
2062
|
+
* minLength: 1
|
|
2063
|
+
* maxLength: 64
|
|
2064
|
+
*/
|
|
2065
|
+
at: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* maxLength: 500
|
|
2068
|
+
*/
|
|
2069
|
+
message: string;
|
|
2070
|
+
}[];
|
|
2071
|
+
/**
|
|
2072
|
+
* maxLength: 500
|
|
2073
|
+
*/
|
|
2074
|
+
route?: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* maxLength: 64
|
|
2077
|
+
*/
|
|
2078
|
+
timezone?: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* maxLength: 1000
|
|
2081
|
+
*/
|
|
2082
|
+
user_agent?: string;
|
|
2083
|
+
/**
|
|
2084
|
+
* maxLength: 20
|
|
2085
|
+
*/
|
|
2086
|
+
viewport?: string;
|
|
2087
|
+
};
|
|
2088
|
+
/**
|
|
2089
|
+
* minLength: 10
|
|
2090
|
+
* maxLength: 4000
|
|
2091
|
+
*/
|
|
2092
|
+
description: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* maxLength: 2000
|
|
2095
|
+
*/
|
|
2096
|
+
expected?: string;
|
|
2097
|
+
frequency?: "always" | "sometimes" | "once";
|
|
2098
|
+
resources?: string[];
|
|
2099
|
+
severity: "blocker" | "degraded" | "minor";
|
|
2100
|
+
/**
|
|
2101
|
+
* @default "api"
|
|
2102
|
+
*/
|
|
2103
|
+
source?: "web" | "cli" | "mcp" | "api";
|
|
2104
|
+
/**
|
|
2105
|
+
* maxLength: 4000
|
|
2106
|
+
*/
|
|
2107
|
+
steps?: string;
|
|
2108
|
+
/**
|
|
2109
|
+
* minLength: 3
|
|
2110
|
+
* maxLength: 120
|
|
2111
|
+
*/
|
|
2112
|
+
title: string;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* bugReports.create output.
|
|
2116
|
+
*
|
|
2117
|
+
* Files a structured problem report. Any member of the organization may report, with no extra permission. The report is rendered as markdown and delivered to the configured sink; the response `reference` identifies the stored record (today the Sentry event id). Answers 409 BUG_REPORTING_DISABLED and sends nothing when error reporting is turned off for the installation.
|
|
2118
|
+
*/
|
|
2119
|
+
export interface BugReportsCreateOutput {
|
|
2120
|
+
reference: string;
|
|
2121
|
+
}
|
|
2122
|
+
/**
|
|
2123
|
+
* bugReports.create error codes.
|
|
2124
|
+
*
|
|
2125
|
+
* Files a structured problem report. Any member of the organization may report, with no extra permission. The report is rendered as markdown and delivered to the configured sink; the response `reference` identifies the stored record (today the Sentry event id). Answers 409 BUG_REPORTING_DISABLED and sends nothing when error reporting is turned off for the installation.
|
|
2126
|
+
*/
|
|
2127
|
+
export type BugReportsCreateErrorCode = "BUG_REPORTING_DISABLED" | "BUG_REPORT_DELIVERY_FAILED" | "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
1960
2128
|
/**
|
|
1961
2129
|
* callRecords.count input.
|
|
1962
2130
|
*
|
|
@@ -2079,7 +2247,7 @@ export interface CallRecordsCountOutput {
|
|
|
2079
2247
|
*
|
|
2080
2248
|
* Returns the number of call records matching the same filters GET /call-records accepts, without paging any of them. It exists so a cursor-paginated listing can show a total without paying for count(*) on every page. With a signal filter on the dense path the total stops at 10000 and `total_capped` is true. Requires the call_record:read scope.
|
|
2081
2249
|
*/
|
|
2082
|
-
export type CallRecordsCountErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
2250
|
+
export type CallRecordsCountErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2083
2251
|
/**
|
|
2084
2252
|
* callRecords.exportCsv input.
|
|
2085
2253
|
*
|
|
@@ -2116,6 +2284,21 @@ export interface CallRecordsExportCsvInput {
|
|
|
2116
2284
|
* minLength: 1
|
|
2117
2285
|
*/
|
|
2118
2286
|
signal_value?: string;
|
|
2287
|
+
/**
|
|
2288
|
+
* When set, keep only calls that do (true) or do not (false) have a recording.
|
|
2289
|
+
*/
|
|
2290
|
+
has_recording?: boolean;
|
|
2291
|
+
/**
|
|
2292
|
+
* When set, keep only calls that do (true) or do not (false) have a transcription.
|
|
2293
|
+
*/
|
|
2294
|
+
has_transcription?: boolean;
|
|
2295
|
+
recording_states?: ("not_applicable" | "disabled" | "waiting" | "pending" | "processing" | "completed" | "failed" | "skipped" | "purged" | "expired")[];
|
|
2296
|
+
transcription_states?: ("not_applicable" | "disabled" | "waiting" | "pending" | "processing" | "completed" | "failed" | "skipped" | "purged" | "expired")[];
|
|
2297
|
+
analysis_states?: ("not_applicable" | "disabled" | "waiting" | "pending" | "processing" | "completed" | "failed" | "skipped" | "purged" | "expired")[];
|
|
2298
|
+
/**
|
|
2299
|
+
* When set, keep only calls that did (true) or did not (false) end in an error.
|
|
2300
|
+
*/
|
|
2301
|
+
has_error?: boolean;
|
|
2119
2302
|
has_structured_analysis?: boolean;
|
|
2120
2303
|
has_structured_analysis_error?: boolean;
|
|
2121
2304
|
/**
|
|
@@ -2147,7 +2330,7 @@ export type CallRecordsExportCsvEvent = Record<string, string | number | boolean
|
|
|
2147
2330
|
*
|
|
2148
2331
|
* Streams the matching call records as Server-Sent Events (`text/event-stream`), one JSON object per row - NOT a text/csv file; the separator only tells the UI how to join the cells when it builds the file client-side. Each row carries exactly the requested `columns` keys, plus the per-node event columns when `includeEvents` is true (one row per node visited). Repeat `columns` with brackets to select more than one (`?columns[]=started_at&columns[]=status`); omitting it yields the basic column set. `date_from` and `date_to` are always required and at most 90 days apart, and the scan stops at the 100000 most recent matching calls. The stream terminates with a done event { emitted, truncated }. Metadata filters use exact JSON containment and REST clients send them as `metadata[key]=value`; all supplied pairs must match. Setting `apply_table_filters=false` ignores every other filter and keeps only that window. The SIP transport fields (`sip_call_id`, `remote_addr`, `user_agent`) are not selectable here, matching the omission on `GET /call-records/{call_record_id}`. Requires the call_record:export permission (call_record:read API-key scope).
|
|
2149
2332
|
*/
|
|
2150
|
-
export type CallRecordsExportCsvErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "INVALID_EXPORT_COLUMNS" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
2333
|
+
export type CallRecordsExportCsvErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "INVALID_EXPORT_COLUMNS" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2151
2334
|
/**
|
|
2152
2335
|
* callRecords.getById input.
|
|
2153
2336
|
*
|
|
@@ -2363,7 +2546,7 @@ export type CallRecordsGetByIdOutput = {
|
|
|
2363
2546
|
*
|
|
2364
2547
|
* Fetches a single call record by id, including persisted answer-recognition results. A missing or cross-org id returns 200 with a null body. Sensitive fields (SIP call id, remote address, user agent, raw recording path) are omitted from the output. Requires the call_record:read scope.
|
|
2365
2548
|
*/
|
|
2366
|
-
export type CallRecordsGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
2549
|
+
export type CallRecordsGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2367
2550
|
/**
|
|
2368
2551
|
* callRecords.getEvents input.
|
|
2369
2552
|
*
|
|
@@ -2424,7 +2607,7 @@ export type CallRecordsGetEventsOutput = {
|
|
|
2424
2607
|
*
|
|
2425
2608
|
* Returns the timeline of events for one call as a plain array (naturally bounded, not paginated). An unknown or cross-org call yields an empty array. Requires the call_record:read scope.
|
|
2426
2609
|
*/
|
|
2427
|
-
export type CallRecordsGetEventsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
2610
|
+
export type CallRecordsGetEventsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2428
2611
|
/**
|
|
2429
2612
|
* callRecords.getRecordingUrl input.
|
|
2430
2613
|
*
|
|
@@ -2457,7 +2640,7 @@ export interface CallRecordsGetRecordingUrlOutput {
|
|
|
2457
2640
|
*
|
|
2458
2641
|
* Returns a time-limited signed URL to download the call's recording plus the file name to save it under, or { url: null, filename: null } when the call has no recording or the id is unknown/cross-org. A recording is stored as WAV or as Ogg Opus depending on when it was made, so the extension comes from the stored file and is not always .wav. Requires the call_content:read scope.
|
|
2459
2642
|
*/
|
|
2460
|
-
export type CallRecordsGetRecordingUrlErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
2643
|
+
export type CallRecordsGetRecordingUrlErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2461
2644
|
/**
|
|
2462
2645
|
* callRecords.list input.
|
|
2463
2646
|
*
|
|
@@ -2771,7 +2954,7 @@ export interface CallRecordsListOutput {
|
|
|
2771
2954
|
*
|
|
2772
2955
|
* Returns the org's call records as a paginated envelope. Supports a rich filter set (exact call_record_id TypeID, exact FreeSWITCH channel uuid, exact SIP sip_call_id, date range, plan, channel, status, caller search, duration bounds, recording/transcription/error presence, channel type, dialer vs direct origin and exact metadata containment). The three call identifier filters use equality on their indexed columns and do not use substring search. A date-only date_from/date_to bound (YYYY-MM-DD) means that calendar day in the organization's timezone, with date_to fully included; an ISO timestamp is an absolute instant. Deep pages should use keyset pagination: feed next_cursor back as cursor, which ignores page and returns null total/total_pages - ask GET /call-records/count for the number. Metadata filters require every supplied key/value pair to match; REST clients send them as metadata[key]=value, for example metadata[id_correlacao]=dispatch_482913. Requires the call_record:read scope.
|
|
2773
2956
|
*/
|
|
2774
|
-
export type CallRecordsListErrorCode = "CALL_RECORD_CURSOR_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
2957
|
+
export type CallRecordsListErrorCode = "CALL_RECORD_CURSOR_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2775
2958
|
/**
|
|
2776
2959
|
* callRecords.purgeVoiceContent input.
|
|
2777
2960
|
*
|
|
@@ -2822,7 +3005,7 @@ export interface CallRecordsPurgeVoiceContentOutput {
|
|
|
2822
3005
|
*
|
|
2823
3006
|
* Permanently erases the voice content of a single call (LGPD right to erasure): recording file, transcription and its embeddings. The operational CDR (timings, SIP result, billing, event timeline and opaque metadata) survives and existing analyses are kept but detached from the erased transcription. Do not put personal data in metadata; voice purge does not erase it. Irreversible and idempotent - a repeated purge succeeds with zero counts. Requires the call_record:purge permission and, for API keys, the call_record:write scope. Returns 404 CALL_NOT_FOUND for an unknown or cross-org call.
|
|
2824
3007
|
*/
|
|
2825
|
-
export type CallRecordsPurgeVoiceContentErrorCode = "CALL_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3008
|
+
export type CallRecordsPurgeVoiceContentErrorCode = "CALL_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2826
3009
|
/**
|
|
2827
3010
|
* callRecords.recordingContent input.
|
|
2828
3011
|
*
|
|
@@ -2839,7 +3022,7 @@ export interface CallRecordsRecordingContentInput {
|
|
|
2839
3022
|
*
|
|
2840
3023
|
* Streams the raw audio of the call's recording (uncompressed WAV, commonly hundreds of megabytes for long calls; the bytes are never buffered server-side). Supports HTTP Range requests: a satisfiable `Range` yields 206 Partial Content with `Content-Range`, an unsatisfiable one yields 416 RANGE_NOT_SATISFIABLE with `Content-Range: bytes * /<total>`, and every response advertises `Accept-Ranges: bytes`. Returns 404 CALL_NOT_FOUND when the call is unknown or belongs to another organization, 404 RECORDING_NOT_FOUND when the call was never recorded, and 404 RECORDING_CONTENT_MISSING when the call record points at bytes that are gone from storage. Requires the call_content:read scope.
|
|
2841
3024
|
*/
|
|
2842
|
-
export type CallRecordsRecordingContentErrorCode = "CALL_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "RANGE_NOT_SATISFIABLE" | "RECORDING_CONTENT_MISSING" | "RECORDING_NOT_FOUND" | "UNAUTHORIZED";
|
|
3025
|
+
export type CallRecordsRecordingContentErrorCode = "CALL_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "RANGE_NOT_SATISFIABLE" | "RECORDING_CONTENT_MISSING" | "RECORDING_NOT_FOUND" | "UNAUTHORIZED";
|
|
2843
3026
|
/**
|
|
2844
3027
|
* callRecords.retryRecording input.
|
|
2845
3028
|
*
|
|
@@ -2864,7 +3047,7 @@ export interface CallRecordsRetryRecordingOutput {
|
|
|
2864
3047
|
*
|
|
2865
3048
|
* Requeues a failed voice-recording upload for the engine and returns { success: true }. The action is idempotent while the upload is queued or processing, and does nothing for completed, chat, purged or never-recorded calls. Requires the call_record:export permission.
|
|
2866
3049
|
*/
|
|
2867
|
-
export type CallRecordsRetryRecordingErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3050
|
+
export type CallRecordsRetryRecordingErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2868
3051
|
/**
|
|
2869
3052
|
* calls.hangupCall input.
|
|
2870
3053
|
*
|
|
@@ -2889,7 +3072,7 @@ export interface CallsHangupCallOutput {
|
|
|
2889
3072
|
*
|
|
2890
3073
|
* Ends an active voice or chat call owned by the authenticated organization. The path takes the call TypeID (call_...) - the same call_id returned by originate and carried by the CDRs and the call webhooks. A channel FreeSWITCH no longer knows about is dropped from the live state and reported with stale=true; a hangup the switch refuses answers 502 HANGUP_FAILED and leaves the call untouched. Requires the call:hangup permission and call:write scope.
|
|
2891
3074
|
*/
|
|
2892
|
-
export type CallsHangupCallErrorCode = "ACTIVE_CALL_NOT_FOUND" | "ESL_CONNECTION_ERROR" | "FORBIDDEN" | "HANGUP_FAILED" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3075
|
+
export type CallsHangupCallErrorCode = "ACTIVE_CALL_NOT_FOUND" | "ESL_CONNECTION_ERROR" | "FORBIDDEN" | "HANGUP_FAILED" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
2893
3076
|
/**
|
|
2894
3077
|
* calls.originate input.
|
|
2895
3078
|
*
|
|
@@ -2994,7 +3177,7 @@ export interface CallsOriginateOutput {
|
|
|
2994
3177
|
*
|
|
2995
3178
|
* Places an outbound call that executes a published visual plan and returns its synchronous outcome. A 200 response does not mean the call was answered: read status. When the destination (or the carrier dialect) decides the outcome - any SIP 4xx or 6xx except 401, 403, 407 and 488 - the call answers 200 with status failed plus hangup_cause and sip_code. When the failure is ours - any SIP 5xx, the four codes above, or a failure without a SIP code - it answers 502 ORIGINATE_FAILED; with FreeSWITCH unreachable, 503. The legacy POST /originate/calls shape is deprecated, frozen, and keeps the old allowlist classification. Requires the call:originate scope.
|
|
2996
3179
|
*/
|
|
2997
|
-
export type CallsOriginateErrorCode = "ESL_CONNECTION_ERROR" | "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "ORIGINATE_CAPACITY_EXCEEDED" | "ORIGINATE_DESTINATION_NOT_ROUTABLE" | "ORIGINATE_FAILED" | "ORIGINATE_PLAN_NOT_PUBLISHED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
3180
|
+
export type CallsOriginateErrorCode = "ESL_CONNECTION_ERROR" | "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "ORIGINATE_CAPACITY_EXCEEDED" | "ORIGINATE_DESTINATION_NOT_ROUTABLE" | "ORIGINATE_FAILED" | "ORIGINATE_PLAN_NOT_PUBLISHED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
2998
3181
|
/**
|
|
2999
3182
|
* capabilities.get input.
|
|
3000
3183
|
*
|
|
@@ -3039,11 +3222,11 @@ export interface CapabilitiesGetOutput {
|
|
|
3039
3222
|
*
|
|
3040
3223
|
* Returns the compatibility snapshot SDKs handshake against: the server product and protocol versions, the sorted operationIds of the /api/v1 surface (deprecated operations and the token-authenticated public operations excluded), and per-module enablement for this deployment. Callable by any valid key regardless of its scopes, because every SDK handshakes here first; it exposes only versions, the public operation list and module enablement.
|
|
3041
3224
|
*/
|
|
3042
|
-
export type CapabilitiesGetErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3225
|
+
export type CapabilitiesGetErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3043
3226
|
/**
|
|
3044
3227
|
* channels.create input.
|
|
3045
3228
|
*
|
|
3046
|
-
* Creates a channel of the given type.
|
|
3229
|
+
* Creates a channel of the given type. WhatsApp channels require a `connector_id` that provides `channel.whatsapp`; the connector validates the phone number and supplies the business identity. Telegram credentials are validated against the provider and a webhook is registered as a side effect. A duplicate identifier returns 409 DUPLICATE_CHANNEL. Non-SIP channel types require the omnichannel module.
|
|
3047
3230
|
*/
|
|
3048
3231
|
export interface ChannelsCreateInput {
|
|
3049
3232
|
/**
|
|
@@ -3054,6 +3237,10 @@ export interface ChannelsCreateInput {
|
|
|
3054
3237
|
* Channel-type-specific configuration object (e.g. Telegram bot token, WhatsApp phone number ID); validated against the schema for the given `channel_type`.
|
|
3055
3238
|
*/
|
|
3056
3239
|
config?: Record<string, NivaJsonValue>;
|
|
3240
|
+
/**
|
|
3241
|
+
* TypeID of the connector (conn_...) that owns this channel's account; required for WhatsApp.
|
|
3242
|
+
*/
|
|
3243
|
+
connector_id?: ConnectorId;
|
|
3057
3244
|
description?: string;
|
|
3058
3245
|
/**
|
|
3059
3246
|
* Provider-facing identifier for the channel (e.g. SIP number); must be unique within the organization.
|
|
@@ -3078,7 +3265,7 @@ export interface ChannelsCreateInput {
|
|
|
3078
3265
|
/**
|
|
3079
3266
|
* channels.create output.
|
|
3080
3267
|
*
|
|
3081
|
-
* Creates a channel of the given type.
|
|
3268
|
+
* Creates a channel of the given type. WhatsApp channels require a `connector_id` that provides `channel.whatsapp`; the connector validates the phone number and supplies the business identity. Telegram credentials are validated against the provider and a webhook is registered as a side effect. A duplicate identifier returns 409 DUPLICATE_CHANNEL. Non-SIP channel types require the omnichannel module.
|
|
3082
3269
|
*/
|
|
3083
3270
|
export interface ChannelsCreateOutput {
|
|
3084
3271
|
calls_7d: {
|
|
@@ -3090,6 +3277,7 @@ export interface ChannelsCreateOutput {
|
|
|
3090
3277
|
} | null;
|
|
3091
3278
|
channel_type: string;
|
|
3092
3279
|
config?: NivaJsonValue;
|
|
3280
|
+
connector_id: ConnectorId | null;
|
|
3093
3281
|
created_at: string;
|
|
3094
3282
|
description: string | null;
|
|
3095
3283
|
id: ChannelId;
|
|
@@ -3112,13 +3300,13 @@ export interface ChannelsCreateOutput {
|
|
|
3112
3300
|
/**
|
|
3113
3301
|
* channels.create error codes.
|
|
3114
3302
|
*
|
|
3115
|
-
* Creates a channel of the given type.
|
|
3303
|
+
* Creates a channel of the given type. WhatsApp channels require a `connector_id` that provides `channel.whatsapp`; the connector validates the phone number and supplies the business identity. Telegram credentials are validated against the provider and a webhook is registered as a side effect. A duplicate identifier returns 409 DUPLICATE_CHANNEL. Non-SIP channel types require the omnichannel module.
|
|
3116
3304
|
*/
|
|
3117
|
-
export type ChannelsCreateErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3305
|
+
export type ChannelsCreateErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3118
3306
|
/**
|
|
3119
3307
|
* channels.delete input.
|
|
3120
3308
|
*
|
|
3121
|
-
* Soft-deletes (archives) the channel and runs its type-specific teardown hook (e.g. removing the Telegram webhook). The record is retained so it can later be restored. Returns `{ success: true }`.
|
|
3309
|
+
* Soft-deletes (archives) the channel and runs its type-specific teardown hook (e.g. removing the Telegram webhook, disabling WhatsApp SIP calling through the connector). The record is retained so it can later be restored. Returns `{ success: true }`.
|
|
3122
3310
|
*/
|
|
3123
3311
|
export interface ChannelsDeleteInput {
|
|
3124
3312
|
/**
|
|
@@ -3129,7 +3317,7 @@ export interface ChannelsDeleteInput {
|
|
|
3129
3317
|
/**
|
|
3130
3318
|
* channels.delete output.
|
|
3131
3319
|
*
|
|
3132
|
-
* Soft-deletes (archives) the channel and runs its type-specific teardown hook (e.g. removing the Telegram webhook). The record is retained so it can later be restored. Returns `{ success: true }`.
|
|
3320
|
+
* Soft-deletes (archives) the channel and runs its type-specific teardown hook (e.g. removing the Telegram webhook, disabling WhatsApp SIP calling through the connector). The record is retained so it can later be restored. Returns `{ success: true }`.
|
|
3133
3321
|
*/
|
|
3134
3322
|
export interface ChannelsDeleteOutput {
|
|
3135
3323
|
success: true;
|
|
@@ -3137,9 +3325,9 @@ export interface ChannelsDeleteOutput {
|
|
|
3137
3325
|
/**
|
|
3138
3326
|
* channels.delete error codes.
|
|
3139
3327
|
*
|
|
3140
|
-
* Soft-deletes (archives) the channel and runs its type-specific teardown hook (e.g. removing the Telegram webhook). The record is retained so it can later be restored. Returns `{ success: true }`.
|
|
3328
|
+
* Soft-deletes (archives) the channel and runs its type-specific teardown hook (e.g. removing the Telegram webhook, disabling WhatsApp SIP calling through the connector). The record is retained so it can later be restored. Returns `{ success: true }`.
|
|
3141
3329
|
*/
|
|
3142
|
-
export type ChannelsDeleteErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3330
|
+
export type ChannelsDeleteErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3143
3331
|
/**
|
|
3144
3332
|
* channels.getById input.
|
|
3145
3333
|
*
|
|
@@ -3166,6 +3354,7 @@ export type ChannelsGetByIdOutput = {
|
|
|
3166
3354
|
} | null;
|
|
3167
3355
|
channel_type: string;
|
|
3168
3356
|
config?: NivaJsonValue;
|
|
3357
|
+
connector_id: ConnectorId | null;
|
|
3169
3358
|
created_at: string;
|
|
3170
3359
|
description: string | null;
|
|
3171
3360
|
id: ChannelId;
|
|
@@ -3190,7 +3379,7 @@ export type ChannelsGetByIdOutput = {
|
|
|
3190
3379
|
*
|
|
3191
3380
|
* Returns the channel, or `null` (HTTP 200) when it does not exist or belongs to another organization. Includes `calls_7d`, `last_call_at` (both null without the call_record:read permission), `visual_plan_published_version` and `visual_plan_has_unpublished_changes`. Accessing a non-SIP channel while the omnichannel module is disabled returns 403 MODULE_DISABLED.
|
|
3192
3381
|
*/
|
|
3193
|
-
export type ChannelsGetByIdErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3382
|
+
export type ChannelsGetByIdErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3194
3383
|
/**
|
|
3195
3384
|
* channels.list input.
|
|
3196
3385
|
*
|
|
@@ -3265,6 +3454,7 @@ export interface ChannelsListOutput {
|
|
|
3265
3454
|
} | null;
|
|
3266
3455
|
channel_type: string;
|
|
3267
3456
|
config?: NivaJsonValue;
|
|
3457
|
+
connector_id: ConnectorId | null;
|
|
3268
3458
|
created_at: string;
|
|
3269
3459
|
description: string | null;
|
|
3270
3460
|
id: ChannelId;
|
|
@@ -3306,13 +3496,13 @@ export interface ChannelsListOutput {
|
|
|
3306
3496
|
*
|
|
3307
3497
|
* Returns a paginated list of the organization's channels, optionally filtered by `channel_type`, `is_active` and `alert` (`true` returns only channels with an alert: active channels with no plan, a never-published plan, or a failed WhatsApp webhook sync). `search` also matches the linked plan name. Every item carries `calls_7d` (14 daily buckets plus the 7-day total, null without the call_record:read permission), `last_call_at` (same permission rule), `visual_plan_published_version` (null while never published or unlinked) and `visual_plan_has_unpublished_changes`. The response adds `counts` (`all` plus one entry per channel type with rows, under the current search, ignoring the type/status/alert filters), `active_count` and `alert_count` (same search rule). `sort_by` accepts `calls_7d` (busiest first on desc) and `last_call_at` (most recent first on desc, quiet channels last) whenever calls are visible, otherwise both fall back to `updated_at`. When the omnichannel module is disabled the result is restricted to SIP channels, and requesting a non-SIP `channel_type` returns 403 MODULE_DISABLED.
|
|
3308
3498
|
*/
|
|
3309
|
-
export type ChannelsListErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3499
|
+
export type ChannelsListErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3310
3500
|
/**
|
|
3311
3501
|
* channels.testConnection input.
|
|
3312
3502
|
*
|
|
3313
|
-
* Validates
|
|
3503
|
+
* Validates a Telegram bot token against the provider without creating or modifying any channel. Requires the omnichannel module. Connectivity failures are returned as `{ ok: false, error }` rather than raised as errors.
|
|
3314
3504
|
*/
|
|
3315
|
-
export
|
|
3505
|
+
export interface ChannelsTestConnectionInput {
|
|
3316
3506
|
channel_type: "telegram";
|
|
3317
3507
|
config: {
|
|
3318
3508
|
/**
|
|
@@ -3320,23 +3510,13 @@ export type ChannelsTestConnectionInput = {
|
|
|
3320
3510
|
*/
|
|
3321
3511
|
bot_token: string;
|
|
3322
3512
|
};
|
|
3323
|
-
}
|
|
3324
|
-
channel_type: "whatsapp";
|
|
3325
|
-
config: {
|
|
3326
|
-
/**
|
|
3327
|
-
* minLength: 1
|
|
3328
|
-
*/
|
|
3329
|
-
phone_number_id: string;
|
|
3330
|
-
};
|
|
3331
|
-
};
|
|
3513
|
+
}
|
|
3332
3514
|
/**
|
|
3333
3515
|
* channels.testConnection output.
|
|
3334
3516
|
*
|
|
3335
|
-
* Validates
|
|
3517
|
+
* Validates a Telegram bot token against the provider without creating or modifying any channel. Requires the omnichannel module. Connectivity failures are returned as `{ ok: false, error }` rather than raised as errors.
|
|
3336
3518
|
*/
|
|
3337
3519
|
export interface ChannelsTestConnectionOutput {
|
|
3338
|
-
business_name?: string;
|
|
3339
|
-
display_phone_number?: string;
|
|
3340
3520
|
error?: string;
|
|
3341
3521
|
ok: boolean;
|
|
3342
3522
|
username?: string;
|
|
@@ -3344,9 +3524,9 @@ export interface ChannelsTestConnectionOutput {
|
|
|
3344
3524
|
/**
|
|
3345
3525
|
* channels.testConnection error codes.
|
|
3346
3526
|
*
|
|
3347
|
-
* Validates
|
|
3527
|
+
* Validates a Telegram bot token against the provider without creating or modifying any channel. Requires the omnichannel module. Connectivity failures are returned as `{ ok: false, error }` rather than raised as errors.
|
|
3348
3528
|
*/
|
|
3349
|
-
export type ChannelsTestConnectionErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3529
|
+
export type ChannelsTestConnectionErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3350
3530
|
/**
|
|
3351
3531
|
* channels.toggle input.
|
|
3352
3532
|
*
|
|
@@ -3375,11 +3555,11 @@ export interface ChannelsToggleOutput {
|
|
|
3375
3555
|
*
|
|
3376
3556
|
* Sets the channel's `is_active` flag to the explicit value provided in `is_active` (an absolute set, not a relative flip). Returns `{ success: true }`.
|
|
3377
3557
|
*/
|
|
3378
|
-
export type ChannelsToggleErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3558
|
+
export type ChannelsToggleErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3379
3559
|
/**
|
|
3380
3560
|
* channels.update input.
|
|
3381
3561
|
*
|
|
3382
|
-
* Partially updates a channel. Moving a channel that is already attached to a different plan returns 409 CHANNEL_ALREADY_ASSIGNED unless `reassign` is `true`. Changing WhatsApp
|
|
3562
|
+
* Partially updates a channel. Moving a channel that is already attached to a different plan returns 409 CHANNEL_ALREADY_ASSIGNED unless `reassign` is `true`. Changing a WhatsApp channel's connector or phone number re-validates the number against the connector.
|
|
3383
3563
|
*/
|
|
3384
3564
|
export interface ChannelsUpdateInput {
|
|
3385
3565
|
/**
|
|
@@ -3390,6 +3570,10 @@ export interface ChannelsUpdateInput {
|
|
|
3390
3570
|
* Channel-type-specific configuration object; merged with the existing configuration.
|
|
3391
3571
|
*/
|
|
3392
3572
|
config?: Record<string, NivaJsonValue>;
|
|
3573
|
+
/**
|
|
3574
|
+
* TypeID of the connector (conn_...) that owns this channel's account; only valid on WhatsApp channels.
|
|
3575
|
+
*/
|
|
3576
|
+
connector_id?: ConnectorId;
|
|
3393
3577
|
description?: string;
|
|
3394
3578
|
/**
|
|
3395
3579
|
* maxLength: 255
|
|
@@ -3411,7 +3595,7 @@ export interface ChannelsUpdateInput {
|
|
|
3411
3595
|
/**
|
|
3412
3596
|
* channels.update output.
|
|
3413
3597
|
*
|
|
3414
|
-
* Partially updates a channel. Moving a channel that is already attached to a different plan returns 409 CHANNEL_ALREADY_ASSIGNED unless `reassign` is `true`. Changing WhatsApp
|
|
3598
|
+
* Partially updates a channel. Moving a channel that is already attached to a different plan returns 409 CHANNEL_ALREADY_ASSIGNED unless `reassign` is `true`. Changing a WhatsApp channel's connector or phone number re-validates the number against the connector.
|
|
3415
3599
|
*/
|
|
3416
3600
|
export interface ChannelsUpdateOutput {
|
|
3417
3601
|
calls_7d: {
|
|
@@ -3423,6 +3607,7 @@ export interface ChannelsUpdateOutput {
|
|
|
3423
3607
|
} | null;
|
|
3424
3608
|
channel_type: string;
|
|
3425
3609
|
config?: NivaJsonValue;
|
|
3610
|
+
connector_id: ConnectorId | null;
|
|
3426
3611
|
created_at: string;
|
|
3427
3612
|
description: string | null;
|
|
3428
3613
|
id: ChannelId;
|
|
@@ -3445,9 +3630,9 @@ export interface ChannelsUpdateOutput {
|
|
|
3445
3630
|
/**
|
|
3446
3631
|
* channels.update error codes.
|
|
3447
3632
|
*
|
|
3448
|
-
* Partially updates a channel. Moving a channel that is already attached to a different plan returns 409 CHANNEL_ALREADY_ASSIGNED unless `reassign` is `true`. Changing WhatsApp
|
|
3633
|
+
* Partially updates a channel. Moving a channel that is already attached to a different plan returns 409 CHANNEL_ALREADY_ASSIGNED unless `reassign` is `true`. Changing a WhatsApp channel's connector or phone number re-validates the number against the connector.
|
|
3449
3634
|
*/
|
|
3450
|
-
export type ChannelsUpdateErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "
|
|
3635
|
+
export type ChannelsUpdateErrorCode = "CHANNEL_ALREADY_ASSIGNED" | "CHANNEL_CONNECTOR_NOT_ALLOWED" | "CHANNEL_CONNECTOR_REQUIRED" | "CHANNEL_CONNECTOR_UNAVAILABLE" | "CHANNEL_INVALID_CREDENTIALS" | "CHANNEL_NOT_FOUND" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "DUPLICATE_CHANNEL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3451
3636
|
/**
|
|
3452
3637
|
* contacts.getById input.
|
|
3453
3638
|
*
|
|
@@ -3478,7 +3663,7 @@ export type ContactsGetByIdOutput = {
|
|
|
3478
3663
|
*
|
|
3479
3664
|
* Returns the contact, or `null` (HTTP 200) when it does not exist or belongs to another organization. Requires the omnichannel module.
|
|
3480
3665
|
*/
|
|
3481
|
-
export type ContactsGetByIdErrorCode = "CONTACT_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3666
|
+
export type ContactsGetByIdErrorCode = "CONTACT_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3482
3667
|
/**
|
|
3483
3668
|
* contacts.list input.
|
|
3484
3669
|
*
|
|
@@ -3550,7 +3735,7 @@ export interface ContactsListOutput {
|
|
|
3550
3735
|
*
|
|
3551
3736
|
* Returns a paginated list of the organization's omnichannel contacts. Requires the omnichannel module, otherwise 403 MODULE_DISABLED is returned.
|
|
3552
3737
|
*/
|
|
3553
|
-
export type ContactsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3738
|
+
export type ContactsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3554
3739
|
/**
|
|
3555
3740
|
* contacts.update input.
|
|
3556
3741
|
*
|
|
@@ -3596,7 +3781,7 @@ export interface ContactsUpdateOutput {
|
|
|
3596
3781
|
*
|
|
3597
3782
|
* Partially updates a contact's profile fields. Requires the omnichannel module, and returns 404 CONTACT_NOT_FOUND when the contact does not exist or belongs to another organization.
|
|
3598
3783
|
*/
|
|
3599
|
-
export type ContactsUpdateErrorCode = "CONTACT_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3784
|
+
export type ContactsUpdateErrorCode = "CONTACT_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
3600
3785
|
/**
|
|
3601
3786
|
* dashboard.capacityStatus input.
|
|
3602
3787
|
*
|
|
@@ -3657,7 +3842,7 @@ export interface DashboardCapacityStatusOutput {
|
|
|
3657
3842
|
*
|
|
3658
3843
|
* Returns a live capacity snapshot for the organization, computed on demand from active sessions (Redis) and license/usage data (DB): voice and chat channel pools against their concurrent limits, license status, and — when the AI module is enabled — current STT/TTS/LLM usage against the monthly grant.
|
|
3659
3844
|
*/
|
|
3660
|
-
export type DashboardCapacityStatusErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3845
|
+
export type DashboardCapacityStatusErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3661
3846
|
/**
|
|
3662
3847
|
* dashboard.watchDashboardMetrics input.
|
|
3663
3848
|
*
|
|
@@ -3718,7 +3903,7 @@ export interface DashboardWatchDashboardMetricsEvent {
|
|
|
3718
3903
|
*
|
|
3719
3904
|
* Server-Sent Events stream of the organization's capacity snapshot. The first event is always a full snapshot of the current state, and every later event carries the whole state too rather than a delta — so reconnecting is safe and never loses ground. The response advertises a 5s reconnect delay, and capacity is re-emitted after 30s of silence so a dropped update self-heals.
|
|
3720
3905
|
*/
|
|
3721
|
-
export type DashboardWatchDashboardMetricsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3906
|
+
export type DashboardWatchDashboardMetricsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3722
3907
|
/**
|
|
3723
3908
|
* destinations.create input.
|
|
3724
3909
|
*
|
|
@@ -3768,7 +3953,7 @@ export interface DestinationsCreateOutput {
|
|
|
3768
3953
|
*
|
|
3769
3954
|
* Creates a transfer destination pointing at a SIP/telephony `uri` that plans can forward calls to.
|
|
3770
3955
|
*/
|
|
3771
|
-
export type DestinationsCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3956
|
+
export type DestinationsCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3772
3957
|
/**
|
|
3773
3958
|
* destinations.delete input.
|
|
3774
3959
|
*
|
|
@@ -3793,7 +3978,7 @@ export interface DestinationsDeleteOutput {
|
|
|
3793
3978
|
*
|
|
3794
3979
|
* Deletes a destination. Returns 404 DESTINATION_NOT_FOUND when it does not exist, and `{ success: true }` on success.
|
|
3795
3980
|
*/
|
|
3796
|
-
export type DestinationsDeleteErrorCode = "DESTINATION_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
3981
|
+
export type DestinationsDeleteErrorCode = "DESTINATION_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3797
3982
|
/**
|
|
3798
3983
|
* destinations.getById input.
|
|
3799
3984
|
*
|
|
@@ -3830,7 +4015,7 @@ export type DestinationsGetByIdOutput = {
|
|
|
3830
4015
|
*
|
|
3831
4016
|
* Returns the destination, or `null` (HTTP 200) when it does not exist or belongs to another organization.
|
|
3832
4017
|
*/
|
|
3833
|
-
export type DestinationsGetByIdErrorCode = "DESTINATION_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
4018
|
+
export type DestinationsGetByIdErrorCode = "DESTINATION_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3834
4019
|
/**
|
|
3835
4020
|
* destinations.list input.
|
|
3836
4021
|
*
|
|
@@ -3908,7 +4093,7 @@ export interface DestinationsListOutput {
|
|
|
3908
4093
|
*
|
|
3909
4094
|
* Returns a paginated list of the organization's transfer destinations (call-forwarding targets).
|
|
3910
4095
|
*/
|
|
3911
|
-
export type DestinationsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
4096
|
+
export type DestinationsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3912
4097
|
/**
|
|
3913
4098
|
* destinations.update input.
|
|
3914
4099
|
*
|
|
@@ -3962,7 +4147,7 @@ export interface DestinationsUpdateOutput {
|
|
|
3962
4147
|
*
|
|
3963
4148
|
* Partially updates a destination. Returns 404 DESTINATION_NOT_FOUND when it does not exist or belongs to another organization.
|
|
3964
4149
|
*/
|
|
3965
|
-
export type DestinationsUpdateErrorCode = "DESTINATION_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
4150
|
+
export type DestinationsUpdateErrorCode = "DESTINATION_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
3966
4151
|
/**
|
|
3967
4152
|
* dialerAttempts.list input.
|
|
3968
4153
|
*
|
|
@@ -4079,7 +4264,7 @@ export interface DialerAttemptsListOutput {
|
|
|
4079
4264
|
*
|
|
4080
4265
|
* Returns the read-only call-attempt history for a campaign as a paginated envelope. Optionally filter by attempt status, by a single contact, and by a creation-time window (dateFrom is inclusive; a YYYY-MM-DD bound means that calendar day in the organization timezone, so a YYYY-MM-DD dateTo includes that whole local day, while an ISO timestamp is an absolute instant and dateTo stops there, excluding it). Each row includes the joined contact phone number and name (null if the contact row was removed), machine_type on an attempt a recording answered, and call_record_id, the call report the attempt produced (null when no record was written).
|
|
4081
4266
|
*/
|
|
4082
|
-
export type DialerAttemptsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4267
|
+
export type DialerAttemptsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4083
4268
|
/**
|
|
4084
4269
|
* dialerCampaigns.control input.
|
|
4085
4270
|
*
|
|
@@ -4205,6 +4390,56 @@ export interface DialerCampaignsControlOutput {
|
|
|
4205
4390
|
retry_on_failed: boolean;
|
|
4206
4391
|
retry_on_machine: boolean;
|
|
4207
4392
|
retry_on_no_answer: boolean;
|
|
4393
|
+
retry_rules: {
|
|
4394
|
+
busy?: {
|
|
4395
|
+
/**
|
|
4396
|
+
* minimum: 1
|
|
4397
|
+
* maximum: 10080
|
|
4398
|
+
*/
|
|
4399
|
+
interval_min?: number;
|
|
4400
|
+
/**
|
|
4401
|
+
* minimum: 0
|
|
4402
|
+
* maximum: 100
|
|
4403
|
+
*/
|
|
4404
|
+
max_attempts?: number;
|
|
4405
|
+
};
|
|
4406
|
+
failed?: {
|
|
4407
|
+
/**
|
|
4408
|
+
* minimum: 1
|
|
4409
|
+
* maximum: 10080
|
|
4410
|
+
*/
|
|
4411
|
+
interval_min?: number;
|
|
4412
|
+
/**
|
|
4413
|
+
* minimum: 0
|
|
4414
|
+
* maximum: 100
|
|
4415
|
+
*/
|
|
4416
|
+
max_attempts?: number;
|
|
4417
|
+
};
|
|
4418
|
+
machine?: {
|
|
4419
|
+
/**
|
|
4420
|
+
* minimum: 1
|
|
4421
|
+
* maximum: 10080
|
|
4422
|
+
*/
|
|
4423
|
+
interval_min?: number;
|
|
4424
|
+
/**
|
|
4425
|
+
* minimum: 0
|
|
4426
|
+
* maximum: 100
|
|
4427
|
+
*/
|
|
4428
|
+
max_attempts?: number;
|
|
4429
|
+
};
|
|
4430
|
+
no_answer?: {
|
|
4431
|
+
/**
|
|
4432
|
+
* minimum: 1
|
|
4433
|
+
* maximum: 10080
|
|
4434
|
+
*/
|
|
4435
|
+
interval_min?: number;
|
|
4436
|
+
/**
|
|
4437
|
+
* minimum: 0
|
|
4438
|
+
* maximum: 100
|
|
4439
|
+
*/
|
|
4440
|
+
max_attempts?: number;
|
|
4441
|
+
};
|
|
4442
|
+
} | null;
|
|
4208
4443
|
/**
|
|
4209
4444
|
* minimum: -2147483648
|
|
4210
4445
|
* maximum: 2147483647
|
|
@@ -4235,7 +4470,7 @@ export interface DialerCampaignsControlOutput {
|
|
|
4235
4470
|
*
|
|
4236
4471
|
* Drives the campaign state machine. Valid transitions: start (draft/scheduled/finished -> running, or -> scheduled when a future auto_start_at is armed), pause (running -> paused), resume (paused -> running), stop (draft/scheduled/running/paused -> finished, cancelling pending retries). Invalid transitions return 409 DIALER_CAMPAIGN_INVALID_TRANSITION. start and resume additionally require the dialer module enabled (403 DIALER_MODULE_DISABLED), a published plan (422 DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED) and at least one pending contact (422 DIALER_CAMPAIGN_NO_CONTACTS).
|
|
4237
4472
|
*/
|
|
4238
|
-
export type DialerCampaignsControlErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4473
|
+
export type DialerCampaignsControlErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4239
4474
|
/**
|
|
4240
4475
|
* dialerCampaigns.create input.
|
|
4241
4476
|
*
|
|
@@ -4307,6 +4542,56 @@ export interface DialerCampaignsCreateInput {
|
|
|
4307
4542
|
retry_on_failed?: boolean;
|
|
4308
4543
|
retry_on_machine?: boolean;
|
|
4309
4544
|
retry_on_no_answer?: boolean;
|
|
4545
|
+
retry_rules?: {
|
|
4546
|
+
busy?: {
|
|
4547
|
+
/**
|
|
4548
|
+
* minimum: 1
|
|
4549
|
+
* maximum: 10080
|
|
4550
|
+
*/
|
|
4551
|
+
interval_min?: number;
|
|
4552
|
+
/**
|
|
4553
|
+
* minimum: 0
|
|
4554
|
+
* maximum: 100
|
|
4555
|
+
*/
|
|
4556
|
+
max_attempts?: number;
|
|
4557
|
+
};
|
|
4558
|
+
failed?: {
|
|
4559
|
+
/**
|
|
4560
|
+
* minimum: 1
|
|
4561
|
+
* maximum: 10080
|
|
4562
|
+
*/
|
|
4563
|
+
interval_min?: number;
|
|
4564
|
+
/**
|
|
4565
|
+
* minimum: 0
|
|
4566
|
+
* maximum: 100
|
|
4567
|
+
*/
|
|
4568
|
+
max_attempts?: number;
|
|
4569
|
+
};
|
|
4570
|
+
machine?: {
|
|
4571
|
+
/**
|
|
4572
|
+
* minimum: 1
|
|
4573
|
+
* maximum: 10080
|
|
4574
|
+
*/
|
|
4575
|
+
interval_min?: number;
|
|
4576
|
+
/**
|
|
4577
|
+
* minimum: 0
|
|
4578
|
+
* maximum: 100
|
|
4579
|
+
*/
|
|
4580
|
+
max_attempts?: number;
|
|
4581
|
+
};
|
|
4582
|
+
no_answer?: {
|
|
4583
|
+
/**
|
|
4584
|
+
* minimum: 1
|
|
4585
|
+
* maximum: 10080
|
|
4586
|
+
*/
|
|
4587
|
+
interval_min?: number;
|
|
4588
|
+
/**
|
|
4589
|
+
* minimum: 0
|
|
4590
|
+
* maximum: 100
|
|
4591
|
+
*/
|
|
4592
|
+
max_attempts?: number;
|
|
4593
|
+
};
|
|
4594
|
+
} | null;
|
|
4310
4595
|
/**
|
|
4311
4596
|
* minimum: 5
|
|
4312
4597
|
* maximum: 300
|
|
@@ -4428,6 +4713,56 @@ export interface DialerCampaignsCreateOutput {
|
|
|
4428
4713
|
retry_on_failed: boolean;
|
|
4429
4714
|
retry_on_machine: boolean;
|
|
4430
4715
|
retry_on_no_answer: boolean;
|
|
4716
|
+
retry_rules: {
|
|
4717
|
+
busy?: {
|
|
4718
|
+
/**
|
|
4719
|
+
* minimum: 1
|
|
4720
|
+
* maximum: 10080
|
|
4721
|
+
*/
|
|
4722
|
+
interval_min?: number;
|
|
4723
|
+
/**
|
|
4724
|
+
* minimum: 0
|
|
4725
|
+
* maximum: 100
|
|
4726
|
+
*/
|
|
4727
|
+
max_attempts?: number;
|
|
4728
|
+
};
|
|
4729
|
+
failed?: {
|
|
4730
|
+
/**
|
|
4731
|
+
* minimum: 1
|
|
4732
|
+
* maximum: 10080
|
|
4733
|
+
*/
|
|
4734
|
+
interval_min?: number;
|
|
4735
|
+
/**
|
|
4736
|
+
* minimum: 0
|
|
4737
|
+
* maximum: 100
|
|
4738
|
+
*/
|
|
4739
|
+
max_attempts?: number;
|
|
4740
|
+
};
|
|
4741
|
+
machine?: {
|
|
4742
|
+
/**
|
|
4743
|
+
* minimum: 1
|
|
4744
|
+
* maximum: 10080
|
|
4745
|
+
*/
|
|
4746
|
+
interval_min?: number;
|
|
4747
|
+
/**
|
|
4748
|
+
* minimum: 0
|
|
4749
|
+
* maximum: 100
|
|
4750
|
+
*/
|
|
4751
|
+
max_attempts?: number;
|
|
4752
|
+
};
|
|
4753
|
+
no_answer?: {
|
|
4754
|
+
/**
|
|
4755
|
+
* minimum: 1
|
|
4756
|
+
* maximum: 10080
|
|
4757
|
+
*/
|
|
4758
|
+
interval_min?: number;
|
|
4759
|
+
/**
|
|
4760
|
+
* minimum: 0
|
|
4761
|
+
* maximum: 100
|
|
4762
|
+
*/
|
|
4763
|
+
max_attempts?: number;
|
|
4764
|
+
};
|
|
4765
|
+
} | null;
|
|
4431
4766
|
/**
|
|
4432
4767
|
* minimum: -2147483648
|
|
4433
4768
|
* maximum: 2147483647
|
|
@@ -4458,7 +4793,7 @@ export interface DialerCampaignsCreateOutput {
|
|
|
4458
4793
|
*
|
|
4459
4794
|
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope.
|
|
4460
4795
|
*/
|
|
4461
|
-
export type DialerCampaignsCreateErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
4796
|
+
export type DialerCampaignsCreateErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
4462
4797
|
/**
|
|
4463
4798
|
* dialerCampaigns.delete input.
|
|
4464
4799
|
*
|
|
@@ -4483,7 +4818,7 @@ export interface DialerCampaignsDeleteOutput {
|
|
|
4483
4818
|
*
|
|
4484
4819
|
* Soft-deletes a campaign. Running, paused, or scheduled campaigns must be stopped first and otherwise return 409 DIALER_CAMPAIGN_INVALID_TRANSITION; an unknown id returns 404. Requires the dialer_campaign:delete scope.
|
|
4485
4820
|
*/
|
|
4486
|
-
export type DialerCampaignsDeleteErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4821
|
+
export type DialerCampaignsDeleteErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4487
4822
|
/**
|
|
4488
4823
|
* dialerCampaigns.get input.
|
|
4489
4824
|
*
|
|
@@ -4605,6 +4940,56 @@ export type DialerCampaignsGetOutput = {
|
|
|
4605
4940
|
retry_on_failed: boolean;
|
|
4606
4941
|
retry_on_machine: boolean;
|
|
4607
4942
|
retry_on_no_answer: boolean;
|
|
4943
|
+
retry_rules: {
|
|
4944
|
+
busy?: {
|
|
4945
|
+
/**
|
|
4946
|
+
* minimum: 1
|
|
4947
|
+
* maximum: 10080
|
|
4948
|
+
*/
|
|
4949
|
+
interval_min?: number;
|
|
4950
|
+
/**
|
|
4951
|
+
* minimum: 0
|
|
4952
|
+
* maximum: 100
|
|
4953
|
+
*/
|
|
4954
|
+
max_attempts?: number;
|
|
4955
|
+
};
|
|
4956
|
+
failed?: {
|
|
4957
|
+
/**
|
|
4958
|
+
* minimum: 1
|
|
4959
|
+
* maximum: 10080
|
|
4960
|
+
*/
|
|
4961
|
+
interval_min?: number;
|
|
4962
|
+
/**
|
|
4963
|
+
* minimum: 0
|
|
4964
|
+
* maximum: 100
|
|
4965
|
+
*/
|
|
4966
|
+
max_attempts?: number;
|
|
4967
|
+
};
|
|
4968
|
+
machine?: {
|
|
4969
|
+
/**
|
|
4970
|
+
* minimum: 1
|
|
4971
|
+
* maximum: 10080
|
|
4972
|
+
*/
|
|
4973
|
+
interval_min?: number;
|
|
4974
|
+
/**
|
|
4975
|
+
* minimum: 0
|
|
4976
|
+
* maximum: 100
|
|
4977
|
+
*/
|
|
4978
|
+
max_attempts?: number;
|
|
4979
|
+
};
|
|
4980
|
+
no_answer?: {
|
|
4981
|
+
/**
|
|
4982
|
+
* minimum: 1
|
|
4983
|
+
* maximum: 10080
|
|
4984
|
+
*/
|
|
4985
|
+
interval_min?: number;
|
|
4986
|
+
/**
|
|
4987
|
+
* minimum: 0
|
|
4988
|
+
* maximum: 100
|
|
4989
|
+
*/
|
|
4990
|
+
max_attempts?: number;
|
|
4991
|
+
};
|
|
4992
|
+
} | null;
|
|
4608
4993
|
/**
|
|
4609
4994
|
* minimum: -2147483648
|
|
4610
4995
|
* maximum: 2147483647
|
|
@@ -4635,7 +5020,7 @@ export type DialerCampaignsGetOutput = {
|
|
|
4635
5020
|
*
|
|
4636
5021
|
* Fetches a single campaign by id. A missing or cross-org id returns 200 with a null body rather than 404, so it never reveals whether an id exists in another org.
|
|
4637
5022
|
*/
|
|
4638
|
-
export type DialerCampaignsGetErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5023
|
+
export type DialerCampaignsGetErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4639
5024
|
/**
|
|
4640
5025
|
* dialerCampaigns.list input.
|
|
4641
5026
|
*
|
|
@@ -4785,6 +5170,56 @@ export interface DialerCampaignsListOutput {
|
|
|
4785
5170
|
retry_on_failed: boolean;
|
|
4786
5171
|
retry_on_machine: boolean;
|
|
4787
5172
|
retry_on_no_answer: boolean;
|
|
5173
|
+
retry_rules: {
|
|
5174
|
+
busy?: {
|
|
5175
|
+
/**
|
|
5176
|
+
* minimum: 1
|
|
5177
|
+
* maximum: 10080
|
|
5178
|
+
*/
|
|
5179
|
+
interval_min?: number;
|
|
5180
|
+
/**
|
|
5181
|
+
* minimum: 0
|
|
5182
|
+
* maximum: 100
|
|
5183
|
+
*/
|
|
5184
|
+
max_attempts?: number;
|
|
5185
|
+
};
|
|
5186
|
+
failed?: {
|
|
5187
|
+
/**
|
|
5188
|
+
* minimum: 1
|
|
5189
|
+
* maximum: 10080
|
|
5190
|
+
*/
|
|
5191
|
+
interval_min?: number;
|
|
5192
|
+
/**
|
|
5193
|
+
* minimum: 0
|
|
5194
|
+
* maximum: 100
|
|
5195
|
+
*/
|
|
5196
|
+
max_attempts?: number;
|
|
5197
|
+
};
|
|
5198
|
+
machine?: {
|
|
5199
|
+
/**
|
|
5200
|
+
* minimum: 1
|
|
5201
|
+
* maximum: 10080
|
|
5202
|
+
*/
|
|
5203
|
+
interval_min?: number;
|
|
5204
|
+
/**
|
|
5205
|
+
* minimum: 0
|
|
5206
|
+
* maximum: 100
|
|
5207
|
+
*/
|
|
5208
|
+
max_attempts?: number;
|
|
5209
|
+
};
|
|
5210
|
+
no_answer?: {
|
|
5211
|
+
/**
|
|
5212
|
+
* minimum: 1
|
|
5213
|
+
* maximum: 10080
|
|
5214
|
+
*/
|
|
5215
|
+
interval_min?: number;
|
|
5216
|
+
/**
|
|
5217
|
+
* minimum: 0
|
|
5218
|
+
* maximum: 100
|
|
5219
|
+
*/
|
|
5220
|
+
max_attempts?: number;
|
|
5221
|
+
};
|
|
5222
|
+
} | null;
|
|
4788
5223
|
/**
|
|
4789
5224
|
* minimum: -2147483648
|
|
4790
5225
|
* maximum: 2147483647
|
|
@@ -4832,7 +5267,7 @@ export interface DialerCampaignsListOutput {
|
|
|
4832
5267
|
*
|
|
4833
5268
|
* Returns the org's dialer campaigns as a paginated envelope. Optionally filter by lifecycle status; page, limit, sort_by, sort_order and search follow the standard list contract.
|
|
4834
5269
|
*/
|
|
4835
|
-
export type DialerCampaignsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5270
|
+
export type DialerCampaignsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4836
5271
|
/**
|
|
4837
5272
|
* dialerCampaigns.liveStats input.
|
|
4838
5273
|
*
|
|
@@ -4881,7 +5316,7 @@ export interface DialerCampaignsLiveStatsEvent {
|
|
|
4881
5316
|
*
|
|
4882
5317
|
* Server-Sent Events stream of one campaign's live statistics. The first event is always a full snapshot of the current state, and every later event carries the whole state too rather than a delta — so reconnecting is safe and never loses ground. The response advertises a 5s reconnect delay. An unknown or cross-org id returns 404 DIALER_CAMPAIGN_NOT_FOUND before the stream opens.
|
|
4883
5318
|
*/
|
|
4884
|
-
export type DialerCampaignsLiveStatsErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5319
|
+
export type DialerCampaignsLiveStatsErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4885
5320
|
/**
|
|
4886
5321
|
* dialerCampaigns.orgLiveStats input.
|
|
4887
5322
|
*
|
|
@@ -4925,7 +5360,7 @@ export interface DialerCampaignsOrgLiveStatsEvent {
|
|
|
4925
5360
|
*
|
|
4926
5361
|
* Server-Sent Events stream of live statistics for the org's running and paused campaigns, one event per campaign. It opens with a full snapshot of the current state, and every later event carries a campaign's whole state rather than a delta — so reconnecting is safe and never loses ground. The response advertises a 5s reconnect delay.
|
|
4927
5362
|
*/
|
|
4928
|
-
export type DialerCampaignsOrgLiveStatsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5363
|
+
export type DialerCampaignsOrgLiveStatsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
4929
5364
|
/**
|
|
4930
5365
|
* dialerCampaigns.stats input.
|
|
4931
5366
|
*
|
|
@@ -5008,7 +5443,7 @@ export interface DialerCampaignsStatsOutput {
|
|
|
5008
5443
|
*
|
|
5009
5444
|
* Returns the campaign's cumulative call-outcome counters (answered, machine, busy, no-answer, failed, DNC-skipped, cancelled) plus live pending and calling counts. The machine counter is populated only on campaigns with answering-machine detection enabled, and answered never includes it. An unknown or cross-org id returns 404 DIALER_CAMPAIGN_NOT_FOUND.
|
|
5010
5445
|
*/
|
|
5011
|
-
export type DialerCampaignsStatsErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5446
|
+
export type DialerCampaignsStatsErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5012
5447
|
/**
|
|
5013
5448
|
* dialerCampaigns.summary input.
|
|
5014
5449
|
*
|
|
@@ -5033,7 +5468,7 @@ export interface DialerCampaignsSummaryOutput {
|
|
|
5033
5468
|
*
|
|
5034
5469
|
* Aggregates the org's currently running campaigns and their live calling contacts for the dashboard card. When exactly one campaign is running, its id and name are included so the client can deep-link into it.
|
|
5035
5470
|
*/
|
|
5036
|
-
export type DialerCampaignsSummaryErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5471
|
+
export type DialerCampaignsSummaryErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5037
5472
|
/**
|
|
5038
5473
|
* dialerCampaigns.update input.
|
|
5039
5474
|
*
|
|
@@ -5105,27 +5540,77 @@ export interface DialerCampaignsUpdateInput {
|
|
|
5105
5540
|
retry_on_failed?: boolean;
|
|
5106
5541
|
retry_on_machine?: boolean;
|
|
5107
5542
|
retry_on_no_answer?: boolean;
|
|
5108
|
-
|
|
5109
|
-
|
|
5110
|
-
|
|
5111
|
-
|
|
5112
|
-
|
|
5113
|
-
|
|
5114
|
-
|
|
5115
|
-
|
|
5116
|
-
|
|
5117
|
-
|
|
5118
|
-
|
|
5119
|
-
|
|
5120
|
-
|
|
5121
|
-
|
|
5122
|
-
|
|
5123
|
-
|
|
5124
|
-
|
|
5125
|
-
|
|
5126
|
-
|
|
5127
|
-
|
|
5128
|
-
|
|
5543
|
+
retry_rules?: {
|
|
5544
|
+
busy?: {
|
|
5545
|
+
/**
|
|
5546
|
+
* minimum: 1
|
|
5547
|
+
* maximum: 10080
|
|
5548
|
+
*/
|
|
5549
|
+
interval_min?: number;
|
|
5550
|
+
/**
|
|
5551
|
+
* minimum: 0
|
|
5552
|
+
* maximum: 100
|
|
5553
|
+
*/
|
|
5554
|
+
max_attempts?: number;
|
|
5555
|
+
};
|
|
5556
|
+
failed?: {
|
|
5557
|
+
/**
|
|
5558
|
+
* minimum: 1
|
|
5559
|
+
* maximum: 10080
|
|
5560
|
+
*/
|
|
5561
|
+
interval_min?: number;
|
|
5562
|
+
/**
|
|
5563
|
+
* minimum: 0
|
|
5564
|
+
* maximum: 100
|
|
5565
|
+
*/
|
|
5566
|
+
max_attempts?: number;
|
|
5567
|
+
};
|
|
5568
|
+
machine?: {
|
|
5569
|
+
/**
|
|
5570
|
+
* minimum: 1
|
|
5571
|
+
* maximum: 10080
|
|
5572
|
+
*/
|
|
5573
|
+
interval_min?: number;
|
|
5574
|
+
/**
|
|
5575
|
+
* minimum: 0
|
|
5576
|
+
* maximum: 100
|
|
5577
|
+
*/
|
|
5578
|
+
max_attempts?: number;
|
|
5579
|
+
};
|
|
5580
|
+
no_answer?: {
|
|
5581
|
+
/**
|
|
5582
|
+
* minimum: 1
|
|
5583
|
+
* maximum: 10080
|
|
5584
|
+
*/
|
|
5585
|
+
interval_min?: number;
|
|
5586
|
+
/**
|
|
5587
|
+
* minimum: 0
|
|
5588
|
+
* maximum: 100
|
|
5589
|
+
*/
|
|
5590
|
+
max_attempts?: number;
|
|
5591
|
+
};
|
|
5592
|
+
} | null;
|
|
5593
|
+
/**
|
|
5594
|
+
* minimum: 5
|
|
5595
|
+
* maximum: 300
|
|
5596
|
+
*/
|
|
5597
|
+
ring_timeout_s?: number;
|
|
5598
|
+
/**
|
|
5599
|
+
* minLength: 1
|
|
5600
|
+
* maxLength: 120
|
|
5601
|
+
*/
|
|
5602
|
+
trunk_override?: string | null;
|
|
5603
|
+
}
|
|
5604
|
+
/**
|
|
5605
|
+
* dialerCampaigns.update output.
|
|
5606
|
+
*
|
|
5607
|
+
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope.
|
|
5608
|
+
*/
|
|
5609
|
+
export interface DialerCampaignsUpdateOutput {
|
|
5610
|
+
amd_action_announcement: "retry" | "no_retry" | "block" | null;
|
|
5611
|
+
amd_action_ivr: "retry" | "no_retry" | "block" | null;
|
|
5612
|
+
amd_action_screening: "retry" | "no_retry" | "block" | null;
|
|
5613
|
+
amd_action_voicemail: "retry" | "no_retry" | "block" | null;
|
|
5129
5614
|
amd_block_after_all_machine: boolean | null;
|
|
5130
5615
|
/**
|
|
5131
5616
|
* minimum: -2147483648
|
|
@@ -5226,6 +5711,56 @@ export interface DialerCampaignsUpdateOutput {
|
|
|
5226
5711
|
retry_on_failed: boolean;
|
|
5227
5712
|
retry_on_machine: boolean;
|
|
5228
5713
|
retry_on_no_answer: boolean;
|
|
5714
|
+
retry_rules: {
|
|
5715
|
+
busy?: {
|
|
5716
|
+
/**
|
|
5717
|
+
* minimum: 1
|
|
5718
|
+
* maximum: 10080
|
|
5719
|
+
*/
|
|
5720
|
+
interval_min?: number;
|
|
5721
|
+
/**
|
|
5722
|
+
* minimum: 0
|
|
5723
|
+
* maximum: 100
|
|
5724
|
+
*/
|
|
5725
|
+
max_attempts?: number;
|
|
5726
|
+
};
|
|
5727
|
+
failed?: {
|
|
5728
|
+
/**
|
|
5729
|
+
* minimum: 1
|
|
5730
|
+
* maximum: 10080
|
|
5731
|
+
*/
|
|
5732
|
+
interval_min?: number;
|
|
5733
|
+
/**
|
|
5734
|
+
* minimum: 0
|
|
5735
|
+
* maximum: 100
|
|
5736
|
+
*/
|
|
5737
|
+
max_attempts?: number;
|
|
5738
|
+
};
|
|
5739
|
+
machine?: {
|
|
5740
|
+
/**
|
|
5741
|
+
* minimum: 1
|
|
5742
|
+
* maximum: 10080
|
|
5743
|
+
*/
|
|
5744
|
+
interval_min?: number;
|
|
5745
|
+
/**
|
|
5746
|
+
* minimum: 0
|
|
5747
|
+
* maximum: 100
|
|
5748
|
+
*/
|
|
5749
|
+
max_attempts?: number;
|
|
5750
|
+
};
|
|
5751
|
+
no_answer?: {
|
|
5752
|
+
/**
|
|
5753
|
+
* minimum: 1
|
|
5754
|
+
* maximum: 10080
|
|
5755
|
+
*/
|
|
5756
|
+
interval_min?: number;
|
|
5757
|
+
/**
|
|
5758
|
+
* minimum: 0
|
|
5759
|
+
* maximum: 100
|
|
5760
|
+
*/
|
|
5761
|
+
max_attempts?: number;
|
|
5762
|
+
};
|
|
5763
|
+
} | null;
|
|
5229
5764
|
/**
|
|
5230
5765
|
* minimum: -2147483648
|
|
5231
5766
|
* maximum: 2147483647
|
|
@@ -5256,7 +5791,7 @@ export interface DialerCampaignsUpdateOutput {
|
|
|
5256
5791
|
*
|
|
5257
5792
|
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope.
|
|
5258
5793
|
*/
|
|
5259
|
-
export type DialerCampaignsUpdateErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5794
|
+
export type DialerCampaignsUpdateErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5260
5795
|
/**
|
|
5261
5796
|
* dialerContacts.add input.
|
|
5262
5797
|
*
|
|
@@ -5320,7 +5855,7 @@ export interface DialerContactsAddOutput {
|
|
|
5320
5855
|
*
|
|
5321
5856
|
* Adds one contact to a campaign's mailing in pending status. The phone number is normalized with the org default country; an unknown campaign returns 404 DIALER_CAMPAIGN_NOT_FOUND and an unparseable number returns 422 DIALER_IMPORT_INVALID. Requires the dialer_campaign:update scope.
|
|
5322
5857
|
*/
|
|
5323
|
-
export type DialerContactsAddErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5858
|
+
export type DialerContactsAddErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5324
5859
|
/**
|
|
5325
5860
|
* dialerContacts.bulkCancel input.
|
|
5326
5861
|
*
|
|
@@ -5347,7 +5882,7 @@ export interface DialerContactsBulkCancelOutput {
|
|
|
5347
5882
|
*
|
|
5348
5883
|
* Cancels up to 500 pending contacts by id in one call. Non-pending contacts are skipped; the response reports cancelled and skipped counts. Requires the dialer_campaign:update scope.
|
|
5349
5884
|
*/
|
|
5350
|
-
export type DialerContactsBulkCancelErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5885
|
+
export type DialerContactsBulkCancelErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5351
5886
|
/**
|
|
5352
5887
|
* dialerContacts.bulkRequeue input.
|
|
5353
5888
|
*
|
|
@@ -5374,7 +5909,7 @@ export interface DialerContactsBulkRequeueOutput {
|
|
|
5374
5909
|
*
|
|
5375
5910
|
* Requeues up to 500 terminal contacts by id back to pending. Non-terminal contacts are skipped; the response reports requeued and skipped counts. Requires the dialer_campaign:update scope.
|
|
5376
5911
|
*/
|
|
5377
|
-
export type DialerContactsBulkRequeueErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5912
|
+
export type DialerContactsBulkRequeueErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5378
5913
|
/**
|
|
5379
5914
|
* dialerContacts.cancel input.
|
|
5380
5915
|
*
|
|
@@ -5426,7 +5961,7 @@ export interface DialerContactsCancelOutput {
|
|
|
5426
5961
|
*
|
|
5427
5962
|
* Cancels a pending contact so it is no longer dialed, returning the updated contact. An unknown contact returns 404 CONTACT_NOT_FOUND. Requires the dialer_campaign:update scope.
|
|
5428
5963
|
*/
|
|
5429
|
-
export type DialerContactsCancelErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5964
|
+
export type DialerContactsCancelErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5430
5965
|
/**
|
|
5431
5966
|
* dialerContacts.exportCsv input.
|
|
5432
5967
|
*
|
|
@@ -5450,7 +5985,7 @@ export type DialerContactsExportCsvEvent = Record<string, string | number | null
|
|
|
5450
5985
|
*
|
|
5451
5986
|
* Streams the campaign's mailing as Server-Sent Events (`text/event-stream`), one JSON object per contact - NOT a text/csv file; the caller joins the cells itself. Rows carry the fixed columns (phone_number, name, status, attempt_count, machine_attempts, machine_type, last_attempt_at) plus every custom field of that contact expanded as its own key, so the shape is import-symmetric and may vary between rows. The two machine columns are always present: machine_attempts counts the calls a recording answered and machine_type is the kind identified on the most recent classified one, empty when the contact was never classified. Filters mirror the contact listing. Requires the dialer module and the dialer_campaign:read scope.
|
|
5452
5987
|
*/
|
|
5453
|
-
export type DialerContactsExportCsvErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5988
|
+
export type DialerContactsExportCsvErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5454
5989
|
/**
|
|
5455
5990
|
* dialerContacts.get input.
|
|
5456
5991
|
*
|
|
@@ -5502,7 +6037,7 @@ export interface DialerContactsGetOutput {
|
|
|
5502
6037
|
*
|
|
5503
6038
|
* Fetches a single mailing contact scoped to its campaign. An unknown or cross-org contact returns 404 CONTACT_NOT_FOUND.
|
|
5504
6039
|
*/
|
|
5505
|
-
export type DialerContactsGetErrorCode = "CONTACT_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6040
|
+
export type DialerContactsGetErrorCode = "CONTACT_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5506
6041
|
/**
|
|
5507
6042
|
* dialerContacts.list input.
|
|
5508
6043
|
*
|
|
@@ -5602,7 +6137,7 @@ export interface DialerContactsListOutput {
|
|
|
5602
6137
|
*
|
|
5603
6138
|
* Returns a campaign's mailing (contacts) as a paginated envelope. Optionally filter by contact status and by a creation-time window (dateFrom is inclusive; a YYYY-MM-DD bound means that calendar day in the organization timezone, so a YYYY-MM-DD dateTo includes that whole local day, while an ISO timestamp is an absolute instant and dateTo stops there, excluding it); search matches phone number and name. Each row also carries machine_type, the kind of recording identified on the contact's most recent classified call; null means no call of that contact was ever classified.
|
|
5604
6139
|
*/
|
|
5605
|
-
export type DialerContactsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6140
|
+
export type DialerContactsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5606
6141
|
/**
|
|
5607
6142
|
* dialerContacts.remove input.
|
|
5608
6143
|
*
|
|
@@ -5629,7 +6164,7 @@ export interface DialerContactsRemoveOutput {
|
|
|
5629
6164
|
*
|
|
5630
6165
|
* Soft-deletes up to 500 contacts by id in one call. Contacts currently calling are skipped; the response reports removed and skipped counts. Requires the dialer_campaign:update scope.
|
|
5631
6166
|
*/
|
|
5632
|
-
export type DialerContactsRemoveErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6167
|
+
export type DialerContactsRemoveErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5633
6168
|
/**
|
|
5634
6169
|
* dialerContacts.requeue input.
|
|
5635
6170
|
*
|
|
@@ -5681,7 +6216,7 @@ export interface DialerContactsRequeueOutput {
|
|
|
5681
6216
|
*
|
|
5682
6217
|
* Requeues a terminal contact (lead recycling) back to pending without resetting cumulative counters. Only contacts in a terminal status can be requeued; pending/calling contacts return 409 DIALER_CONTACT_NOT_REQUEUEABLE and an unknown contact returns 404. Requires the dialer_campaign:update scope.
|
|
5683
6218
|
*/
|
|
5684
|
-
export type DialerContactsRequeueErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CONTACT_NOT_REQUEUEABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6219
|
+
export type DialerContactsRequeueErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CONTACT_NOT_REQUEUEABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5685
6220
|
/**
|
|
5686
6221
|
* dialerContacts.requeueAll input.
|
|
5687
6222
|
*
|
|
@@ -5710,7 +6245,7 @@ export interface DialerContactsRequeueAllOutput {
|
|
|
5710
6245
|
*
|
|
5711
6246
|
* Requeues every terminal contact of a campaign back to pending, optionally restricted to a single terminal status. The response reports how many were requeued. Requires the dialer_campaign:update scope.
|
|
5712
6247
|
*/
|
|
5713
|
-
export type DialerContactsRequeueAllErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6248
|
+
export type DialerContactsRequeueAllErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5714
6249
|
/**
|
|
5715
6250
|
* dialerContacts.update input.
|
|
5716
6251
|
*
|
|
@@ -5778,7 +6313,7 @@ export interface DialerContactsUpdateOutput {
|
|
|
5778
6313
|
*
|
|
5779
6314
|
* Partially updates a mailing contact. Only pending contacts are editable (409 DIALER_CONTACT_NOT_EDITABLE otherwise); a phone number colliding with another contact in the campaign returns 409 DIALER_CONTACT_DUPLICATE, an unparseable number 422 DIALER_IMPORT_INVALID and an unknown contact 404. Requires the dialer_campaign:update scope.
|
|
5780
6315
|
*/
|
|
5781
|
-
export type DialerContactsUpdateErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CONTACT_DUPLICATE" | "DIALER_CONTACT_NOT_EDITABLE" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6316
|
+
export type DialerContactsUpdateErrorCode = "CONTACT_NOT_FOUND" | "DIALER_CONTACT_DUPLICATE" | "DIALER_CONTACT_NOT_EDITABLE" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5782
6317
|
/**
|
|
5783
6318
|
* dialerDnc.add input.
|
|
5784
6319
|
*
|
|
@@ -5824,7 +6359,7 @@ export interface DialerDncAddOutput {
|
|
|
5824
6359
|
*
|
|
5825
6360
|
* Adds one number to the org's do-not-call list so future campaigns skip it. A number already present returns 409 DIALER_DNC_DUPLICATE and an unparseable number 422 DIALER_IMPORT_INVALID. Requires the dialer_dnc:manage scope.
|
|
5826
6361
|
*/
|
|
5827
|
-
export type DialerDncAddErrorCode = "DIALER_DNC_DUPLICATE" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6362
|
+
export type DialerDncAddErrorCode = "DIALER_DNC_DUPLICATE" | "DIALER_IMPORT_INVALID" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5828
6363
|
/**
|
|
5829
6364
|
* dialerDnc.bulkImport input.
|
|
5830
6365
|
*
|
|
@@ -5852,7 +6387,7 @@ export interface DialerDncBulkImportOutput {
|
|
|
5852
6387
|
*
|
|
5853
6388
|
* Adds up to 10000 numbers to the do-not-call list in one call, applying an optional shared reason. Duplicates are skipped; the response reports added and skipped counts. Requires the dialer_dnc:manage scope.
|
|
5854
6389
|
*/
|
|
5855
|
-
export type DialerDncBulkImportErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6390
|
+
export type DialerDncBulkImportErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5856
6391
|
/**
|
|
5857
6392
|
* dialerDnc.bulkRemove input.
|
|
5858
6393
|
*
|
|
@@ -5874,7 +6409,7 @@ export interface DialerDncBulkRemoveOutput {
|
|
|
5874
6409
|
*
|
|
5875
6410
|
* Soft-deletes up to 500 do-not-call entries by id in one call; unknown or already-removed ids are skipped and the response reports the removed count. Requires the dialer_dnc:manage scope.
|
|
5876
6411
|
*/
|
|
5877
|
-
export type DialerDncBulkRemoveErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6412
|
+
export type DialerDncBulkRemoveErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5878
6413
|
/**
|
|
5879
6414
|
* dialerDnc.list input.
|
|
5880
6415
|
*
|
|
@@ -5954,7 +6489,7 @@ export interface DialerDncListOutput {
|
|
|
5954
6489
|
*
|
|
5955
6490
|
* Returns the org's do-not-call entries as a paginated envelope; search matches the phone number. Requires the dialer_dnc:read scope.
|
|
5956
6491
|
*/
|
|
5957
|
-
export type DialerDncListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6492
|
+
export type DialerDncListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5958
6493
|
/**
|
|
5959
6494
|
* dialerDnc.remove input.
|
|
5960
6495
|
*
|
|
@@ -5979,7 +6514,7 @@ export interface DialerDncRemoveOutput {
|
|
|
5979
6514
|
*
|
|
5980
6515
|
* Soft-deletes one do-not-call entry by id and returns { success: true }. Requires the dialer_dnc:manage scope.
|
|
5981
6516
|
*/
|
|
5982
|
-
export type DialerDncRemoveErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6517
|
+
export type DialerDncRemoveErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
5983
6518
|
/**
|
|
5984
6519
|
* dialerImports.create input.
|
|
5985
6520
|
*
|
|
@@ -6047,7 +6582,7 @@ export interface DialerImportsCreateOutput {
|
|
|
6047
6582
|
*
|
|
6048
6583
|
* Uploads a CSV (multipart) and starts an asynchronous import job that appends contacts to the campaign per the column mapping. Returns the created job immediately while rows are processed off the request path; poll the job or its SSE progress. An unknown campaign returns 404 DIALER_CAMPAIGN_NOT_FOUND and a malformed file/mapping returns 422 DIALER_IMPORT_INVALID. Requires the dialer_campaign:update scope.
|
|
6049
6584
|
*/
|
|
6050
|
-
export type DialerImportsCreateErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6585
|
+
export type DialerImportsCreateErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6051
6586
|
/**
|
|
6052
6587
|
* dialerImports.get input.
|
|
6053
6588
|
*
|
|
@@ -6107,7 +6642,7 @@ export interface DialerImportsGetOutput {
|
|
|
6107
6642
|
*
|
|
6108
6643
|
* Fetches an import job with its current status and progress counters (total/processed rows, imported, skipped, invalid) plus a has_invalid_rows flag. An unknown or cross-org job returns 404 DIALER_IMPORT_JOB_NOT_FOUND.
|
|
6109
6644
|
*/
|
|
6110
|
-
export type DialerImportsGetErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6645
|
+
export type DialerImportsGetErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6111
6646
|
/**
|
|
6112
6647
|
* dialerImports.invalidRows input.
|
|
6113
6648
|
*
|
|
@@ -6133,7 +6668,7 @@ export type DialerImportsInvalidRowsOutput = {
|
|
|
6133
6668
|
*
|
|
6134
6669
|
* Returns a downloadable CSV of the rows an import job rejected (filename plus CSV body), or null when the job produced no invalid rows. An unknown job returns 404 DIALER_IMPORT_JOB_NOT_FOUND.
|
|
6135
6670
|
*/
|
|
6136
|
-
export type DialerImportsInvalidRowsErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6671
|
+
export type DialerImportsInvalidRowsErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6137
6672
|
/**
|
|
6138
6673
|
* dialerImports.progress input.
|
|
6139
6674
|
*
|
|
@@ -6164,7 +6699,7 @@ export interface DialerImportsProgressEvent {
|
|
|
6164
6699
|
*
|
|
6165
6700
|
* Server-Sent Events stream of an import job's progress. The first event is always a full snapshot of the current state, and every later event carries the whole state too rather than a delta — so reconnecting is safe and never loses ground. The response advertises a 5s reconnect delay; the stream closes once the job reaches done or failed. An unknown or cross-org job returns 404 DIALER_IMPORT_JOB_NOT_FOUND before the stream opens.
|
|
6166
6701
|
*/
|
|
6167
|
-
export type DialerImportsProgressErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6702
|
+
export type DialerImportsProgressErrorCode = "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_IMPORT_INVALID" | "DIALER_IMPORT_JOB_NOT_FOUND" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6168
6703
|
/**
|
|
6169
6704
|
* holidays.countries input.
|
|
6170
6705
|
*
|
|
@@ -6185,7 +6720,7 @@ export type HolidaysCountriesOutput = {
|
|
|
6185
6720
|
*
|
|
6186
6721
|
* Returns the countries supported by the external holiday provider (Nager.Date). Returns 502 NAGER_API_ERROR when the provider cannot be reached.
|
|
6187
6722
|
*/
|
|
6188
|
-
export type HolidaysCountriesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "NAGER_API_ERROR" | "UNAUTHORIZED";
|
|
6723
|
+
export type HolidaysCountriesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "NAGER_API_ERROR" | "UNAUTHORIZED";
|
|
6189
6724
|
/**
|
|
6190
6725
|
* holidays.create input.
|
|
6191
6726
|
*
|
|
@@ -6251,7 +6786,7 @@ export interface HolidaysCreateOutput {
|
|
|
6251
6786
|
*
|
|
6252
6787
|
* Adds a single holiday (a single day or a date range) to the given group. Set `recurring` to repeat it every year on the same date.
|
|
6253
6788
|
*/
|
|
6254
|
-
export type HolidaysCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
6789
|
+
export type HolidaysCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6255
6790
|
/**
|
|
6256
6791
|
* holidays.delete input.
|
|
6257
6792
|
*
|
|
@@ -6276,7 +6811,7 @@ export interface HolidaysDeleteOutput {
|
|
|
6276
6811
|
*
|
|
6277
6812
|
* Deletes a single holiday. Returns 404 HOLIDAY_NOT_FOUND when it does not exist, and `{ success: true }` on success.
|
|
6278
6813
|
*/
|
|
6279
|
-
export type HolidaysDeleteErrorCode = "FORBIDDEN" | "HOLIDAY_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
6814
|
+
export type HolidaysDeleteErrorCode = "FORBIDDEN" | "HOLIDAY_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6280
6815
|
/**
|
|
6281
6816
|
* holidays.groups.create input.
|
|
6282
6817
|
*
|
|
@@ -6320,7 +6855,7 @@ export interface HolidaysGroupsCreateOutput {
|
|
|
6320
6855
|
*
|
|
6321
6856
|
* Creates an empty holiday group. Holidays can then be added individually or imported from an external provider.
|
|
6322
6857
|
*/
|
|
6323
|
-
export type HolidaysGroupsCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
6858
|
+
export type HolidaysGroupsCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6324
6859
|
/**
|
|
6325
6860
|
* holidays.groups.delete input.
|
|
6326
6861
|
*
|
|
@@ -6345,7 +6880,7 @@ export interface HolidaysGroupsDeleteOutput {
|
|
|
6345
6880
|
*
|
|
6346
6881
|
* Deletes a holiday group and the holidays it contains. Returns 404 HOLIDAY_GROUP_NOT_FOUND when it does not exist, and `{ success: true }` on success.
|
|
6347
6882
|
*/
|
|
6348
|
-
export type HolidaysGroupsDeleteErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
6883
|
+
export type HolidaysGroupsDeleteErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6349
6884
|
/**
|
|
6350
6885
|
* holidays.groups.getById input.
|
|
6351
6886
|
*
|
|
@@ -6381,7 +6916,7 @@ export type HolidaysGroupsGetByIdOutput = {
|
|
|
6381
6916
|
*
|
|
6382
6917
|
* Returns the holiday group, or `null` (HTTP 200) when it does not exist or belongs to another organization.
|
|
6383
6918
|
*/
|
|
6384
|
-
export type HolidaysGroupsGetByIdErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
6919
|
+
export type HolidaysGroupsGetByIdErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6385
6920
|
/**
|
|
6386
6921
|
* holidays.groups.list input.
|
|
6387
6922
|
*
|
|
@@ -6458,7 +6993,7 @@ export interface HolidaysGroupsListOutput {
|
|
|
6458
6993
|
*
|
|
6459
6994
|
* Returns a paginated list of the organization's holiday groups (named collections of holidays that schedules can reference).
|
|
6460
6995
|
*/
|
|
6461
|
-
export type HolidaysGroupsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
6996
|
+
export type HolidaysGroupsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6462
6997
|
/**
|
|
6463
6998
|
* holidays.groups.update input.
|
|
6464
6999
|
*
|
|
@@ -6500,7 +7035,7 @@ export interface HolidaysGroupsUpdateOutput {
|
|
|
6500
7035
|
*
|
|
6501
7036
|
* Partially updates a holiday group's metadata. Returns 404 HOLIDAY_GROUP_NOT_FOUND when it does not exist or belongs to another organization.
|
|
6502
7037
|
*/
|
|
6503
|
-
export type HolidaysGroupsUpdateErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7038
|
+
export type HolidaysGroupsUpdateErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6504
7039
|
/**
|
|
6505
7040
|
* holidays.import input.
|
|
6506
7041
|
*
|
|
@@ -6537,7 +7072,7 @@ export interface HolidaysImportOutput {
|
|
|
6537
7072
|
*
|
|
6538
7073
|
* Imports the public holidays for a country and year from the external provider (Nager.Date) into the given group and returns how many were imported. Returns 404 HOLIDAY_GROUP_NOT_FOUND when the group does not exist and 502 NAGER_API_ERROR when the provider cannot be reached.
|
|
6539
7074
|
*/
|
|
6540
|
-
export type HolidaysImportErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "NAGER_API_ERROR" | "UNAUTHORIZED";
|
|
7075
|
+
export type HolidaysImportErrorCode = "FORBIDDEN" | "HOLIDAY_GROUP_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "NAGER_API_ERROR" | "UNAUTHORIZED";
|
|
6541
7076
|
/**
|
|
6542
7077
|
* holidays.list input.
|
|
6543
7078
|
*
|
|
@@ -6612,7 +7147,7 @@ export interface HolidaysListOutput {
|
|
|
6612
7147
|
*
|
|
6613
7148
|
* Returns a paginated list of the holidays belonging to the given group.
|
|
6614
7149
|
*/
|
|
6615
|
-
export type HolidaysListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7150
|
+
export type HolidaysListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6616
7151
|
/**
|
|
6617
7152
|
* holidays.previewImport input.
|
|
6618
7153
|
*
|
|
@@ -6649,7 +7184,7 @@ export type HolidaysPreviewImportOutput = {
|
|
|
6649
7184
|
*
|
|
6650
7185
|
* Fetches the public holidays for a country and year from the external provider without persisting anything, so the result can be reviewed before import. Returns 502 NAGER_API_ERROR when the provider cannot be reached.
|
|
6651
7186
|
*/
|
|
6652
|
-
export type HolidaysPreviewImportErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "NAGER_API_ERROR" | "UNAUTHORIZED";
|
|
7187
|
+
export type HolidaysPreviewImportErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "NAGER_API_ERROR" | "UNAUTHORIZED";
|
|
6653
7188
|
/**
|
|
6654
7189
|
* holidays.update input.
|
|
6655
7190
|
*
|
|
@@ -6708,7 +7243,7 @@ export interface HolidaysUpdateOutput {
|
|
|
6708
7243
|
*
|
|
6709
7244
|
* Partially updates a single holiday. Returns 404 HOLIDAY_NOT_FOUND when it does not exist.
|
|
6710
7245
|
*/
|
|
6711
|
-
export type HolidaysUpdateErrorCode = "FORBIDDEN" | "HOLIDAY_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7246
|
+
export type HolidaysUpdateErrorCode = "FORBIDDEN" | "HOLIDAY_NOT_FOUND" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6712
7247
|
/**
|
|
6713
7248
|
* insights.aggregate input.
|
|
6714
7249
|
*
|
|
@@ -6771,7 +7306,7 @@ export interface InsightsAggregateOutput {
|
|
|
6771
7306
|
*
|
|
6772
7307
|
* Aggregates call measures (volume, answered, busy, no_answer, failed, duration, ai_cost, flow_errors) grouped by up to two dimensions: day, week, month, hour_of_day, weekday, plan, plan_version, channel, outcome, or a signal value. Filters narrow by plan, channel, outcome, or signal values. Requires dashboard:read, plus the ai module when a signal is referenced.
|
|
6773
7308
|
*/
|
|
6774
|
-
export type InsightsAggregateErrorCode = "FORBIDDEN" | "INSIGHT_PERIOD_TOO_LONG" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
7309
|
+
export type InsightsAggregateErrorCode = "FORBIDDEN" | "INSIGHT_PERIOD_TOO_LONG" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
6775
7310
|
/**
|
|
6776
7311
|
* license.modules input.
|
|
6777
7312
|
*
|
|
@@ -6792,7 +7327,7 @@ export interface LicenseModulesOutput {
|
|
|
6792
7327
|
*
|
|
6793
7328
|
* Returns enabled modules and service availability without exposing deployment license details.
|
|
6794
7329
|
*/
|
|
6795
|
-
export type LicenseModulesErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7330
|
+
export type LicenseModulesErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6796
7331
|
/**
|
|
6797
7332
|
* license.status input.
|
|
6798
7333
|
*
|
|
@@ -6826,7 +7361,147 @@ export interface LicenseStatusOutput {
|
|
|
6826
7361
|
*
|
|
6827
7362
|
* Returns deployment-wide license status and installation details. Available only to platform administrators.
|
|
6828
7363
|
*/
|
|
6829
|
-
export type LicenseStatusErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7364
|
+
export type LicenseStatusErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7365
|
+
/**
|
|
7366
|
+
* nodes.list input.
|
|
7367
|
+
*
|
|
7368
|
+
* Returns every plan block type with its category, channel, the connector kind it needs (null when none) and the variables it produces. Read-only product metadata, available to any authenticated member or key.
|
|
7369
|
+
*/
|
|
7370
|
+
export type NodesListInput = void;
|
|
7371
|
+
/**
|
|
7372
|
+
* nodes.list output.
|
|
7373
|
+
*
|
|
7374
|
+
* Returns every plan block type with its category, channel, the connector kind it needs (null when none) and the variables it produces. Read-only product metadata, available to any authenticated member or key.
|
|
7375
|
+
*/
|
|
7376
|
+
export type NodesListOutput = {
|
|
7377
|
+
/**
|
|
7378
|
+
* Palette category (interaction, handling, routing, data, legacy).
|
|
7379
|
+
*/
|
|
7380
|
+
category: string;
|
|
7381
|
+
/**
|
|
7382
|
+
* Channel the block works on.
|
|
7383
|
+
*/
|
|
7384
|
+
channel: "voice" | "chat" | "both";
|
|
7385
|
+
connector: {
|
|
7386
|
+
/**
|
|
7387
|
+
* Key of the block config that holds the connector's public id (`conn_...`). Fill it with an ACTIVE connector of this kind.
|
|
7388
|
+
*/
|
|
7389
|
+
config_key: string;
|
|
7390
|
+
/**
|
|
7391
|
+
* Connector kind the block calls through (for example `twilio`).
|
|
7392
|
+
*/
|
|
7393
|
+
kind: string;
|
|
7394
|
+
} | null;
|
|
7395
|
+
/**
|
|
7396
|
+
* What the block does, in one sentence.
|
|
7397
|
+
*/
|
|
7398
|
+
description: string;
|
|
7399
|
+
/**
|
|
7400
|
+
* Commercial module the block belongs to (core, ai, queues, dialer, omnichannel, enterprise).
|
|
7401
|
+
*/
|
|
7402
|
+
module: string;
|
|
7403
|
+
/**
|
|
7404
|
+
* Display name of the block.
|
|
7405
|
+
*/
|
|
7406
|
+
name: string;
|
|
7407
|
+
produced_variables: {
|
|
7408
|
+
/**
|
|
7409
|
+
* Variable name, as referenced after the block runs (`{{<block>.<name>}}` or `{{vars.<name>}}`).
|
|
7410
|
+
*/
|
|
7411
|
+
name: string;
|
|
7412
|
+
/**
|
|
7413
|
+
* Value type of the variable.
|
|
7414
|
+
*/
|
|
7415
|
+
type: "string" | "number" | "object" | "array";
|
|
7416
|
+
}[];
|
|
7417
|
+
/**
|
|
7418
|
+
* Block type identifier, the value of `node_type` in `nodes_schema` and of the block's `type` in an editor state.
|
|
7419
|
+
*/
|
|
7420
|
+
type: string;
|
|
7421
|
+
}[];
|
|
7422
|
+
/**
|
|
7423
|
+
* nodes.list error codes.
|
|
7424
|
+
*
|
|
7425
|
+
* Returns every plan block type with its category, channel, the connector kind it needs (null when none) and the variables it produces. Read-only product metadata, available to any authenticated member or key.
|
|
7426
|
+
*/
|
|
7427
|
+
export type NodesListErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7428
|
+
/**
|
|
7429
|
+
* nodes.schema input.
|
|
7430
|
+
*
|
|
7431
|
+
* Returns the JSON Schema of the block's `config`, its default config, its output handles and the connector kind it needs. An unknown node_type is a validation error (422).
|
|
7432
|
+
*/
|
|
7433
|
+
export interface NodesSchemaInput {
|
|
7434
|
+
/**
|
|
7435
|
+
* Block type, as listed by `nodes_list` (for example `sendSms` or `menu`).
|
|
7436
|
+
*/
|
|
7437
|
+
node_type: "start" | "playback" | "ivr" | "collectDigits" | "transfer" | "hangup" | "timeRouting" | "switchCase" | "trafficSplit" | "setVariable" | "sequence" | "counter" | "httpRequest" | "webhook" | "whatsappTemplate" | "sendSms" | "phoneLookup" | "verifyCode" | "dataTransform" | "subPlan" | "sendDtmf" | "aiAgent" | "retellAgent" | "vapiAgent" | "elevenlabsAgent" | "voiceRecognition" | "tell" | "menu" | "capture" | "routeAi" | "channelRouter" | "addToDnc" | "apiSwitch" | "enableRecord" | "recording" | "transcription" | "analysis";
|
|
7438
|
+
}
|
|
7439
|
+
/**
|
|
7440
|
+
* nodes.schema output.
|
|
7441
|
+
*
|
|
7442
|
+
* Returns the JSON Schema of the block's `config`, its default config, its output handles and the connector kind it needs. An unknown node_type is a validation error (422).
|
|
7443
|
+
*/
|
|
7444
|
+
export interface NodesSchemaOutput {
|
|
7445
|
+
/**
|
|
7446
|
+
* Palette category (interaction, handling, routing, data, legacy).
|
|
7447
|
+
*/
|
|
7448
|
+
category: string;
|
|
7449
|
+
/**
|
|
7450
|
+
* Channel the block works on.
|
|
7451
|
+
*/
|
|
7452
|
+
channel: "voice" | "chat" | "both";
|
|
7453
|
+
/**
|
|
7454
|
+
* JSON Schema of the block `config`: field names, types, constraints, enums and descriptions. Keys inside are the block config's own names and are sent back unchanged.
|
|
7455
|
+
*/
|
|
7456
|
+
config_schema: Record<string, NivaJsonValue>;
|
|
7457
|
+
connector: {
|
|
7458
|
+
/**
|
|
7459
|
+
* Key of the block config that holds the connector's public id (`conn_...`). Fill it with an ACTIVE connector of this kind.
|
|
7460
|
+
*/
|
|
7461
|
+
config_key: string;
|
|
7462
|
+
/**
|
|
7463
|
+
* Connector kind the block calls through (for example `twilio`).
|
|
7464
|
+
*/
|
|
7465
|
+
kind: string;
|
|
7466
|
+
} | null;
|
|
7467
|
+
/**
|
|
7468
|
+
* Config a freshly placed block starts with. A valid starting point to extend.
|
|
7469
|
+
*/
|
|
7470
|
+
default_config: Record<string, NivaJsonValue>;
|
|
7471
|
+
/**
|
|
7472
|
+
* What the block does, in one sentence.
|
|
7473
|
+
*/
|
|
7474
|
+
description: string;
|
|
7475
|
+
handles: string[];
|
|
7476
|
+
/**
|
|
7477
|
+
* Commercial module the block belongs to (core, ai, queues, dialer, omnichannel, enterprise).
|
|
7478
|
+
*/
|
|
7479
|
+
module: string;
|
|
7480
|
+
/**
|
|
7481
|
+
* Display name of the block.
|
|
7482
|
+
*/
|
|
7483
|
+
name: string;
|
|
7484
|
+
produced_variables: {
|
|
7485
|
+
/**
|
|
7486
|
+
* Variable name, as referenced after the block runs (`{{<block>.<name>}}` or `{{vars.<name>}}`).
|
|
7487
|
+
*/
|
|
7488
|
+
name: string;
|
|
7489
|
+
/**
|
|
7490
|
+
* Value type of the variable.
|
|
7491
|
+
*/
|
|
7492
|
+
type: "string" | "number" | "object" | "array";
|
|
7493
|
+
}[];
|
|
7494
|
+
/**
|
|
7495
|
+
* Block type identifier, the value of `node_type` in `nodes_schema` and of the block's `type` in an editor state.
|
|
7496
|
+
*/
|
|
7497
|
+
type: string;
|
|
7498
|
+
}
|
|
7499
|
+
/**
|
|
7500
|
+
* nodes.schema error codes.
|
|
7501
|
+
*
|
|
7502
|
+
* Returns the JSON Schema of the block's `config`, its default config, its output handles and the connector kind it needs. An unknown node_type is a validation error (422).
|
|
7503
|
+
*/
|
|
7504
|
+
export type NodesSchemaErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6830
7505
|
/**
|
|
6831
7506
|
* oauthGrants.list input.
|
|
6832
7507
|
*
|
|
@@ -6901,7 +7576,7 @@ export interface OauthGrantsListOutput {
|
|
|
6901
7576
|
*
|
|
6902
7577
|
* Lists the OAuth grants (connected apps) that are still alive in the organization. A member sees only their own consents; a role holding oauth_grant:revoke sees every member's. Requires the oauth_grant:read scope.
|
|
6903
7578
|
*/
|
|
6904
|
-
export type OauthGrantsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7579
|
+
export type OauthGrantsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
6905
7580
|
/**
|
|
6906
7581
|
* oauthGrants.revoke input.
|
|
6907
7582
|
*
|
|
@@ -6926,7 +7601,7 @@ export interface OauthGrantsRevokeOutput {
|
|
|
6926
7601
|
*
|
|
6927
7602
|
* Revokes a connected-app OAuth grant: the next refresh fails with invalid_grant and the live access token is refused immediately. A member can revoke only their own grants; oauth_grant:revoke revokes anyone's in the organization. Unknown or already-revoked ids return 404 OAUTH_GRANT_NOT_FOUND. Requires the oauth_grant:read scope; a credential (API key or OAuth token) additionally needs the oauth_grant:write scope, as any mutation.
|
|
6928
7603
|
*/
|
|
6929
|
-
export type OauthGrantsRevokeErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "OAUTH_GRANT_FORBIDDEN" | "OAUTH_GRANT_NOT_FOUND" | "UNAUTHORIZED";
|
|
7604
|
+
export type OauthGrantsRevokeErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "OAUTH_GRANT_FORBIDDEN" | "OAUTH_GRANT_NOT_FOUND" | "UNAUTHORIZED";
|
|
6930
7605
|
/**
|
|
6931
7606
|
* oauthGrants.usage input.
|
|
6932
7607
|
*
|
|
@@ -6974,17 +7649,17 @@ export interface OauthGrantsUsageOutput {
|
|
|
6974
7649
|
*
|
|
6975
7650
|
* Returns which routes this OAuth grant called, how many times per day and when each route was last used, over the last `days` days (1 to 90, default 30). A member can read only their own grants; oauth_grant:revoke (org admin) reads anyone's in the organization. An unknown or cross-org id returns 404 OAUTH_GRANT_NOT_FOUND; another member's grant returns 403 OAUTH_GRANT_FORBIDDEN. Requires the oauth_grant:read scope.
|
|
6976
7651
|
*/
|
|
6977
|
-
export type OauthGrantsUsageErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "OAUTH_GRANT_FORBIDDEN" | "OAUTH_GRANT_NOT_FOUND" | "UNAUTHORIZED";
|
|
7652
|
+
export type OauthGrantsUsageErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "OAUTH_GRANT_FORBIDDEN" | "OAUTH_GRANT_NOT_FOUND" | "UNAUTHORIZED";
|
|
6978
7653
|
/**
|
|
6979
7654
|
* orgSettings.getDialer input.
|
|
6980
7655
|
*
|
|
6981
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
7656
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
6982
7657
|
*/
|
|
6983
7658
|
export type OrgSettingsGetDialerInput = void;
|
|
6984
7659
|
/**
|
|
6985
7660
|
* orgSettings.getDialer output.
|
|
6986
7661
|
*
|
|
6987
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
7662
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
6988
7663
|
*/
|
|
6989
7664
|
export type OrgSettingsGetDialerOutput = {
|
|
6990
7665
|
/**
|
|
@@ -7002,6 +7677,11 @@ export type OrgSettingsGetDialerOutput = {
|
|
|
7002
7677
|
*/
|
|
7003
7678
|
dialer_amd_block_min_attempts: number | null;
|
|
7004
7679
|
dialer_amd_enabled: boolean | null;
|
|
7680
|
+
/**
|
|
7681
|
+
* minimum: -2147483648
|
|
7682
|
+
* maximum: 2147483647
|
|
7683
|
+
*/
|
|
7684
|
+
dialer_daily_attempt_cap: number | null;
|
|
7005
7685
|
/**
|
|
7006
7686
|
* maxLength: 120
|
|
7007
7687
|
*/
|
|
@@ -7015,9 +7695,9 @@ export type OrgSettingsGetDialerOutput = {
|
|
|
7015
7695
|
/**
|
|
7016
7696
|
* orgSettings.getDialer error codes.
|
|
7017
7697
|
*
|
|
7018
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
7698
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
7019
7699
|
*/
|
|
7020
|
-
export type OrgSettingsGetDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7700
|
+
export type OrgSettingsGetDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7021
7701
|
/**
|
|
7022
7702
|
* orgSettings.upsertDialer input.
|
|
7023
7703
|
*
|
|
@@ -7040,6 +7720,11 @@ export interface OrgSettingsUpsertDialerInput {
|
|
|
7040
7720
|
*/
|
|
7041
7721
|
dialer_amd_block_min_attempts?: number | null;
|
|
7042
7722
|
dialer_amd_enabled?: boolean | null;
|
|
7723
|
+
/**
|
|
7724
|
+
* minimum: 0
|
|
7725
|
+
* maximum: 1000
|
|
7726
|
+
*/
|
|
7727
|
+
dialer_daily_attempt_cap?: number | null;
|
|
7043
7728
|
/**
|
|
7044
7729
|
* minLength: 1
|
|
7045
7730
|
* maxLength: 120
|
|
@@ -7072,6 +7757,11 @@ export interface OrgSettingsUpsertDialerOutput {
|
|
|
7072
7757
|
*/
|
|
7073
7758
|
dialer_amd_block_min_attempts: number | null;
|
|
7074
7759
|
dialer_amd_enabled: boolean | null;
|
|
7760
|
+
/**
|
|
7761
|
+
* minimum: -2147483648
|
|
7762
|
+
* maximum: 2147483647
|
|
7763
|
+
*/
|
|
7764
|
+
dialer_daily_attempt_cap: number | null;
|
|
7075
7765
|
/**
|
|
7076
7766
|
* maxLength: 120
|
|
7077
7767
|
*/
|
|
@@ -7087,7 +7777,7 @@ export interface OrgSettingsUpsertDialerOutput {
|
|
|
7087
7777
|
*
|
|
7088
7778
|
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log.
|
|
7089
7779
|
*/
|
|
7090
|
-
export type OrgSettingsUpsertDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7780
|
+
export type OrgSettingsUpsertDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7091
7781
|
/**
|
|
7092
7782
|
* schedules.create input.
|
|
7093
7783
|
*
|
|
@@ -7154,7 +7844,7 @@ export interface SchedulesCreateOutput {
|
|
|
7154
7844
|
*
|
|
7155
7845
|
* Creates a schedule from a set of time-based rules and optional holiday country calendars.
|
|
7156
7846
|
*/
|
|
7157
|
-
export type SchedulesCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7847
|
+
export type SchedulesCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7158
7848
|
/**
|
|
7159
7849
|
* schedules.delete input.
|
|
7160
7850
|
*
|
|
@@ -7179,7 +7869,7 @@ export interface SchedulesDeleteOutput {
|
|
|
7179
7869
|
*
|
|
7180
7870
|
* Deletes a schedule. Returns 404 SCHEDULE_NOT_FOUND when it does not exist, and `{ success: true }` on success.
|
|
7181
7871
|
*/
|
|
7182
|
-
export type SchedulesDeleteErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "SCHEDULE_NOT_FOUND" | "UNAUTHORIZED";
|
|
7872
|
+
export type SchedulesDeleteErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "SCHEDULE_NOT_FOUND" | "UNAUTHORIZED";
|
|
7183
7873
|
/**
|
|
7184
7874
|
* schedules.getById input.
|
|
7185
7875
|
*
|
|
@@ -7213,7 +7903,7 @@ export type SchedulesGetByIdOutput = {
|
|
|
7213
7903
|
*
|
|
7214
7904
|
* Returns the schedule, or `null` (HTTP 200) when it does not exist or belongs to another organization.
|
|
7215
7905
|
*/
|
|
7216
|
-
export type SchedulesGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "SCHEDULE_NOT_FOUND" | "UNAUTHORIZED";
|
|
7906
|
+
export type SchedulesGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "SCHEDULE_NOT_FOUND" | "UNAUTHORIZED";
|
|
7217
7907
|
/**
|
|
7218
7908
|
* schedules.list input.
|
|
7219
7909
|
*
|
|
@@ -7288,7 +7978,7 @@ export interface SchedulesListOutput {
|
|
|
7288
7978
|
*
|
|
7289
7979
|
* Returns a paginated list of the organization's schedules (business-hours rule sets used to gate when plans answer).
|
|
7290
7980
|
*/
|
|
7291
|
-
export type SchedulesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
7981
|
+
export type SchedulesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7292
7982
|
/**
|
|
7293
7983
|
* schedules.update input.
|
|
7294
7984
|
*
|
|
@@ -7359,7 +8049,7 @@ export interface SchedulesUpdateOutput {
|
|
|
7359
8049
|
*
|
|
7360
8050
|
* Partially updates a schedule. Returns 404 SCHEDULE_NOT_FOUND when it does not exist or belongs to another organization.
|
|
7361
8051
|
*/
|
|
7362
|
-
export type SchedulesUpdateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "SCHEDULE_NOT_FOUND" | "UNAUTHORIZED";
|
|
8052
|
+
export type SchedulesUpdateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "SCHEDULE_NOT_FOUND" | "UNAUTHORIZED";
|
|
7363
8053
|
/**
|
|
7364
8054
|
* secrets.list input.
|
|
7365
8055
|
*
|
|
@@ -7452,7 +8142,7 @@ export interface SecretsListOutput {
|
|
|
7452
8142
|
*
|
|
7453
8143
|
* Returns the organization's secrets as a paginated envelope: name, description, the last 4 characters of the value, and how many plans reference it, published and draft counted apart. The value itself is never returned by any procedure. Requires the secret:read scope.
|
|
7454
8144
|
*/
|
|
7455
|
-
export type SecretsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
8145
|
+
export type SecretsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7456
8146
|
/**
|
|
7457
8147
|
* secrets.listNames input.
|
|
7458
8148
|
*
|
|
@@ -7470,7 +8160,7 @@ export type SecretsListNamesOutput = string[];
|
|
|
7470
8160
|
*
|
|
7471
8161
|
* Returns just the names of the organization's secrets, for plan-editor autocomplete and broken-reference detection. No values, suffixes or descriptions. Requires the visual_plan:read scope, not secret:read.
|
|
7472
8162
|
*/
|
|
7473
|
-
export type SecretsListNamesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
8163
|
+
export type SecretsListNamesErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
7474
8164
|
/**
|
|
7475
8165
|
* signals.callSignals input.
|
|
7476
8166
|
*
|
|
@@ -7587,7 +8277,7 @@ export type SignalsCallSignalsOutput = {
|
|
|
7587
8277
|
*
|
|
7588
8278
|
* Returns every signal result of a call with the definition snapshot that produced it, the final value, the trigger (if any) and the timeline points. Empty when the call was never evaluated. Requires the ai module and the ai:read scope.
|
|
7589
8279
|
*/
|
|
7590
|
-
export type SignalsCallSignalsErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8280
|
+
export type SignalsCallSignalsErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
7591
8281
|
/**
|
|
7592
8282
|
* signals.create input.
|
|
7593
8283
|
*
|
|
@@ -7728,7 +8418,7 @@ export interface SignalsCreateOutput {
|
|
|
7728
8418
|
*
|
|
7729
8419
|
* Creates a signal in the organization's library with its version 1 snapshot. The slug derives from the name when absent, suffixed on collision. Requires the ai module and the ai:configure scope.
|
|
7730
8420
|
*/
|
|
7731
|
-
export type SignalsCreateErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8421
|
+
export type SignalsCreateErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
7732
8422
|
/**
|
|
7733
8423
|
* signals.delete input.
|
|
7734
8424
|
*
|
|
@@ -7815,7 +8505,7 @@ export interface SignalsDeleteOutput {
|
|
|
7815
8505
|
*
|
|
7816
8506
|
* Moves a signal to the trash: it leaves the effective lists of plans but keeps its slug, versions and call history. Restore it from the archive; purge it there only while no call references it. Requires the ai module and the ai:configure scope.
|
|
7817
8507
|
*/
|
|
7818
|
-
export type SignalsDeleteErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8508
|
+
export type SignalsDeleteErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
7819
8509
|
/**
|
|
7820
8510
|
* signals.get input.
|
|
7821
8511
|
*
|
|
@@ -7902,7 +8592,7 @@ export interface SignalsGetOutput {
|
|
|
7902
8592
|
*
|
|
7903
8593
|
* Returns one signal of the organization's library. Returns 404 SIGNAL_NOT_FOUND when the id does not exist or belongs to another organization. Requires the ai module and the ai:read scope.
|
|
7904
8594
|
*/
|
|
7905
|
-
export type SignalsGetErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8595
|
+
export type SignalsGetErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
7906
8596
|
/**
|
|
7907
8597
|
* signals.list input.
|
|
7908
8598
|
*
|
|
@@ -8057,7 +8747,7 @@ export interface SignalsListOutput {
|
|
|
8057
8747
|
*
|
|
8058
8748
|
* Returns the organization's signal library as a paginated envelope, each item with plan usage (published and draft counted apart) and trailing-7-day trigger and evaluation counts. Requires the ai module and the ai:read scope.
|
|
8059
8749
|
*/
|
|
8060
|
-
export type SignalsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
8750
|
+
export type SignalsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
8061
8751
|
/**
|
|
8062
8752
|
* signals.overview input.
|
|
8063
8753
|
*
|
|
@@ -8124,7 +8814,7 @@ export interface SignalsOverviewOutput {
|
|
|
8124
8814
|
*
|
|
8125
8815
|
* Organization-scoped aggregates for the Signals library header: trigger rows and distinct evaluated calls in the trailing 7 days, non-archived signals in at least one plan's effective list, and non-deleted plans that follow the organization. Computed with SQL aggregates, never by summing a page. Requires the ai module and the ai:read scope.
|
|
8126
8816
|
*/
|
|
8127
|
-
export type SignalsOverviewErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
8817
|
+
export type SignalsOverviewErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
8128
8818
|
/**
|
|
8129
8819
|
* signals.presets input.
|
|
8130
8820
|
*
|
|
@@ -8208,7 +8898,7 @@ export type SignalsPresetsOutput = {
|
|
|
8208
8898
|
*
|
|
8209
8899
|
* Returns the ten signal models with their localized definitions. Use one as the starting point for a new signal. Requires the ai module and the ai:read scope.
|
|
8210
8900
|
*/
|
|
8211
|
-
export type SignalsPresetsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
8901
|
+
export type SignalsPresetsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
8212
8902
|
/**
|
|
8213
8903
|
* signals.test input.
|
|
8214
8904
|
*
|
|
@@ -8439,7 +9129,7 @@ export type SignalsTestOutput = {
|
|
|
8439
9129
|
*
|
|
8440
9130
|
* Runs a saved or unsaved definition against one text, one recorded call (replayed turn by turn with the same windows the engine will use), or a plan's last transcribed calls. Exactly one source. Stored-call and plan sources require call_content:read; all sources require the ai module and the ai:execute scope.
|
|
8441
9131
|
*/
|
|
8442
|
-
export type SignalsTestErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
9132
|
+
export type SignalsTestErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8443
9133
|
/**
|
|
8444
9134
|
* signals.update input.
|
|
8445
9135
|
*
|
|
@@ -8580,7 +9270,7 @@ export interface SignalsUpdateOutput {
|
|
|
8580
9270
|
*
|
|
8581
9271
|
* Partially updates a signal. Removed option keys are archived, never dropped; the version bumps when anything that affects evaluation or alerting changes (question, options, levels, speaker, scope, live, alert). The slug and kind never change. Requires the ai module and the ai:configure scope.
|
|
8582
9272
|
*/
|
|
8583
|
-
export type SignalsUpdateErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
9273
|
+
export type SignalsUpdateErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8584
9274
|
/**
|
|
8585
9275
|
* signals.upsertBySlug input.
|
|
8586
9276
|
*
|
|
@@ -8727,7 +9417,7 @@ export interface SignalsUpsertBySlugOutput {
|
|
|
8727
9417
|
*
|
|
8728
9418
|
* The idempotent agent path: creates the signal, updates it, or reports unchanged with the fields that differed. Running the same body twice returns unchanged. With dry_run it reports the same outcome without writing or logging an audit entry. Requires the ai module and the ai:configure scope.
|
|
8729
9419
|
*/
|
|
8730
|
-
export type SignalsUpsertBySlugErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
9420
|
+
export type SignalsUpsertBySlugErrorCode = "CALL_NOT_FOUND" | "DECISIONS_UNAVAILABLE" | "DUPLICATE_SIGNAL_SLUG" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_ALERT_OPTION_REMOVED" | "SIGNAL_ARCHIVED" | "SIGNAL_DEFINITION_INVALID" | "SIGNAL_KIND_IMMUTABLE" | "SIGNAL_NOT_FOUND" | "SIGNAL_TEST_NO_TRANSCRIPTION" | "SIGNAL_TEST_SOURCE_INVALID" | "SIGNAL_VERSION_CONFLICT" | "UNAUTHORIZED";
|
|
8731
9421
|
/**
|
|
8732
9422
|
* tts.listModels input.
|
|
8733
9423
|
*
|
|
@@ -8749,7 +9439,7 @@ export type TtsListModelsOutput = {
|
|
|
8749
9439
|
*
|
|
8750
9440
|
* Returns the catalog of available TTS models as a raw array, limited to the active, licensed provider tier.
|
|
8751
9441
|
*/
|
|
8752
|
-
export type TtsListModelsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
9442
|
+
export type TtsListModelsErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
8753
9443
|
/**
|
|
8754
9444
|
* tts.listVoices input.
|
|
8755
9445
|
*
|
|
@@ -8782,7 +9472,7 @@ export type TtsListVoicesOutput = {
|
|
|
8782
9472
|
*
|
|
8783
9473
|
* Returns the catalog of available TTS voices as a raw array, optionally filtered by `language` and/or `model`. Only voices from the active, licensed provider tier are visible.
|
|
8784
9474
|
*/
|
|
8785
|
-
export type TtsListVoicesErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
9475
|
+
export type TtsListVoicesErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
8786
9476
|
/**
|
|
8787
9477
|
* tts.preview input.
|
|
8788
9478
|
*
|
|
@@ -8811,7 +9501,7 @@ export interface TtsPreviewInput {
|
|
|
8811
9501
|
*
|
|
8812
9502
|
* Synthesizes the supplied text and returns the raw audio bytes without storing anything in the audio library. When `voice` and `model` are omitted they are resolved from the organization's language and active provider tier. Returns 422 TTS_VOICE_UNAVAILABLE when no voice is available for that language.
|
|
8813
9503
|
*/
|
|
8814
|
-
export type TtsPreviewErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
9504
|
+
export type TtsPreviewErrorCode = "AI_INVALID_API_KEY" | "AI_NOT_CONFIGURED" | "AI_UNREACHABLE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "TTS_VOICE_UNAVAILABLE" | "UNAUTHORIZED";
|
|
8815
9505
|
/**
|
|
8816
9506
|
* users.activateMember input.
|
|
8817
9507
|
*
|
|
@@ -8843,7 +9533,7 @@ export interface UsersActivateMemberOutput {
|
|
|
8843
9533
|
*
|
|
8844
9534
|
* Reactivates a previously suspended member, restoring their access. Returns 404 MEMBER_NOT_FOUND when the member does not exist.
|
|
8845
9535
|
*/
|
|
8846
|
-
export type UsersActivateMemberErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9536
|
+
export type UsersActivateMemberErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
8847
9537
|
/**
|
|
8848
9538
|
* users.createMember input.
|
|
8849
9539
|
*
|
|
@@ -8886,7 +9576,7 @@ export interface UsersCreateMemberOutput {
|
|
|
8886
9576
|
*
|
|
8887
9577
|
* Adds a member to the organization, either by attaching an existing user (by email) or by creating a new user. Creating a new user requires `password` and `name`, otherwise 422 NEW_USER_REQUIRES_PASSWORD is returned. Returns 409 DUPLICATE_EMAIL / ALREADY_MEMBER on conflicts and 422 ROLE_SCOPE_MISMATCH / 404 ROLE_NOT_FOUND for invalid role assignment.
|
|
8888
9578
|
*/
|
|
8889
|
-
export type UsersCreateMemberErrorCode = "ALREADY_MEMBER" | "DUPLICATE_EMAIL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "NEW_USER_REQUIRES_PASSWORD" | "PERMISSION_CEILING_EXCEEDED" | "ROLE_NOT_FOUND" | "ROLE_SCOPE_MISMATCH" | "UNAUTHORIZED";
|
|
9579
|
+
export type UsersCreateMemberErrorCode = "ALREADY_MEMBER" | "DUPLICATE_EMAIL" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "NEW_USER_REQUIRES_PASSWORD" | "PERMISSION_CEILING_EXCEEDED" | "ROLE_NOT_FOUND" | "ROLE_SCOPE_MISMATCH" | "SSO_REQUIRED" | "UNAUTHORIZED";
|
|
8890
9580
|
/**
|
|
8891
9581
|
* users.listMembers input.
|
|
8892
9582
|
*
|
|
@@ -8932,13 +9622,16 @@ export interface UsersListMembersInput {
|
|
|
8932
9622
|
*/
|
|
8933
9623
|
export interface UsersListMembersOutput {
|
|
8934
9624
|
items: {
|
|
9625
|
+
can_manage_account: boolean;
|
|
8935
9626
|
can_reset_password: boolean;
|
|
8936
9627
|
created_at: string;
|
|
8937
9628
|
email: string;
|
|
8938
9629
|
id: UserId;
|
|
9630
|
+
locked_until: string | null;
|
|
8939
9631
|
name: string;
|
|
8940
9632
|
role_id: RoleId;
|
|
8941
9633
|
role_name: string;
|
|
9634
|
+
second_factor: "none" | "totp" | "passkey" | "pending";
|
|
8942
9635
|
status: string;
|
|
8943
9636
|
timezone: string | null;
|
|
8944
9637
|
}[];
|
|
@@ -8964,7 +9657,7 @@ export interface UsersListMembersOutput {
|
|
|
8964
9657
|
*
|
|
8965
9658
|
* Returns a paginated list of the organization's members, optionally filtered by membership `status`.
|
|
8966
9659
|
*/
|
|
8967
|
-
export type UsersListMembersErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
9660
|
+
export type UsersListMembersErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
8968
9661
|
/**
|
|
8969
9662
|
* users.me input.
|
|
8970
9663
|
*
|
|
@@ -8992,6 +9685,7 @@ export type UsersMeOutput = {
|
|
|
8992
9685
|
* Deprecated: the notification center is always on. Always in_app.
|
|
8993
9686
|
*/
|
|
8994
9687
|
notification_center_mode: "off" | "in_app" | "full";
|
|
9688
|
+
notification_email: boolean;
|
|
8995
9689
|
notification_toast: "follow_org" | "critical_only" | "off";
|
|
8996
9690
|
org_id: OrganizationId;
|
|
8997
9691
|
org_timezone: string;
|
|
@@ -9007,7 +9701,7 @@ export type UsersMeOutput = {
|
|
|
9007
9701
|
*
|
|
9008
9702
|
* Returns the authenticated user's profile for the current organization, including their effective `permissions`, role scope and feature flags. Under `X-API-Key` authentication this resolves to the user who created the key. A platform admin that is not a member of the resolved organization is answered from its platform-scope membership. Returns `null` (HTTP 200) when an organization-scoped caller is not a member of the organization.
|
|
9009
9703
|
*/
|
|
9010
|
-
export type UsersMeErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
9704
|
+
export type UsersMeErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
9011
9705
|
/**
|
|
9012
9706
|
* users.removeMember input.
|
|
9013
9707
|
*
|
|
@@ -9032,7 +9726,57 @@ export interface UsersRemoveMemberOutput {
|
|
|
9032
9726
|
*
|
|
9033
9727
|
* Removes a member from the organization. Returns 409 CANNOT_REMOVE_SELF when the caller targets their own membership and 404 MEMBER_NOT_FOUND when the member does not exist. Returns `{ success: true }` on success.
|
|
9034
9728
|
*/
|
|
9035
|
-
export type UsersRemoveMemberErrorCode = "CANNOT_REMOVE_SELF" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "LAST_ADMINISTRATOR" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9729
|
+
export type UsersRemoveMemberErrorCode = "CANNOT_REMOVE_SELF" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "LAST_ADMINISTRATOR" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9730
|
+
/**
|
|
9731
|
+
* users.resetSecondFactor input.
|
|
9732
|
+
*
|
|
9733
|
+
* Removes authenticator and recovery codes and revokes every session and trusted device.
|
|
9734
|
+
*/
|
|
9735
|
+
export interface UsersResetSecondFactorInput {
|
|
9736
|
+
/**
|
|
9737
|
+
* TypeID of the member/user (usr_...).
|
|
9738
|
+
*/
|
|
9739
|
+
user_id: UserId;
|
|
9740
|
+
}
|
|
9741
|
+
/**
|
|
9742
|
+
* users.resetSecondFactor output.
|
|
9743
|
+
*
|
|
9744
|
+
* Removes authenticator and recovery codes and revokes every session and trusted device.
|
|
9745
|
+
*/
|
|
9746
|
+
export interface UsersResetSecondFactorOutput {
|
|
9747
|
+
success: true;
|
|
9748
|
+
}
|
|
9749
|
+
/**
|
|
9750
|
+
* users.resetSecondFactor error codes.
|
|
9751
|
+
*
|
|
9752
|
+
* Removes authenticator and recovery codes and revokes every session and trusted device.
|
|
9753
|
+
*/
|
|
9754
|
+
export type UsersResetSecondFactorErrorCode = "ACCOUNT_TARGET_FORBIDDEN" | "CANNOT_MANAGE_OWN_ACCOUNT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9755
|
+
/**
|
|
9756
|
+
* users.revokeMemberSessions input.
|
|
9757
|
+
*
|
|
9758
|
+
* Ends all of the member's sessions across the installation, including legacy tokens. Does not change membership status.
|
|
9759
|
+
*/
|
|
9760
|
+
export interface UsersRevokeMemberSessionsInput {
|
|
9761
|
+
/**
|
|
9762
|
+
* TypeID of the member/user (usr_...).
|
|
9763
|
+
*/
|
|
9764
|
+
user_id: UserId;
|
|
9765
|
+
}
|
|
9766
|
+
/**
|
|
9767
|
+
* users.revokeMemberSessions output.
|
|
9768
|
+
*
|
|
9769
|
+
* Ends all of the member's sessions across the installation, including legacy tokens. Does not change membership status.
|
|
9770
|
+
*/
|
|
9771
|
+
export interface UsersRevokeMemberSessionsOutput {
|
|
9772
|
+
success: true;
|
|
9773
|
+
}
|
|
9774
|
+
/**
|
|
9775
|
+
* users.revokeMemberSessions error codes.
|
|
9776
|
+
*
|
|
9777
|
+
* Ends all of the member's sessions across the installation, including legacy tokens. Does not change membership status.
|
|
9778
|
+
*/
|
|
9779
|
+
export type UsersRevokeMemberSessionsErrorCode = "ACCOUNT_TARGET_FORBIDDEN" | "CANNOT_MANAGE_OWN_ACCOUNT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9036
9780
|
/**
|
|
9037
9781
|
* users.suspendMember input.
|
|
9038
9782
|
*
|
|
@@ -9064,7 +9808,54 @@ export interface UsersSuspendMemberOutput {
|
|
|
9064
9808
|
*
|
|
9065
9809
|
* Suspends a member, blocking their access while keeping the membership. Returns 409 CANNOT_SUSPEND_SELF when the caller targets themselves and 404 MEMBER_NOT_FOUND when the member does not exist.
|
|
9066
9810
|
*/
|
|
9067
|
-
export type UsersSuspendMemberErrorCode = "CANNOT_SUSPEND_SELF" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "LAST_ADMINISTRATOR" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9811
|
+
export type UsersSuspendMemberErrorCode = "CANNOT_SUSPEND_SELF" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "LAST_ADMINISTRATOR" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9812
|
+
/**
|
|
9813
|
+
* users.unlockMember input.
|
|
9814
|
+
*
|
|
9815
|
+
* Resets the installation-wide password lockout. Does not change membership status.
|
|
9816
|
+
*/
|
|
9817
|
+
export interface UsersUnlockMemberInput {
|
|
9818
|
+
/**
|
|
9819
|
+
* TypeID of the member/user (usr_...).
|
|
9820
|
+
*/
|
|
9821
|
+
user_id: UserId;
|
|
9822
|
+
}
|
|
9823
|
+
/**
|
|
9824
|
+
* users.unlockMember output.
|
|
9825
|
+
*
|
|
9826
|
+
* Resets the installation-wide password lockout. Does not change membership status.
|
|
9827
|
+
*/
|
|
9828
|
+
export interface UsersUnlockMemberOutput {
|
|
9829
|
+
success: true;
|
|
9830
|
+
}
|
|
9831
|
+
/**
|
|
9832
|
+
* users.unlockMember error codes.
|
|
9833
|
+
*
|
|
9834
|
+
* Resets the installation-wide password lockout. Does not change membership status.
|
|
9835
|
+
*/
|
|
9836
|
+
export type UsersUnlockMemberErrorCode = "ACCOUNT_TARGET_FORBIDDEN" | "CANNOT_MANAGE_OWN_ACCOUNT" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
9837
|
+
/**
|
|
9838
|
+
* users.updateMyNotificationEmail input.
|
|
9839
|
+
*
|
|
9840
|
+
* Sets whether the calling user wants notification emails.
|
|
9841
|
+
*/
|
|
9842
|
+
export interface UsersUpdateMyNotificationEmailInput {
|
|
9843
|
+
notification_email: boolean;
|
|
9844
|
+
}
|
|
9845
|
+
/**
|
|
9846
|
+
* users.updateMyNotificationEmail output.
|
|
9847
|
+
*
|
|
9848
|
+
* Sets whether the calling user wants notification emails.
|
|
9849
|
+
*/
|
|
9850
|
+
export interface UsersUpdateMyNotificationEmailOutput {
|
|
9851
|
+
notification_email: boolean;
|
|
9852
|
+
}
|
|
9853
|
+
/**
|
|
9854
|
+
* users.updateMyNotificationEmail error codes.
|
|
9855
|
+
*
|
|
9856
|
+
* Sets whether the calling user wants notification emails.
|
|
9857
|
+
*/
|
|
9858
|
+
export type UsersUpdateMyNotificationEmailErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
9068
9859
|
/**
|
|
9069
9860
|
* users.updateMyNotificationToast input.
|
|
9070
9861
|
*
|
|
@@ -9086,7 +9877,7 @@ export interface UsersUpdateMyNotificationToastOutput {
|
|
|
9086
9877
|
*
|
|
9087
9878
|
* Sets whether the calling user wants notification toasts: `follow_org`, `critical_only` or `off`.
|
|
9088
9879
|
*/
|
|
9089
|
-
export type UsersUpdateMyNotificationToastErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
9880
|
+
export type UsersUpdateMyNotificationToastErrorCode = "FORBIDDEN" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
9090
9881
|
/**
|
|
9091
9882
|
* users.updateRole input.
|
|
9092
9883
|
*
|
|
@@ -9122,7 +9913,7 @@ export interface UsersUpdateRoleOutput {
|
|
|
9122
9913
|
*
|
|
9123
9914
|
* Assigns a new role to a member. Returns 422 ROLE_SCOPE_MISMATCH when the role cannot be assigned in this organization context, 404 ROLE_NOT_FOUND when the role does not exist, and 404 MEMBER_NOT_FOUND when the member does not exist.
|
|
9124
9915
|
*/
|
|
9125
|
-
export type UsersUpdateRoleErrorCode = "CANNOT_REMOVE_SELF" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "LAST_ADMINISTRATOR" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "PERMISSION_CEILING_EXCEEDED" | "ROLE_NOT_FOUND" | "ROLE_SCOPE_MISMATCH" | "UNAUTHORIZED";
|
|
9916
|
+
export type UsersUpdateRoleErrorCode = "CANNOT_REMOVE_SELF" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "LAST_ADMINISTRATOR" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "PERMISSION_CEILING_EXCEEDED" | "ROLE_NOT_FOUND" | "ROLE_SCOPE_MISMATCH" | "UNAUTHORIZED";
|
|
9126
9917
|
/**
|
|
9127
9918
|
* visualPlans.clone input.
|
|
9128
9919
|
*
|
|
@@ -9193,7 +9984,7 @@ export interface VisualPlansCloneOutput {
|
|
|
9193
9984
|
*
|
|
9194
9985
|
* Creates a new plan that duplicates the source plan's node graph and settings under a new name. The clone starts unpublished. Returns 404 PLAN_NOT_FOUND when the source plan does not exist.
|
|
9195
9986
|
*/
|
|
9196
|
-
export type VisualPlansCloneErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9987
|
+
export type VisualPlansCloneErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9197
9988
|
/**
|
|
9198
9989
|
* visualPlans.create input.
|
|
9199
9990
|
*
|
|
@@ -9349,7 +10140,7 @@ export interface VisualPlansCreateOutput {
|
|
|
9349
10140
|
*
|
|
9350
10141
|
* Creates a visual plan. When `language` is omitted the organization's default language is used. Setting `transcription_enabled` to `true` requires the AI module, otherwise 403 MODULE_DISABLED is returned.
|
|
9351
10142
|
*/
|
|
9352
|
-
export type VisualPlansCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10143
|
+
export type VisualPlansCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9353
10144
|
/**
|
|
9354
10145
|
* visualPlans.delete input.
|
|
9355
10146
|
*
|
|
@@ -9374,7 +10165,7 @@ export interface VisualPlansDeleteOutput {
|
|
|
9374
10165
|
*
|
|
9375
10166
|
* Deletes a visual plan. Returns 409 DIALER_PLAN_IN_USE when the plan is still referenced by an active dialer campaign, and 404 PLAN_NOT_FOUND when it does not exist. Returns `{ success: true }` on success.
|
|
9376
10167
|
*/
|
|
9377
|
-
export type VisualPlansDeleteErrorCode = "DIALER_PLAN_IN_USE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10168
|
+
export type VisualPlansDeleteErrorCode = "DIALER_PLAN_IN_USE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9378
10169
|
/**
|
|
9379
10170
|
* visualPlans.getById input.
|
|
9380
10171
|
*
|
|
@@ -9451,7 +10242,7 @@ export interface VisualPlansGetByIdOutput {
|
|
|
9451
10242
|
*
|
|
9452
10243
|
* Returns the visual plan together with its working draft and published editor state. Returns 404 PLAN_NOT_FOUND when the plan does not exist or belongs to another organization.
|
|
9453
10244
|
*/
|
|
9454
|
-
export type VisualPlansGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10245
|
+
export type VisualPlansGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9455
10246
|
/**
|
|
9456
10247
|
* visualPlans.importDraft input.
|
|
9457
10248
|
*
|
|
@@ -9536,7 +10327,7 @@ export interface VisualPlansImportDraftOutput {
|
|
|
9536
10327
|
*
|
|
9537
10328
|
* Replaces the visual plan's working draft with a serialized editor state. The state is stored as a draft and is not published; references that do not exist in the destination organization are reported when the plan is published, matching the editor import flow.
|
|
9538
10329
|
*/
|
|
9539
|
-
export type VisualPlansImportDraftErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10330
|
+
export type VisualPlansImportDraftErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9540
10331
|
/**
|
|
9541
10332
|
* visualPlans.list input.
|
|
9542
10333
|
*
|
|
@@ -9693,7 +10484,7 @@ export interface VisualPlansListOutput {
|
|
|
9693
10484
|
*
|
|
9694
10485
|
* Returns a paginated list of visual plans, each including its recording/transcription/speech-analytics settings and the channels currently assigned to it. Pass `status` (`published` or `draft`) to return only plans with or without a published version; the `total` counts the same filtered set. Every item also carries `published_version` (null while never published), `has_unpublished_changes` (draft vs published by the editor's own rules), `last_edited_by` (null for a never-edited plan), `used_by_plans` (live plans using it as a sub-plan) and `calls_7d` (14 daily buckets plus the 7-day total, null without the call_record:read permission). The response adds `counts` (`all`/`published`/`draft` under the current search, ignoring `status`) and `calls_7d_total` (same permission rule). `search` also matches assigned channel identifiers; `sort_by` accepts `calls_7d` (busiest first on desc) whenever calls are visible.
|
|
9695
10486
|
*/
|
|
9696
|
-
export type VisualPlansListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
10487
|
+
export type VisualPlansListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
9697
10488
|
/**
|
|
9698
10489
|
* visualPlans.listVersions input.
|
|
9699
10490
|
*
|
|
@@ -9750,7 +10541,7 @@ export interface VisualPlansListVersionsOutput {
|
|
|
9750
10541
|
*
|
|
9751
10542
|
* Returns the plan's version history along with the id of the currently published version. Returns 404 PLAN_NOT_FOUND when the plan does not exist or belongs to another organization.
|
|
9752
10543
|
*/
|
|
9753
|
-
export type VisualPlansListVersionsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10544
|
+
export type VisualPlansListVersionsErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9754
10545
|
/**
|
|
9755
10546
|
* visualPlans.publish input.
|
|
9756
10547
|
*
|
|
@@ -9846,7 +10637,7 @@ export interface VisualPlansPublishOutput {
|
|
|
9846
10637
|
*
|
|
9847
10638
|
* Validates the draft and creates a new immutable version that immediately starts answering calls and chats. Returns 422 PLAN_VALIDATION_FAILED when the plan has validation errors (including nodes that rely on modules the organization's license has disabled) and 409 DRAFT_STALE when `expectedRevision` no longer matches the current draft. Emits a `plan.published` webhook on success.
|
|
9848
10639
|
*/
|
|
9849
|
-
export type VisualPlansPublishErrorCode = "DRAFT_STALE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "PLAN_VALIDATION_FAILED" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10640
|
+
export type VisualPlansPublishErrorCode = "DRAFT_STALE" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "PLAN_VALIDATION_FAILED" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9850
10641
|
/**
|
|
9851
10642
|
* visualPlans.update input.
|
|
9852
10643
|
*
|
|
@@ -9960,7 +10751,7 @@ export interface VisualPlansUpdateOutput {
|
|
|
9960
10751
|
*
|
|
9961
10752
|
* Partially updates a visual plan's metadata and capture settings. Setting `transcription_enabled` to `true` requires the AI module, otherwise 403 MODULE_DISABLED is returned. This does not modify the plan's node graph (see the draft/publish endpoints).
|
|
9962
10753
|
*/
|
|
9963
|
-
export type VisualPlansUpdateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10754
|
+
export type VisualPlansUpdateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
9964
10755
|
/**
|
|
9965
10756
|
* visualPlans.validate input.
|
|
9966
10757
|
*
|
|
@@ -10012,7 +10803,7 @@ export interface VisualPlansValidateOutput {
|
|
|
10012
10803
|
*
|
|
10013
10804
|
* Validates a plan supplied either by `planId` (the stored draft) or by an inline `execution_plan`, without persisting anything. Returns the overall `valid` flag and a list of issues; nodes that rely on modules disabled for the organization's license are reported as issues.
|
|
10014
10805
|
*/
|
|
10015
|
-
export type VisualPlansValidateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10806
|
+
export type VisualPlansValidateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "SIGNAL_NOT_FOUND" | "UNAUTHORIZED";
|
|
10016
10807
|
/**
|
|
10017
10808
|
* webhooks.deliveries.aggregates.get input.
|
|
10018
10809
|
*
|
|
@@ -10122,7 +10913,7 @@ export interface WebhooksDeliveriesAggregatesGetOutput {
|
|
|
10122
10913
|
*
|
|
10123
10914
|
* Breaks one completed organization-local day down by endpoint, event type and HTTP class, with the raw endpoint/event/outcome/HTTP-class rows behind it. A day outside the aggregate retention window, or one whose individual logs have not been drained yet, returns 404 WEBHOOK_DELIVERY_AGGREGATE_NOT_FOUND. Requires the webhook:read scope.
|
|
10124
10915
|
*/
|
|
10125
|
-
export type WebhooksDeliveriesAggregatesGetErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_AGGREGATE_NOT_FOUND";
|
|
10916
|
+
export type WebhooksDeliveriesAggregatesGetErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_AGGREGATE_NOT_FOUND";
|
|
10126
10917
|
/**
|
|
10127
10918
|
* webhooks.deliveries.aggregates.list input.
|
|
10128
10919
|
*
|
|
@@ -10241,7 +11032,7 @@ export interface WebhooksDeliveriesAggregatesListOutput {
|
|
|
10241
11032
|
*
|
|
10242
11033
|
* Returns one compact result per completed organization-local day. REST query parameters use snake_case. Requires the webhook:read scope.
|
|
10243
11034
|
*/
|
|
10244
|
-
export type WebhooksDeliveriesAggregatesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_CURSOR_INVALID";
|
|
11035
|
+
export type WebhooksDeliveriesAggregatesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_CURSOR_INVALID";
|
|
10245
11036
|
/**
|
|
10246
11037
|
* webhooks.deliveries.count input.
|
|
10247
11038
|
*
|
|
@@ -10280,7 +11071,7 @@ export interface WebhooksDeliveriesCountOutput {
|
|
|
10280
11071
|
*
|
|
10281
11072
|
* Returns the exact filtered webhook delivery-log count. REST query parameters use snake_case. Requires the webhook:read scope.
|
|
10282
11073
|
*/
|
|
10283
|
-
export type WebhooksDeliveriesCountErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
11074
|
+
export type WebhooksDeliveriesCountErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
10284
11075
|
/**
|
|
10285
11076
|
* webhooks.deliveries.getById input.
|
|
10286
11077
|
*
|
|
@@ -10322,7 +11113,7 @@ export type WebhooksDeliveriesGetByIdOutput = {
|
|
|
10322
11113
|
*
|
|
10323
11114
|
* Fetches a single delivery attempt by id, including the payload, response status/body and retry metadata. A missing or cross-org id returns 200 with a null body. Requires the webhook:read scope.
|
|
10324
11115
|
*/
|
|
10325
|
-
export type WebhooksDeliveriesGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
11116
|
+
export type WebhooksDeliveriesGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
10326
11117
|
/**
|
|
10327
11118
|
* webhooks.deliveries.list input.
|
|
10328
11119
|
*
|
|
@@ -10436,7 +11227,7 @@ export interface WebhooksDeliveriesListOutput {
|
|
|
10436
11227
|
*
|
|
10437
11228
|
* Returns webhook delivery metadata with opaque keyset pagination. REST query parameters use snake_case; payload and response bodies are available only from the detail endpoint during the effective payload retention window. Requires the webhook:read scope.
|
|
10438
11229
|
*/
|
|
10439
|
-
export type WebhooksDeliveriesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_CURSOR_INVALID";
|
|
11230
|
+
export type WebhooksDeliveriesListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_CURSOR_INVALID";
|
|
10440
11231
|
/**
|
|
10441
11232
|
* webhooks.deliveries.retention input.
|
|
10442
11233
|
*
|
|
@@ -10491,7 +11282,7 @@ export interface WebhooksDeliveriesRetentionOutput {
|
|
|
10491
11282
|
*
|
|
10492
11283
|
* Returns the effective installation retention windows for full payloads, individual delivery metadata, and daily aggregates. Requires the webhook:read scope.
|
|
10493
11284
|
*/
|
|
10494
|
-
export type WebhooksDeliveriesRetentionErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
11285
|
+
export type WebhooksDeliveriesRetentionErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
10495
11286
|
/**
|
|
10496
11287
|
* webhooks.deliveries.retry input.
|
|
10497
11288
|
*
|
|
@@ -10516,7 +11307,7 @@ export interface WebhooksDeliveriesRetryOutput {
|
|
|
10516
11307
|
*
|
|
10517
11308
|
* Re-queues a failed or pending delivery within the payload retention window for another attempt and returns { success: true }. Delivered events cannot be retried; deliveries whose payload has expired return 409 WEBHOOK_DELIVERY_RETENTION_EXPIRED. Requires the webhook:update scope.
|
|
10518
11309
|
*/
|
|
10519
|
-
export type WebhooksDeliveriesRetryErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_NOT_RETRYABLE" | "WEBHOOK_DELIVERY_RETENTION_EXPIRED";
|
|
11310
|
+
export type WebhooksDeliveriesRetryErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED" | "WEBHOOK_DELIVERY_NOT_RETRYABLE" | "WEBHOOK_DELIVERY_RETENTION_EXPIRED";
|
|
10520
11311
|
/**
|
|
10521
11312
|
* webhooks.endpoints.create input.
|
|
10522
11313
|
*
|
|
@@ -10528,7 +11319,7 @@ export interface WebhooksEndpointsCreateInput {
|
|
|
10528
11319
|
* maxLength: 255
|
|
10529
11320
|
*/
|
|
10530
11321
|
description?: string;
|
|
10531
|
-
events: ("call.started" | "call.answered" | "call.amd_completed" | "call.hangup" | "call.rejected" | "call.node_entered" | "call.node_error" | "call.node_warning" | "call.transcribed" | "call.analysis_completed" | "call.transferred" | "call.recording_available" | "call.intent_matched" | "call.signal_triggered" | "plan.published" | "message.sent" | "dialer.attempt.finished" | "alert.fired" | "alert.resolved" | "service.down" | "service.up")[];
|
|
11322
|
+
events: ("call.started" | "call.answered" | "call.amd_completed" | "call.hangup" | "call.rejected" | "call.node_entered" | "call.node_error" | "call.node_warning" | "call.transcribed" | "call.transcription_failed" | "call.analysis_completed" | "call.transferred" | "call.recording_available" | "call.intent_matched" | "call.signal_triggered" | "plan.published" | "message.sent" | "dialer.attempt.finished" | "alert.fired" | "alert.resolved" | "service.down" | "service.up")[];
|
|
10532
11323
|
/**
|
|
10533
11324
|
* Whether the endpoint is enabled to receive deliveries (defaults to active).
|
|
10534
11325
|
*/
|
|
@@ -10566,7 +11357,7 @@ export interface WebhooksEndpointsCreateOutput {
|
|
|
10566
11357
|
*
|
|
10567
11358
|
* Creates a webhook endpoint subscribed to the given event types. Events whose required module is disabled in the license are silently stripped; if none remain the call returns 403 MODULE_DISABLED. The plaintext signing secret is returned once, only in this response. Requires the webhook:create scope.
|
|
10568
11359
|
*/
|
|
10569
|
-
export type WebhooksEndpointsCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
11360
|
+
export type WebhooksEndpointsCreateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
10570
11361
|
/**
|
|
10571
11362
|
* webhooks.endpoints.delete input.
|
|
10572
11363
|
*
|
|
@@ -10591,7 +11382,7 @@ export interface WebhooksEndpointsDeleteOutput {
|
|
|
10591
11382
|
*
|
|
10592
11383
|
* Soft-deletes a webhook endpoint and returns { success: true }. An unknown id returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:delete scope.
|
|
10593
11384
|
*/
|
|
10594
|
-
export type WebhooksEndpointsDeleteErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
11385
|
+
export type WebhooksEndpointsDeleteErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
10595
11386
|
/**
|
|
10596
11387
|
* webhooks.endpoints.getById input.
|
|
10597
11388
|
*
|
|
@@ -10629,7 +11420,7 @@ export type WebhooksEndpointsGetByIdOutput = {
|
|
|
10629
11420
|
*
|
|
10630
11421
|
* Fetches a single webhook endpoint by id. A missing or cross-org id returns 200 with a null body; the signing secret is never included. Requires the webhook:read scope.
|
|
10631
11422
|
*/
|
|
10632
|
-
export type WebhooksEndpointsGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
11423
|
+
export type WebhooksEndpointsGetByIdErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
10633
11424
|
/**
|
|
10634
11425
|
* webhooks.endpoints.list input.
|
|
10635
11426
|
*
|
|
@@ -10708,7 +11499,7 @@ export interface WebhooksEndpointsListOutput {
|
|
|
10708
11499
|
*
|
|
10709
11500
|
* Returns the org's webhook endpoints as a paginated envelope. The signing secret is never included. Requires the webhook:read scope.
|
|
10710
11501
|
*/
|
|
10711
|
-
export type WebhooksEndpointsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
11502
|
+
export type WebhooksEndpointsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
10712
11503
|
/**
|
|
10713
11504
|
* webhooks.endpoints.rotateSecret input.
|
|
10714
11505
|
*
|
|
@@ -10733,7 +11524,40 @@ export interface WebhooksEndpointsRotateSecretOutput {
|
|
|
10733
11524
|
*
|
|
10734
11525
|
* Generates a new signing secret for the endpoint, invalidating the previous one, and returns the new plaintext secret (shown only in this response). An unknown id returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
|
|
10735
11526
|
*/
|
|
10736
|
-
export type WebhooksEndpointsRotateSecretErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
11527
|
+
export type WebhooksEndpointsRotateSecretErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
11528
|
+
/**
|
|
11529
|
+
* webhooks.endpoints.test input.
|
|
11530
|
+
*
|
|
11531
|
+
* Synchronously sends one signed webhook.test delivery, even to an inactive endpoint, and records the outcome in the delivery log. Returns the delivery id, status, HTTP response status, request duration in milliseconds, and failure reason. Test deliveries are never automatically retried or subscribable. A missing, deleted, or cross-org endpoint returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
|
|
11532
|
+
*/
|
|
11533
|
+
export interface WebhooksEndpointsTestInput {
|
|
11534
|
+
/**
|
|
11535
|
+
* TypeID of the webhook endpoint (whep_...).
|
|
11536
|
+
*/
|
|
11537
|
+
webhook_endpoint_id: WebhookEndpointId;
|
|
11538
|
+
}
|
|
11539
|
+
/**
|
|
11540
|
+
* webhooks.endpoints.test output.
|
|
11541
|
+
*
|
|
11542
|
+
* Synchronously sends one signed webhook.test delivery, even to an inactive endpoint, and records the outcome in the delivery log. Returns the delivery id, status, HTTP response status, request duration in milliseconds, and failure reason. Test deliveries are never automatically retried or subscribable. A missing, deleted, or cross-org endpoint returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
|
|
11543
|
+
*/
|
|
11544
|
+
export interface WebhooksEndpointsTestOutput {
|
|
11545
|
+
delivery_id: WebhookDeliveryLogId;
|
|
11546
|
+
/**
|
|
11547
|
+
* minimum: 0
|
|
11548
|
+
* maximum: 9007199254740991
|
|
11549
|
+
*/
|
|
11550
|
+
duration_ms: number;
|
|
11551
|
+
error_message: string | null;
|
|
11552
|
+
response_status: number | null;
|
|
11553
|
+
status: "delivered" | "failed";
|
|
11554
|
+
}
|
|
11555
|
+
/**
|
|
11556
|
+
* webhooks.endpoints.test error codes.
|
|
11557
|
+
*
|
|
11558
|
+
* Synchronously sends one signed webhook.test delivery, even to an inactive endpoint, and records the outcome in the delivery log. Returns the delivery id, status, HTTP response status, request duration in milliseconds, and failure reason. Test deliveries are never automatically retried or subscribable. A missing, deleted, or cross-org endpoint returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
|
|
11559
|
+
*/
|
|
11560
|
+
export type WebhooksEndpointsTestErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
10737
11561
|
/**
|
|
10738
11562
|
* webhooks.endpoints.update input.
|
|
10739
11563
|
*
|
|
@@ -10749,7 +11573,7 @@ export interface WebhooksEndpointsUpdateInput {
|
|
|
10749
11573
|
* maxLength: 255
|
|
10750
11574
|
*/
|
|
10751
11575
|
description?: string;
|
|
10752
|
-
events?: ("call.started" | "call.answered" | "call.amd_completed" | "call.hangup" | "call.rejected" | "call.node_entered" | "call.node_error" | "call.node_warning" | "call.transcribed" | "call.analysis_completed" | "call.transferred" | "call.recording_available" | "call.intent_matched" | "call.signal_triggered" | "plan.published" | "message.sent" | "dialer.attempt.finished" | "alert.fired" | "alert.resolved" | "service.down" | "service.up")[];
|
|
11576
|
+
events?: ("call.started" | "call.answered" | "call.amd_completed" | "call.hangup" | "call.rejected" | "call.node_entered" | "call.node_error" | "call.node_warning" | "call.transcribed" | "call.transcription_failed" | "call.analysis_completed" | "call.transferred" | "call.recording_available" | "call.intent_matched" | "call.signal_triggered" | "plan.published" | "message.sent" | "dialer.attempt.finished" | "alert.fired" | "alert.resolved" | "service.down" | "service.up")[];
|
|
10753
11577
|
/**
|
|
10754
11578
|
* Enable or disable deliveries for the endpoint.
|
|
10755
11579
|
*/
|
|
@@ -10786,7 +11610,7 @@ export interface WebhooksEndpointsUpdateOutput {
|
|
|
10786
11610
|
*
|
|
10787
11611
|
* Partially updates a webhook endpoint. When events are supplied, those whose required module is disabled are stripped and an empty resulting set returns 403 MODULE_DISABLED. An unknown id returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
|
|
10788
11612
|
*/
|
|
10789
|
-
export type WebhooksEndpointsUpdateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
11613
|
+
export type WebhooksEndpointsUpdateErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED" | "WEBHOOK_ENDPOINT_NOT_FOUND";
|
|
10790
11614
|
/**
|
|
10791
11615
|
* webhooks.events.list input.
|
|
10792
11616
|
*
|
|
@@ -10799,7 +11623,7 @@ export type WebhooksEventsListInput = void;
|
|
|
10799
11623
|
* Returns the technical fields, required module metadata, and example payload for every webhook event. The call.analysis_completed schema documents one aggregate delivery containing all parallel analysis results, including per-analysis failures. Requires the webhook:read scope.
|
|
10800
11624
|
*/
|
|
10801
11625
|
export type WebhooksEventsListOutput = {
|
|
10802
|
-
event: "call.started" | "call.answered" | "call.amd_completed" | "call.hangup" | "call.rejected" | "call.node_entered" | "call.node_error" | "call.node_warning" | "call.transcribed" | "call.analysis_completed" | "call.transferred" | "call.recording_available" | "call.intent_matched" | "call.signal_triggered" | "plan.published" | "message.sent" | "dialer.attempt.finished" | "alert.fired" | "alert.resolved" | "service.down" | "service.up";
|
|
11626
|
+
event: "call.started" | "call.answered" | "call.amd_completed" | "call.hangup" | "call.rejected" | "call.node_entered" | "call.node_error" | "call.node_warning" | "call.transcribed" | "call.transcription_failed" | "call.analysis_completed" | "call.transferred" | "call.recording_available" | "call.intent_matched" | "call.signal_triggered" | "plan.published" | "message.sent" | "dialer.attempt.finished" | "alert.fired" | "alert.resolved" | "service.down" | "service.up" | "webhook.test";
|
|
10803
11627
|
example: {
|
|
10804
11628
|
[key: string]: NivaJsonValue;
|
|
10805
11629
|
};
|
|
@@ -10816,13 +11640,13 @@ export type WebhooksEventsListOutput = {
|
|
|
10816
11640
|
*
|
|
10817
11641
|
* Returns the technical fields, required module metadata, and example payload for every webhook event. The call.analysis_completed schema documents one aggregate delivery containing all parallel analysis results, including per-analysis failures. Requires the webhook:read scope.
|
|
10818
11642
|
*/
|
|
10819
|
-
export type WebhooksEventsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "UNAUTHORIZED";
|
|
11643
|
+
export type WebhooksEventsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
10820
11644
|
/** Every distinct declared error code, referenced by index from OPERATIONS. */
|
|
10821
|
-
export declare const ERROR_CODES: readonly ["ACTIVE_CALL_NOT_FOUND", "AI_INVALID_API_KEY", "AI_NOT_CONFIGURED", "AI_UNREACHABLE", "ALREADY_MEMBER", "API_KEY_EXPIRED", "API_KEY_NOT_FOUND", "ARCHIVE_ITEM_IN_USE", "ARCHIVE_ITEM_NOT_FOUND", "ARCHIVE_RESTORE_CONFLICT", "AUDIO_FILE_CONTENT_MISSING", "AUDIO_FILE_INVALID_FORMAT", "AUDIO_FILE_IN_USE", "AUDIO_FILE_NOT_FOUND", "AUDIO_FILE_NOT_TTS", "AUDIO_FILE_TOO_LARGE", "AUDIO_URL_BLOCKED", "AUDIO_URL_DECODE_FAILED", "AUDIO_URL_HTTP_ERROR", "AUDIO_URL_INVALID", "AUDIO_URL_TIMEOUT", "AUDIO_URL_TOO_LARGE", "AUDIO_URL_UNREACHABLE", "AUDIO_URL_UNSUPPORTED_FORMAT", "AUDIT_CURSOR_INVALID", "CALL_HAS_NO_TRANSCRIPTION_WINDOW", "CALL_NOT_FOUND", "CALL_RECORD_CURSOR_INVALID", "
|
|
11645
|
+
export declare const ERROR_CODES: readonly ["ACCOUNT_TARGET_FORBIDDEN", "ACTIVE_CALL_NOT_FOUND", "AI_INVALID_API_KEY", "AI_NOT_CONFIGURED", "AI_UNREACHABLE", "ALREADY_MEMBER", "API_KEY_EXPIRED", "API_KEY_NOT_FOUND", "ARCHIVE_ITEM_IN_USE", "ARCHIVE_ITEM_NOT_FOUND", "ARCHIVE_RESTORE_CONFLICT", "AUDIO_FILE_CONTENT_MISSING", "AUDIO_FILE_INVALID_FORMAT", "AUDIO_FILE_IN_USE", "AUDIO_FILE_NOT_FOUND", "AUDIO_FILE_NOT_TTS", "AUDIO_FILE_TOO_LARGE", "AUDIO_URL_BLOCKED", "AUDIO_URL_DECODE_FAILED", "AUDIO_URL_HTTP_ERROR", "AUDIO_URL_INVALID", "AUDIO_URL_TIMEOUT", "AUDIO_URL_TOO_LARGE", "AUDIO_URL_UNREACHABLE", "AUDIO_URL_UNSUPPORTED_FORMAT", "AUDIT_CURSOR_INVALID", "BUG_REPORTING_DISABLED", "BUG_REPORT_DELIVERY_FAILED", "CALL_HAS_NO_TRANSCRIPTION_WINDOW", "CALL_NOT_FOUND", "CALL_RECORD_CURSOR_INVALID", "CANNOT_MANAGE_OWN_ACCOUNT", "CANNOT_REMOVE_SELF", "CANNOT_SUSPEND_SELF", "CHANNEL_ALREADY_ASSIGNED", "CHANNEL_CONNECTOR_NOT_ALLOWED", "CHANNEL_CONNECTOR_REQUIRED", "CHANNEL_CONNECTOR_UNAVAILABLE", "CHANNEL_INVALID_CREDENTIALS", "CHANNEL_NOT_FOUND", "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR", "CONTACT_NOT_FOUND", "DECISIONS_UNAVAILABLE", "DESTINATION_NOT_FOUND", "DIALER_CAMPAIGN_INVALID_TRANSITION", "DIALER_CAMPAIGN_NOT_FOUND", "DIALER_CAMPAIGN_NO_CONTACTS", "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED", "DIALER_CONTACT_DUPLICATE", "DIALER_CONTACT_NOT_EDITABLE", "DIALER_CONTACT_NOT_REQUEUEABLE", "DIALER_DNC_DUPLICATE", "DIALER_IMPORT_INVALID", "DIALER_IMPORT_JOB_NOT_FOUND", "DIALER_MODULE_DISABLED", "DIALER_PLAN_IN_USE", "DRAFT_STALE", "DUPLICATE_CHANNEL", "DUPLICATE_EMAIL", "DUPLICATE_SIGNAL_SLUG", "ESL_CONNECTION_ERROR", "FEATURE_DISABLED", "FORBIDDEN", "HANGUP_FAILED", "HOLIDAY_GROUP_NOT_FOUND", "HOLIDAY_NOT_FOUND", "INSIGHT_PERIOD_TOO_LONG", "INSUFFICIENT_PERMISSIONS", "INSUFFICIENT_SCOPE", "INVALID_EXPORT_COLUMNS", "LAST_ADMINISTRATOR", "MEMBER_NOT_FOUND", "MEMBER_SUSPENDED", "MFA_SETUP_REQUIRED", "MODULE_DISABLED", "NAGER_API_ERROR", "NEW_USER_REQUIRES_PASSWORD", "NODE_NOT_IN_TRACE", "NODE_RANGE_INVALID", "OAUTH_GRANT_FORBIDDEN", "OAUTH_GRANT_NOT_FOUND", "ORIGINATE_CAPACITY_EXCEEDED", "ORIGINATE_DESTINATION_NOT_ROUTABLE", "ORIGINATE_FAILED", "ORIGINATE_PLAN_NOT_PUBLISHED", "PERMISSION_CEILING_EXCEEDED", "PLAN_NOT_FOUND", "PLAN_VALIDATION_FAILED", "RANGE_HAS_NO_AUDIO", "RANGE_NOT_APPLICABLE", "RANGE_NOT_SATISFIABLE", "RECORDING_CONTENT_MISSING", "RECORDING_NOT_FOUND", "ROLE_NOT_FOUND", "ROLE_SCOPE_MISMATCH", "SCHEDULE_NOT_FOUND", "SELF_ROTATION_FORBIDDEN", "SIGNAL_ALERT_OPTION_REMOVED", "SIGNAL_ARCHIVED", "SIGNAL_DEFINITION_INVALID", "SIGNAL_KIND_IMMUTABLE", "SIGNAL_NOT_FOUND", "SIGNAL_TEST_NO_TRANSCRIPTION", "SIGNAL_TEST_SOURCE_INVALID", "SIGNAL_VERSION_CONFLICT", "SSO_REQUIRED", "TRANSCRIPTION_CAPACITY_EXCEEDED", "TRANSCRIPTION_NOT_FOUND", "TTS_VOICE_UNAVAILABLE", "UNAUTHORIZED", "WEBHOOK_DELIVERY_AGGREGATE_NOT_FOUND", "WEBHOOK_DELIVERY_CURSOR_INVALID", "WEBHOOK_DELIVERY_NOT_RETRYABLE", "WEBHOOK_DELIVERY_RETENTION_EXPIRED", "WEBHOOK_ENDPOINT_NOT_FOUND"];
|
|
10822
11646
|
/** Declared codes shared by every operation (indexes into ERROR_CODES). */
|
|
10823
|
-
export declare const COMMON_ERROR_CODES: readonly [
|
|
11647
|
+
export declare const COMMON_ERROR_CODES: readonly [62, 72, 73, 109];
|
|
10824
11648
|
/** Distinct per-operation code sets beyond COMMON_ERROR_CODES, as indexes into ERROR_CODES. */
|
|
10825
|
-
export declare const ERROR_CODE_SETS: readonly [readonly [], readonly [
|
|
11649
|
+
export declare const ERROR_CODE_SETS: readonly [readonly [], readonly [26, 27], readonly [67, 68], readonly [29, 67, 68], readonly [30, 67, 68], readonly [43, 67, 68], readonly [64, 67, 68], readonly [65, 67, 68], readonly [67, 68, 110], readonly [67, 68, 111], readonly [67, 68, 69], readonly [67, 68, 74], readonly [67, 68, 75], readonly [67, 68, 95], readonly [7, 67, 68], readonly [11, 14, 67, 68], readonly [12, 16, 67, 68], readonly [25, 67, 68, 74], readonly [41, 67, 68, 74], readonly [64, 67, 68, 75], readonly [66, 67, 68, 74], readonly [67, 68, 112, 113], readonly [67, 68, 71, 85], readonly [67, 68, 74, 114], readonly [67, 68, 79, 80], readonly [1, 60, 63, 67, 68], readonly [2, 3, 4, 67, 68], readonly [41, 50, 67, 68, 74], readonly [51, 52, 67, 68, 74], readonly [6, 7, 67, 68, 96], readonly [61, 67, 68, 74, 107], readonly [67, 68, 74, 86, 101], readonly [0, 31, 67, 68, 71, 85], readonly [2, 3, 4, 67, 68, 108], readonly [2, 3, 4, 67, 68, 74], readonly [29, 67, 68, 90, 91, 92], readonly [32, 67, 68, 70, 71, 85], readonly [33, 67, 68, 70, 71, 85], readonly [41, 45, 52, 67, 68, 74], readonly [45, 52, 53, 67, 68, 74], readonly [55, 67, 68, 74, 86, 101], readonly [8, 9, 10, 67, 68, 74], readonly [41, 48, 49, 52, 67, 68, 74], readonly [56, 67, 68, 74, 86, 87, 101], readonly [32, 67, 68, 70, 71, 85, 93, 94], readonly [44, 45, 46, 47, 54, 67, 68, 74], readonly [2, 3, 4, 13, 14, 15, 67, 68, 108], readonly [44, 45, 46, 47, 54, 67, 68, 74, 86], readonly [5, 58, 67, 68, 76, 85, 93, 94, 105], readonly [60, 61, 67, 68, 81, 82, 83, 84, 86], readonly [17, 18, 19, 20, 21, 22, 23, 24, 67, 68], readonly [3, 28, 67, 68, 74, 77, 78, 88, 89, 92, 106], readonly [34, 35, 36, 37, 38, 39, 40, 57, 67, 68, 74], readonly [29, 42, 59, 67, 68, 74, 86, 97, 98, 99, 100, 101, 102, 103, 104]];
|
|
10826
11650
|
/** Data-only operation table: transport metadata, no types. */
|
|
10827
11651
|
export declare const OPERATIONS: {
|
|
10828
11652
|
readonly "ai.getBudget": {
|
|
@@ -10850,7 +11674,7 @@ export declare const OPERATIONS: {
|
|
|
10850
11674
|
readonly queryParams: readonly [];
|
|
10851
11675
|
readonly bodyKind: "none";
|
|
10852
11676
|
readonly responseKind: "json";
|
|
10853
|
-
readonly codes:
|
|
11677
|
+
readonly codes: 2;
|
|
10854
11678
|
};
|
|
10855
11679
|
readonly "ai.getTranscription": {
|
|
10856
11680
|
readonly method: "GET";
|
|
@@ -10859,7 +11683,7 @@ export declare const OPERATIONS: {
|
|
|
10859
11683
|
readonly queryParams: readonly [];
|
|
10860
11684
|
readonly bodyKind: "none";
|
|
10861
11685
|
readonly responseKind: "json";
|
|
10862
|
-
readonly codes:
|
|
11686
|
+
readonly codes: 2;
|
|
10863
11687
|
};
|
|
10864
11688
|
readonly "ai.getUsage": {
|
|
10865
11689
|
readonly method: "GET";
|
|
@@ -10877,7 +11701,7 @@ export declare const OPERATIONS: {
|
|
|
10877
11701
|
readonly queryParams: readonly [];
|
|
10878
11702
|
readonly bodyKind: "none";
|
|
10879
11703
|
readonly responseKind: "json";
|
|
10880
|
-
readonly codes:
|
|
11704
|
+
readonly codes: 34;
|
|
10881
11705
|
};
|
|
10882
11706
|
readonly "ai.listStructuredAnalyses": {
|
|
10883
11707
|
readonly method: "GET";
|
|
@@ -10931,7 +11755,7 @@ export declare const OPERATIONS: {
|
|
|
10931
11755
|
readonly queryParams: readonly [];
|
|
10932
11756
|
readonly bodyKind: "json";
|
|
10933
11757
|
readonly responseKind: "json";
|
|
10934
|
-
readonly codes:
|
|
11758
|
+
readonly codes: 51;
|
|
10935
11759
|
};
|
|
10936
11760
|
readonly "apiKeys.create": {
|
|
10937
11761
|
readonly method: "POST";
|
|
@@ -10940,7 +11764,7 @@ export declare const OPERATIONS: {
|
|
|
10940
11764
|
readonly queryParams: readonly [];
|
|
10941
11765
|
readonly bodyKind: "json";
|
|
10942
11766
|
readonly responseKind: "json";
|
|
10943
|
-
readonly codes:
|
|
11767
|
+
readonly codes: 2;
|
|
10944
11768
|
};
|
|
10945
11769
|
readonly "apiKeys.finishRotation": {
|
|
10946
11770
|
readonly method: "POST";
|
|
@@ -10949,7 +11773,7 @@ export declare const OPERATIONS: {
|
|
|
10949
11773
|
readonly queryParams: readonly [];
|
|
10950
11774
|
readonly bodyKind: "none";
|
|
10951
11775
|
readonly responseKind: "json";
|
|
10952
|
-
readonly codes:
|
|
11776
|
+
readonly codes: 14;
|
|
10953
11777
|
};
|
|
10954
11778
|
readonly "apiKeys.get": {
|
|
10955
11779
|
readonly method: "GET";
|
|
@@ -10958,7 +11782,7 @@ export declare const OPERATIONS: {
|
|
|
10958
11782
|
readonly queryParams: readonly [];
|
|
10959
11783
|
readonly bodyKind: "none";
|
|
10960
11784
|
readonly responseKind: "json";
|
|
10961
|
-
readonly codes:
|
|
11785
|
+
readonly codes: 14;
|
|
10962
11786
|
};
|
|
10963
11787
|
readonly "apiKeys.list": {
|
|
10964
11788
|
readonly method: "GET";
|
|
@@ -10967,7 +11791,7 @@ export declare const OPERATIONS: {
|
|
|
10967
11791
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
10968
11792
|
readonly bodyKind: "none";
|
|
10969
11793
|
readonly responseKind: "json";
|
|
10970
|
-
readonly codes:
|
|
11794
|
+
readonly codes: 2;
|
|
10971
11795
|
};
|
|
10972
11796
|
readonly "apiKeys.revoke": {
|
|
10973
11797
|
readonly method: "DELETE";
|
|
@@ -10976,7 +11800,7 @@ export declare const OPERATIONS: {
|
|
|
10976
11800
|
readonly queryParams: readonly [];
|
|
10977
11801
|
readonly bodyKind: "none";
|
|
10978
11802
|
readonly responseKind: "json";
|
|
10979
|
-
readonly codes:
|
|
11803
|
+
readonly codes: 14;
|
|
10980
11804
|
};
|
|
10981
11805
|
readonly "apiKeys.rotate": {
|
|
10982
11806
|
readonly method: "POST";
|
|
@@ -10994,7 +11818,7 @@ export declare const OPERATIONS: {
|
|
|
10994
11818
|
readonly queryParams: readonly [];
|
|
10995
11819
|
readonly bodyKind: "json";
|
|
10996
11820
|
readonly responseKind: "json";
|
|
10997
|
-
readonly codes:
|
|
11821
|
+
readonly codes: 14;
|
|
10998
11822
|
};
|
|
10999
11823
|
readonly "apiKeys.usage": {
|
|
11000
11824
|
readonly method: "GET";
|
|
@@ -11003,7 +11827,7 @@ export declare const OPERATIONS: {
|
|
|
11003
11827
|
readonly queryParams: readonly ["days"];
|
|
11004
11828
|
readonly bodyKind: "none";
|
|
11005
11829
|
readonly responseKind: "json";
|
|
11006
|
-
readonly codes:
|
|
11830
|
+
readonly codes: 14;
|
|
11007
11831
|
};
|
|
11008
11832
|
readonly "archive.listDeleted": {
|
|
11009
11833
|
readonly method: "GET";
|
|
@@ -11012,7 +11836,7 @@ export declare const OPERATIONS: {
|
|
|
11012
11836
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "entity_type"];
|
|
11013
11837
|
readonly bodyKind: "none";
|
|
11014
11838
|
readonly responseKind: "json";
|
|
11015
|
-
readonly codes:
|
|
11839
|
+
readonly codes: 41;
|
|
11016
11840
|
};
|
|
11017
11841
|
readonly "archive.purge": {
|
|
11018
11842
|
readonly method: "DELETE";
|
|
@@ -11021,7 +11845,7 @@ export declare const OPERATIONS: {
|
|
|
11021
11845
|
readonly queryParams: readonly [];
|
|
11022
11846
|
readonly bodyKind: "none";
|
|
11023
11847
|
readonly responseKind: "json";
|
|
11024
|
-
readonly codes:
|
|
11848
|
+
readonly codes: 41;
|
|
11025
11849
|
};
|
|
11026
11850
|
readonly "archive.restore": {
|
|
11027
11851
|
readonly method: "POST";
|
|
@@ -11030,7 +11854,7 @@ export declare const OPERATIONS: {
|
|
|
11030
11854
|
readonly queryParams: readonly [];
|
|
11031
11855
|
readonly bodyKind: "none";
|
|
11032
11856
|
readonly responseKind: "json";
|
|
11033
|
-
readonly codes:
|
|
11857
|
+
readonly codes: 41;
|
|
11034
11858
|
};
|
|
11035
11859
|
readonly "archive.summary": {
|
|
11036
11860
|
readonly method: "GET";
|
|
@@ -11039,7 +11863,7 @@ export declare const OPERATIONS: {
|
|
|
11039
11863
|
readonly queryParams: readonly [];
|
|
11040
11864
|
readonly bodyKind: "none";
|
|
11041
11865
|
readonly responseKind: "json";
|
|
11042
|
-
readonly codes:
|
|
11866
|
+
readonly codes: 41;
|
|
11043
11867
|
};
|
|
11044
11868
|
readonly "audioFiles.content": {
|
|
11045
11869
|
readonly method: "GET";
|
|
@@ -11048,7 +11872,7 @@ export declare const OPERATIONS: {
|
|
|
11048
11872
|
readonly queryParams: readonly [];
|
|
11049
11873
|
readonly bodyKind: "none";
|
|
11050
11874
|
readonly responseKind: "binary";
|
|
11051
|
-
readonly codes:
|
|
11875
|
+
readonly codes: 15;
|
|
11052
11876
|
};
|
|
11053
11877
|
readonly "audioFiles.delete": {
|
|
11054
11878
|
readonly method: "DELETE";
|
|
@@ -11057,7 +11881,7 @@ export declare const OPERATIONS: {
|
|
|
11057
11881
|
readonly queryParams: readonly [];
|
|
11058
11882
|
readonly bodyKind: "none";
|
|
11059
11883
|
readonly responseKind: "json";
|
|
11060
|
-
readonly codes:
|
|
11884
|
+
readonly codes: 46;
|
|
11061
11885
|
};
|
|
11062
11886
|
readonly "audioFiles.generateTts": {
|
|
11063
11887
|
readonly method: "POST";
|
|
@@ -11066,7 +11890,7 @@ export declare const OPERATIONS: {
|
|
|
11066
11890
|
readonly queryParams: readonly [];
|
|
11067
11891
|
readonly bodyKind: "json";
|
|
11068
11892
|
readonly responseKind: "json";
|
|
11069
|
-
readonly codes:
|
|
11893
|
+
readonly codes: 46;
|
|
11070
11894
|
};
|
|
11071
11895
|
readonly "audioFiles.getById": {
|
|
11072
11896
|
readonly method: "GET";
|
|
@@ -11075,7 +11899,7 @@ export declare const OPERATIONS: {
|
|
|
11075
11899
|
readonly queryParams: readonly [];
|
|
11076
11900
|
readonly bodyKind: "none";
|
|
11077
11901
|
readonly responseKind: "json";
|
|
11078
|
-
readonly codes:
|
|
11902
|
+
readonly codes: 46;
|
|
11079
11903
|
};
|
|
11080
11904
|
readonly "audioFiles.list": {
|
|
11081
11905
|
readonly method: "GET";
|
|
@@ -11084,7 +11908,7 @@ export declare const OPERATIONS: {
|
|
|
11084
11908
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
11085
11909
|
readonly bodyKind: "none";
|
|
11086
11910
|
readonly responseKind: "json";
|
|
11087
|
-
readonly codes:
|
|
11911
|
+
readonly codes: 2;
|
|
11088
11912
|
};
|
|
11089
11913
|
readonly "audioFiles.previewUrl": {
|
|
11090
11914
|
readonly method: "POST";
|
|
@@ -11093,7 +11917,7 @@ export declare const OPERATIONS: {
|
|
|
11093
11917
|
readonly queryParams: readonly [];
|
|
11094
11918
|
readonly bodyKind: "json";
|
|
11095
11919
|
readonly responseKind: "binary";
|
|
11096
|
-
readonly codes:
|
|
11920
|
+
readonly codes: 50;
|
|
11097
11921
|
};
|
|
11098
11922
|
readonly "audioFiles.regenerateTts": {
|
|
11099
11923
|
readonly method: "POST";
|
|
@@ -11102,7 +11926,7 @@ export declare const OPERATIONS: {
|
|
|
11102
11926
|
readonly queryParams: readonly [];
|
|
11103
11927
|
readonly bodyKind: "json";
|
|
11104
11928
|
readonly responseKind: "json";
|
|
11105
|
-
readonly codes:
|
|
11929
|
+
readonly codes: 46;
|
|
11106
11930
|
};
|
|
11107
11931
|
readonly "audioFiles.update": {
|
|
11108
11932
|
readonly method: "PATCH";
|
|
@@ -11111,7 +11935,7 @@ export declare const OPERATIONS: {
|
|
|
11111
11935
|
readonly queryParams: readonly [];
|
|
11112
11936
|
readonly bodyKind: "json";
|
|
11113
11937
|
readonly responseKind: "json";
|
|
11114
|
-
readonly codes:
|
|
11938
|
+
readonly codes: 46;
|
|
11115
11939
|
};
|
|
11116
11940
|
readonly "audioFiles.upload": {
|
|
11117
11941
|
readonly method: "POST";
|
|
@@ -11120,7 +11944,7 @@ export declare const OPERATIONS: {
|
|
|
11120
11944
|
readonly queryParams: readonly [];
|
|
11121
11945
|
readonly bodyKind: "multipart";
|
|
11122
11946
|
readonly responseKind: "json";
|
|
11123
|
-
readonly codes:
|
|
11947
|
+
readonly codes: 16;
|
|
11124
11948
|
};
|
|
11125
11949
|
readonly "audit.count": {
|
|
11126
11950
|
readonly method: "GET";
|
|
@@ -11147,7 +11971,16 @@ export declare const OPERATIONS: {
|
|
|
11147
11971
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "action", "actions", "resource_type", "resource_types", "auth_kind", "credential_id", "retention_class", "date_from", "date_to", "cursor"];
|
|
11148
11972
|
readonly bodyKind: "none";
|
|
11149
11973
|
readonly responseKind: "json";
|
|
11150
|
-
readonly codes:
|
|
11974
|
+
readonly codes: 17;
|
|
11975
|
+
};
|
|
11976
|
+
readonly "bugReports.create": {
|
|
11977
|
+
readonly method: "POST";
|
|
11978
|
+
readonly path: "/bug-reports";
|
|
11979
|
+
readonly pathParams: readonly [];
|
|
11980
|
+
readonly queryParams: readonly [];
|
|
11981
|
+
readonly bodyKind: "json";
|
|
11982
|
+
readonly responseKind: "json";
|
|
11983
|
+
readonly codes: 1;
|
|
11151
11984
|
};
|
|
11152
11985
|
readonly "callRecords.count": {
|
|
11153
11986
|
readonly method: "GET";
|
|
@@ -11156,13 +11989,13 @@ export declare const OPERATIONS: {
|
|
|
11156
11989
|
readonly queryParams: readonly ["search", "call_record_id", "uuid", "sip_call_id", "date_from", "date_to", "visual_plan_id", "channel_id", "status", "caller_search", "min_duration", "max_duration", "has_recording", "has_transcription", "recording_states", "transcription_states", "analysis_states", "has_error", "has_structured_analysis", "has_structured_analysis_error", "channel_type", "origin", "signal_id", "signal_triggered", "signal_value", "metadata"];
|
|
11157
11990
|
readonly bodyKind: "none";
|
|
11158
11991
|
readonly responseKind: "json";
|
|
11159
|
-
readonly codes:
|
|
11992
|
+
readonly codes: 2;
|
|
11160
11993
|
};
|
|
11161
11994
|
readonly "callRecords.exportCsv": {
|
|
11162
11995
|
readonly method: "GET";
|
|
11163
11996
|
readonly path: "/call-records/export";
|
|
11164
11997
|
readonly pathParams: readonly [];
|
|
11165
|
-
readonly queryParams: readonly ["date_from", "date_to", "visual_plan_id", "channel_id", "status", "search", "min_duration", "max_duration", "channel_type", "origin", "signal_id", "signal_triggered", "signal_value", "has_structured_analysis", "has_structured_analysis_error", "metadata", "apply_table_filters", "separator", "columns", "include_events"];
|
|
11998
|
+
readonly queryParams: readonly ["date_from", "date_to", "visual_plan_id", "channel_id", "status", "search", "min_duration", "max_duration", "channel_type", "origin", "signal_id", "signal_triggered", "signal_value", "has_recording", "has_transcription", "recording_states", "transcription_states", "analysis_states", "has_error", "has_structured_analysis", "has_structured_analysis_error", "metadata", "apply_table_filters", "separator", "columns", "include_events"];
|
|
11166
11999
|
readonly bodyKind: "none";
|
|
11167
12000
|
readonly responseKind: "sse";
|
|
11168
12001
|
readonly codes: 10;
|
|
@@ -11174,7 +12007,7 @@ export declare const OPERATIONS: {
|
|
|
11174
12007
|
readonly queryParams: readonly [];
|
|
11175
12008
|
readonly bodyKind: "none";
|
|
11176
12009
|
readonly responseKind: "json";
|
|
11177
|
-
readonly codes:
|
|
12010
|
+
readonly codes: 2;
|
|
11178
12011
|
};
|
|
11179
12012
|
readonly "callRecords.getEvents": {
|
|
11180
12013
|
readonly method: "GET";
|
|
@@ -11183,7 +12016,7 @@ export declare const OPERATIONS: {
|
|
|
11183
12016
|
readonly queryParams: readonly [];
|
|
11184
12017
|
readonly bodyKind: "none";
|
|
11185
12018
|
readonly responseKind: "json";
|
|
11186
|
-
readonly codes:
|
|
12019
|
+
readonly codes: 2;
|
|
11187
12020
|
};
|
|
11188
12021
|
readonly "callRecords.getRecordingUrl": {
|
|
11189
12022
|
readonly method: "GET";
|
|
@@ -11192,7 +12025,7 @@ export declare const OPERATIONS: {
|
|
|
11192
12025
|
readonly queryParams: readonly ["ttl_seconds"];
|
|
11193
12026
|
readonly bodyKind: "none";
|
|
11194
12027
|
readonly responseKind: "json";
|
|
11195
|
-
readonly codes:
|
|
12028
|
+
readonly codes: 2;
|
|
11196
12029
|
};
|
|
11197
12030
|
readonly "callRecords.list": {
|
|
11198
12031
|
readonly method: "GET";
|
|
@@ -11201,7 +12034,7 @@ export declare const OPERATIONS: {
|
|
|
11201
12034
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "call_record_id", "uuid", "sip_call_id", "date_from", "date_to", "visual_plan_id", "channel_id", "status", "caller_search", "min_duration", "max_duration", "has_recording", "has_transcription", "recording_states", "transcription_states", "analysis_states", "has_error", "has_structured_analysis", "has_structured_analysis_error", "channel_type", "origin", "signal_id", "signal_triggered", "signal_value", "include_signals", "metadata", "cursor"];
|
|
11202
12035
|
readonly bodyKind: "none";
|
|
11203
12036
|
readonly responseKind: "json";
|
|
11204
|
-
readonly codes:
|
|
12037
|
+
readonly codes: 4;
|
|
11205
12038
|
};
|
|
11206
12039
|
readonly "callRecords.purgeVoiceContent": {
|
|
11207
12040
|
readonly method: "POST";
|
|
@@ -11210,7 +12043,7 @@ export declare const OPERATIONS: {
|
|
|
11210
12043
|
readonly queryParams: readonly [];
|
|
11211
12044
|
readonly bodyKind: "none";
|
|
11212
12045
|
readonly responseKind: "json";
|
|
11213
|
-
readonly codes:
|
|
12046
|
+
readonly codes: 3;
|
|
11214
12047
|
};
|
|
11215
12048
|
readonly "callRecords.recordingContent": {
|
|
11216
12049
|
readonly method: "GET";
|
|
@@ -11219,7 +12052,7 @@ export declare const OPERATIONS: {
|
|
|
11219
12052
|
readonly queryParams: readonly [];
|
|
11220
12053
|
readonly bodyKind: "none";
|
|
11221
12054
|
readonly responseKind: "binary";
|
|
11222
|
-
readonly codes:
|
|
12055
|
+
readonly codes: 35;
|
|
11223
12056
|
};
|
|
11224
12057
|
readonly "callRecords.retryRecording": {
|
|
11225
12058
|
readonly method: "POST";
|
|
@@ -11228,7 +12061,7 @@ export declare const OPERATIONS: {
|
|
|
11228
12061
|
readonly queryParams: readonly [];
|
|
11229
12062
|
readonly bodyKind: "none";
|
|
11230
12063
|
readonly responseKind: "json";
|
|
11231
|
-
readonly codes:
|
|
12064
|
+
readonly codes: 2;
|
|
11232
12065
|
};
|
|
11233
12066
|
readonly "calls.hangupCall": {
|
|
11234
12067
|
readonly method: "POST";
|
|
@@ -11237,7 +12070,7 @@ export declare const OPERATIONS: {
|
|
|
11237
12070
|
readonly queryParams: readonly [];
|
|
11238
12071
|
readonly bodyKind: "none";
|
|
11239
12072
|
readonly responseKind: "json";
|
|
11240
|
-
readonly codes:
|
|
12073
|
+
readonly codes: 25;
|
|
11241
12074
|
};
|
|
11242
12075
|
readonly "calls.originate": {
|
|
11243
12076
|
readonly method: "POST";
|
|
@@ -11246,7 +12079,7 @@ export declare const OPERATIONS: {
|
|
|
11246
12079
|
readonly queryParams: readonly [];
|
|
11247
12080
|
readonly bodyKind: "json";
|
|
11248
12081
|
readonly responseKind: "json";
|
|
11249
|
-
readonly codes:
|
|
12082
|
+
readonly codes: 49;
|
|
11250
12083
|
};
|
|
11251
12084
|
readonly "capabilities.get": {
|
|
11252
12085
|
readonly method: "GET";
|
|
@@ -11264,7 +12097,7 @@ export declare const OPERATIONS: {
|
|
|
11264
12097
|
readonly queryParams: readonly [];
|
|
11265
12098
|
readonly bodyKind: "json";
|
|
11266
12099
|
readonly responseKind: "json";
|
|
11267
|
-
readonly codes:
|
|
12100
|
+
readonly codes: 52;
|
|
11268
12101
|
};
|
|
11269
12102
|
readonly "channels.delete": {
|
|
11270
12103
|
readonly method: "DELETE";
|
|
@@ -11273,7 +12106,7 @@ export declare const OPERATIONS: {
|
|
|
11273
12106
|
readonly queryParams: readonly [];
|
|
11274
12107
|
readonly bodyKind: "none";
|
|
11275
12108
|
readonly responseKind: "json";
|
|
11276
|
-
readonly codes:
|
|
12109
|
+
readonly codes: 52;
|
|
11277
12110
|
};
|
|
11278
12111
|
readonly "channels.getById": {
|
|
11279
12112
|
readonly method: "GET";
|
|
@@ -11282,7 +12115,7 @@ export declare const OPERATIONS: {
|
|
|
11282
12115
|
readonly queryParams: readonly [];
|
|
11283
12116
|
readonly bodyKind: "none";
|
|
11284
12117
|
readonly responseKind: "json";
|
|
11285
|
-
readonly codes:
|
|
12118
|
+
readonly codes: 52;
|
|
11286
12119
|
};
|
|
11287
12120
|
readonly "channels.list": {
|
|
11288
12121
|
readonly method: "GET";
|
|
@@ -11291,7 +12124,7 @@ export declare const OPERATIONS: {
|
|
|
11291
12124
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "channel_type", "is_active", "alert"];
|
|
11292
12125
|
readonly bodyKind: "none";
|
|
11293
12126
|
readonly responseKind: "json";
|
|
11294
|
-
readonly codes:
|
|
12127
|
+
readonly codes: 52;
|
|
11295
12128
|
};
|
|
11296
12129
|
readonly "channels.testConnection": {
|
|
11297
12130
|
readonly method: "POST";
|
|
@@ -11300,7 +12133,7 @@ export declare const OPERATIONS: {
|
|
|
11300
12133
|
readonly queryParams: readonly [];
|
|
11301
12134
|
readonly bodyKind: "json";
|
|
11302
12135
|
readonly responseKind: "json";
|
|
11303
|
-
readonly codes:
|
|
12136
|
+
readonly codes: 52;
|
|
11304
12137
|
};
|
|
11305
12138
|
readonly "channels.toggle": {
|
|
11306
12139
|
readonly method: "POST";
|
|
@@ -11309,7 +12142,7 @@ export declare const OPERATIONS: {
|
|
|
11309
12142
|
readonly queryParams: readonly [];
|
|
11310
12143
|
readonly bodyKind: "json";
|
|
11311
12144
|
readonly responseKind: "json";
|
|
11312
|
-
readonly codes:
|
|
12145
|
+
readonly codes: 52;
|
|
11313
12146
|
};
|
|
11314
12147
|
readonly "channels.update": {
|
|
11315
12148
|
readonly method: "PATCH";
|
|
@@ -11318,7 +12151,7 @@ export declare const OPERATIONS: {
|
|
|
11318
12151
|
readonly queryParams: readonly [];
|
|
11319
12152
|
readonly bodyKind: "json";
|
|
11320
12153
|
readonly responseKind: "json";
|
|
11321
|
-
readonly codes:
|
|
12154
|
+
readonly codes: 52;
|
|
11322
12155
|
};
|
|
11323
12156
|
readonly "contacts.getById": {
|
|
11324
12157
|
readonly method: "GET";
|
|
@@ -11327,7 +12160,7 @@ export declare const OPERATIONS: {
|
|
|
11327
12160
|
readonly queryParams: readonly [];
|
|
11328
12161
|
readonly bodyKind: "none";
|
|
11329
12162
|
readonly responseKind: "json";
|
|
11330
|
-
readonly codes:
|
|
12163
|
+
readonly codes: 18;
|
|
11331
12164
|
};
|
|
11332
12165
|
readonly "contacts.list": {
|
|
11333
12166
|
readonly method: "GET";
|
|
@@ -11345,7 +12178,7 @@ export declare const OPERATIONS: {
|
|
|
11345
12178
|
readonly queryParams: readonly [];
|
|
11346
12179
|
readonly bodyKind: "json";
|
|
11347
12180
|
readonly responseKind: "json";
|
|
11348
|
-
readonly codes:
|
|
12181
|
+
readonly codes: 18;
|
|
11349
12182
|
};
|
|
11350
12183
|
readonly "dashboard.capacityStatus": {
|
|
11351
12184
|
readonly method: "GET";
|
|
@@ -11354,7 +12187,7 @@ export declare const OPERATIONS: {
|
|
|
11354
12187
|
readonly queryParams: readonly [];
|
|
11355
12188
|
readonly bodyKind: "none";
|
|
11356
12189
|
readonly responseKind: "json";
|
|
11357
|
-
readonly codes:
|
|
12190
|
+
readonly codes: 2;
|
|
11358
12191
|
};
|
|
11359
12192
|
readonly "dashboard.watchDashboardMetrics": {
|
|
11360
12193
|
readonly method: "GET";
|
|
@@ -11363,7 +12196,7 @@ export declare const OPERATIONS: {
|
|
|
11363
12196
|
readonly queryParams: readonly [];
|
|
11364
12197
|
readonly bodyKind: "none";
|
|
11365
12198
|
readonly responseKind: "sse";
|
|
11366
|
-
readonly codes:
|
|
12199
|
+
readonly codes: 2;
|
|
11367
12200
|
};
|
|
11368
12201
|
readonly "destinations.create": {
|
|
11369
12202
|
readonly method: "POST";
|
|
@@ -11372,7 +12205,7 @@ export declare const OPERATIONS: {
|
|
|
11372
12205
|
readonly queryParams: readonly [];
|
|
11373
12206
|
readonly bodyKind: "json";
|
|
11374
12207
|
readonly responseKind: "json";
|
|
11375
|
-
readonly codes:
|
|
12208
|
+
readonly codes: 2;
|
|
11376
12209
|
};
|
|
11377
12210
|
readonly "destinations.delete": {
|
|
11378
12211
|
readonly method: "DELETE";
|
|
@@ -11381,7 +12214,7 @@ export declare const OPERATIONS: {
|
|
|
11381
12214
|
readonly queryParams: readonly [];
|
|
11382
12215
|
readonly bodyKind: "none";
|
|
11383
12216
|
readonly responseKind: "json";
|
|
11384
|
-
readonly codes:
|
|
12217
|
+
readonly codes: 5;
|
|
11385
12218
|
};
|
|
11386
12219
|
readonly "destinations.getById": {
|
|
11387
12220
|
readonly method: "GET";
|
|
@@ -11390,7 +12223,7 @@ export declare const OPERATIONS: {
|
|
|
11390
12223
|
readonly queryParams: readonly [];
|
|
11391
12224
|
readonly bodyKind: "none";
|
|
11392
12225
|
readonly responseKind: "json";
|
|
11393
|
-
readonly codes:
|
|
12226
|
+
readonly codes: 5;
|
|
11394
12227
|
};
|
|
11395
12228
|
readonly "destinations.list": {
|
|
11396
12229
|
readonly method: "GET";
|
|
@@ -11399,7 +12232,7 @@ export declare const OPERATIONS: {
|
|
|
11399
12232
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
11400
12233
|
readonly bodyKind: "none";
|
|
11401
12234
|
readonly responseKind: "json";
|
|
11402
|
-
readonly codes:
|
|
12235
|
+
readonly codes: 2;
|
|
11403
12236
|
};
|
|
11404
12237
|
readonly "destinations.update": {
|
|
11405
12238
|
readonly method: "PATCH";
|
|
@@ -11408,7 +12241,7 @@ export declare const OPERATIONS: {
|
|
|
11408
12241
|
readonly queryParams: readonly [];
|
|
11409
12242
|
readonly bodyKind: "json";
|
|
11410
12243
|
readonly responseKind: "json";
|
|
11411
|
-
readonly codes:
|
|
12244
|
+
readonly codes: 5;
|
|
11412
12245
|
};
|
|
11413
12246
|
readonly "dialerAttempts.list": {
|
|
11414
12247
|
readonly method: "GET";
|
|
@@ -11426,7 +12259,7 @@ export declare const OPERATIONS: {
|
|
|
11426
12259
|
readonly queryParams: readonly [];
|
|
11427
12260
|
readonly bodyKind: "json";
|
|
11428
12261
|
readonly responseKind: "json";
|
|
11429
|
-
readonly codes:
|
|
12262
|
+
readonly codes: 45;
|
|
11430
12263
|
};
|
|
11431
12264
|
readonly "dialerCampaigns.create": {
|
|
11432
12265
|
readonly method: "POST";
|
|
@@ -11435,7 +12268,7 @@ export declare const OPERATIONS: {
|
|
|
11435
12268
|
readonly queryParams: readonly [];
|
|
11436
12269
|
readonly bodyKind: "json";
|
|
11437
12270
|
readonly responseKind: "json";
|
|
11438
|
-
readonly codes:
|
|
12271
|
+
readonly codes: 47;
|
|
11439
12272
|
};
|
|
11440
12273
|
readonly "dialerCampaigns.delete": {
|
|
11441
12274
|
readonly method: "DELETE";
|
|
@@ -11444,7 +12277,7 @@ export declare const OPERATIONS: {
|
|
|
11444
12277
|
readonly queryParams: readonly [];
|
|
11445
12278
|
readonly bodyKind: "none";
|
|
11446
12279
|
readonly responseKind: "json";
|
|
11447
|
-
readonly codes:
|
|
12280
|
+
readonly codes: 45;
|
|
11448
12281
|
};
|
|
11449
12282
|
readonly "dialerCampaigns.get": {
|
|
11450
12283
|
readonly method: "GET";
|
|
@@ -11453,7 +12286,7 @@ export declare const OPERATIONS: {
|
|
|
11453
12286
|
readonly queryParams: readonly [];
|
|
11454
12287
|
readonly bodyKind: "none";
|
|
11455
12288
|
readonly responseKind: "json";
|
|
11456
|
-
readonly codes:
|
|
12289
|
+
readonly codes: 45;
|
|
11457
12290
|
};
|
|
11458
12291
|
readonly "dialerCampaigns.list": {
|
|
11459
12292
|
readonly method: "GET";
|
|
@@ -11471,7 +12304,7 @@ export declare const OPERATIONS: {
|
|
|
11471
12304
|
readonly queryParams: readonly [];
|
|
11472
12305
|
readonly bodyKind: "none";
|
|
11473
12306
|
readonly responseKind: "sse";
|
|
11474
|
-
readonly codes:
|
|
12307
|
+
readonly codes: 45;
|
|
11475
12308
|
};
|
|
11476
12309
|
readonly "dialerCampaigns.orgLiveStats": {
|
|
11477
12310
|
readonly method: "GET";
|
|
@@ -11489,7 +12322,7 @@ export declare const OPERATIONS: {
|
|
|
11489
12322
|
readonly queryParams: readonly [];
|
|
11490
12323
|
readonly bodyKind: "none";
|
|
11491
12324
|
readonly responseKind: "json";
|
|
11492
|
-
readonly codes:
|
|
12325
|
+
readonly codes: 45;
|
|
11493
12326
|
};
|
|
11494
12327
|
readonly "dialerCampaigns.summary": {
|
|
11495
12328
|
readonly method: "GET";
|
|
@@ -11507,7 +12340,7 @@ export declare const OPERATIONS: {
|
|
|
11507
12340
|
readonly queryParams: readonly [];
|
|
11508
12341
|
readonly bodyKind: "json";
|
|
11509
12342
|
readonly responseKind: "json";
|
|
11510
|
-
readonly codes:
|
|
12343
|
+
readonly codes: 45;
|
|
11511
12344
|
};
|
|
11512
12345
|
readonly "dialerContacts.add": {
|
|
11513
12346
|
readonly method: "POST";
|
|
@@ -11516,7 +12349,7 @@ export declare const OPERATIONS: {
|
|
|
11516
12349
|
readonly queryParams: readonly [];
|
|
11517
12350
|
readonly bodyKind: "json";
|
|
11518
12351
|
readonly responseKind: "json";
|
|
11519
|
-
readonly codes:
|
|
12352
|
+
readonly codes: 38;
|
|
11520
12353
|
};
|
|
11521
12354
|
readonly "dialerContacts.bulkCancel": {
|
|
11522
12355
|
readonly method: "POST";
|
|
@@ -11543,7 +12376,7 @@ export declare const OPERATIONS: {
|
|
|
11543
12376
|
readonly queryParams: readonly [];
|
|
11544
12377
|
readonly bodyKind: "none";
|
|
11545
12378
|
readonly responseKind: "json";
|
|
11546
|
-
readonly codes:
|
|
12379
|
+
readonly codes: 38;
|
|
11547
12380
|
};
|
|
11548
12381
|
readonly "dialerContacts.exportCsv": {
|
|
11549
12382
|
readonly method: "GET";
|
|
@@ -11561,7 +12394,7 @@ export declare const OPERATIONS: {
|
|
|
11561
12394
|
readonly queryParams: readonly [];
|
|
11562
12395
|
readonly bodyKind: "none";
|
|
11563
12396
|
readonly responseKind: "json";
|
|
11564
|
-
readonly codes:
|
|
12397
|
+
readonly codes: 18;
|
|
11565
12398
|
};
|
|
11566
12399
|
readonly "dialerContacts.list": {
|
|
11567
12400
|
readonly method: "GET";
|
|
@@ -11606,7 +12439,7 @@ export declare const OPERATIONS: {
|
|
|
11606
12439
|
readonly queryParams: readonly [];
|
|
11607
12440
|
readonly bodyKind: "json";
|
|
11608
12441
|
readonly responseKind: "json";
|
|
11609
|
-
readonly codes:
|
|
12442
|
+
readonly codes: 42;
|
|
11610
12443
|
};
|
|
11611
12444
|
readonly "dialerDnc.add": {
|
|
11612
12445
|
readonly method: "POST";
|
|
@@ -11660,7 +12493,7 @@ export declare const OPERATIONS: {
|
|
|
11660
12493
|
readonly queryParams: readonly [];
|
|
11661
12494
|
readonly bodyKind: "json";
|
|
11662
12495
|
readonly responseKind: "json";
|
|
11663
|
-
readonly codes:
|
|
12496
|
+
readonly codes: 39;
|
|
11664
12497
|
};
|
|
11665
12498
|
readonly "dialerImports.get": {
|
|
11666
12499
|
readonly method: "GET";
|
|
@@ -11669,7 +12502,7 @@ export declare const OPERATIONS: {
|
|
|
11669
12502
|
readonly queryParams: readonly [];
|
|
11670
12503
|
readonly bodyKind: "none";
|
|
11671
12504
|
readonly responseKind: "json";
|
|
11672
|
-
readonly codes:
|
|
12505
|
+
readonly codes: 39;
|
|
11673
12506
|
};
|
|
11674
12507
|
readonly "dialerImports.invalidRows": {
|
|
11675
12508
|
readonly method: "GET";
|
|
@@ -11678,7 +12511,7 @@ export declare const OPERATIONS: {
|
|
|
11678
12511
|
readonly queryParams: readonly [];
|
|
11679
12512
|
readonly bodyKind: "none";
|
|
11680
12513
|
readonly responseKind: "json";
|
|
11681
|
-
readonly codes:
|
|
12514
|
+
readonly codes: 39;
|
|
11682
12515
|
};
|
|
11683
12516
|
readonly "dialerImports.progress": {
|
|
11684
12517
|
readonly method: "GET";
|
|
@@ -11687,7 +12520,7 @@ export declare const OPERATIONS: {
|
|
|
11687
12520
|
readonly queryParams: readonly [];
|
|
11688
12521
|
readonly bodyKind: "none";
|
|
11689
12522
|
readonly responseKind: "sse";
|
|
11690
|
-
readonly codes:
|
|
12523
|
+
readonly codes: 39;
|
|
11691
12524
|
};
|
|
11692
12525
|
readonly "holidays.countries": {
|
|
11693
12526
|
readonly method: "GET";
|
|
@@ -11705,7 +12538,7 @@ export declare const OPERATIONS: {
|
|
|
11705
12538
|
readonly queryParams: readonly [];
|
|
11706
12539
|
readonly bodyKind: "json";
|
|
11707
12540
|
readonly responseKind: "json";
|
|
11708
|
-
readonly codes:
|
|
12541
|
+
readonly codes: 2;
|
|
11709
12542
|
};
|
|
11710
12543
|
readonly "holidays.delete": {
|
|
11711
12544
|
readonly method: "DELETE";
|
|
@@ -11723,7 +12556,7 @@ export declare const OPERATIONS: {
|
|
|
11723
12556
|
readonly queryParams: readonly [];
|
|
11724
12557
|
readonly bodyKind: "json";
|
|
11725
12558
|
readonly responseKind: "json";
|
|
11726
|
-
readonly codes:
|
|
12559
|
+
readonly codes: 2;
|
|
11727
12560
|
};
|
|
11728
12561
|
readonly "holidays.groups.delete": {
|
|
11729
12562
|
readonly method: "DELETE";
|
|
@@ -11750,7 +12583,7 @@ export declare const OPERATIONS: {
|
|
|
11750
12583
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
11751
12584
|
readonly bodyKind: "none";
|
|
11752
12585
|
readonly responseKind: "json";
|
|
11753
|
-
readonly codes:
|
|
12586
|
+
readonly codes: 2;
|
|
11754
12587
|
};
|
|
11755
12588
|
readonly "holidays.groups.update": {
|
|
11756
12589
|
readonly method: "PATCH";
|
|
@@ -11768,7 +12601,7 @@ export declare const OPERATIONS: {
|
|
|
11768
12601
|
readonly queryParams: readonly [];
|
|
11769
12602
|
readonly bodyKind: "json";
|
|
11770
12603
|
readonly responseKind: "json";
|
|
11771
|
-
readonly codes:
|
|
12604
|
+
readonly codes: 19;
|
|
11772
12605
|
};
|
|
11773
12606
|
readonly "holidays.list": {
|
|
11774
12607
|
readonly method: "GET";
|
|
@@ -11777,7 +12610,7 @@ export declare const OPERATIONS: {
|
|
|
11777
12610
|
readonly queryParams: readonly ["page", "limit"];
|
|
11778
12611
|
readonly bodyKind: "none";
|
|
11779
12612
|
readonly responseKind: "json";
|
|
11780
|
-
readonly codes:
|
|
12613
|
+
readonly codes: 2;
|
|
11781
12614
|
};
|
|
11782
12615
|
readonly "holidays.previewImport": {
|
|
11783
12616
|
readonly method: "GET";
|
|
@@ -11804,7 +12637,7 @@ export declare const OPERATIONS: {
|
|
|
11804
12637
|
readonly queryParams: readonly [];
|
|
11805
12638
|
readonly bodyKind: "json";
|
|
11806
12639
|
readonly responseKind: "json";
|
|
11807
|
-
readonly codes:
|
|
12640
|
+
readonly codes: 20;
|
|
11808
12641
|
};
|
|
11809
12642
|
readonly "license.modules": {
|
|
11810
12643
|
readonly method: "GET";
|
|
@@ -11822,7 +12655,25 @@ export declare const OPERATIONS: {
|
|
|
11822
12655
|
readonly queryParams: readonly [];
|
|
11823
12656
|
readonly bodyKind: "none";
|
|
11824
12657
|
readonly responseKind: "json";
|
|
11825
|
-
readonly codes:
|
|
12658
|
+
readonly codes: 2;
|
|
12659
|
+
};
|
|
12660
|
+
readonly "nodes.list": {
|
|
12661
|
+
readonly method: "GET";
|
|
12662
|
+
readonly path: "/nodes";
|
|
12663
|
+
readonly pathParams: readonly [];
|
|
12664
|
+
readonly queryParams: readonly [];
|
|
12665
|
+
readonly bodyKind: "none";
|
|
12666
|
+
readonly responseKind: "json";
|
|
12667
|
+
readonly codes: 0;
|
|
12668
|
+
};
|
|
12669
|
+
readonly "nodes.schema": {
|
|
12670
|
+
readonly method: "GET";
|
|
12671
|
+
readonly path: "/nodes/{node_type}/schema";
|
|
12672
|
+
readonly pathParams: readonly ["node_type"];
|
|
12673
|
+
readonly queryParams: readonly [];
|
|
12674
|
+
readonly bodyKind: "none";
|
|
12675
|
+
readonly responseKind: "json";
|
|
12676
|
+
readonly codes: 0;
|
|
11826
12677
|
};
|
|
11827
12678
|
readonly "oauthGrants.list": {
|
|
11828
12679
|
readonly method: "GET";
|
|
@@ -11831,7 +12682,7 @@ export declare const OPERATIONS: {
|
|
|
11831
12682
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
11832
12683
|
readonly bodyKind: "none";
|
|
11833
12684
|
readonly responseKind: "json";
|
|
11834
|
-
readonly codes:
|
|
12685
|
+
readonly codes: 2;
|
|
11835
12686
|
};
|
|
11836
12687
|
readonly "oauthGrants.revoke": {
|
|
11837
12688
|
readonly method: "DELETE";
|
|
@@ -11840,7 +12691,7 @@ export declare const OPERATIONS: {
|
|
|
11840
12691
|
readonly queryParams: readonly [];
|
|
11841
12692
|
readonly bodyKind: "none";
|
|
11842
12693
|
readonly responseKind: "json";
|
|
11843
|
-
readonly codes:
|
|
12694
|
+
readonly codes: 24;
|
|
11844
12695
|
};
|
|
11845
12696
|
readonly "oauthGrants.usage": {
|
|
11846
12697
|
readonly method: "GET";
|
|
@@ -11849,7 +12700,7 @@ export declare const OPERATIONS: {
|
|
|
11849
12700
|
readonly queryParams: readonly ["days"];
|
|
11850
12701
|
readonly bodyKind: "none";
|
|
11851
12702
|
readonly responseKind: "json";
|
|
11852
|
-
readonly codes:
|
|
12703
|
+
readonly codes: 24;
|
|
11853
12704
|
};
|
|
11854
12705
|
readonly "orgSettings.getDialer": {
|
|
11855
12706
|
readonly method: "GET";
|
|
@@ -11858,7 +12709,7 @@ export declare const OPERATIONS: {
|
|
|
11858
12709
|
readonly queryParams: readonly [];
|
|
11859
12710
|
readonly bodyKind: "none";
|
|
11860
12711
|
readonly responseKind: "json";
|
|
11861
|
-
readonly codes:
|
|
12712
|
+
readonly codes: 2;
|
|
11862
12713
|
};
|
|
11863
12714
|
readonly "orgSettings.upsertDialer": {
|
|
11864
12715
|
readonly method: "PATCH";
|
|
@@ -11867,7 +12718,7 @@ export declare const OPERATIONS: {
|
|
|
11867
12718
|
readonly queryParams: readonly [];
|
|
11868
12719
|
readonly bodyKind: "json";
|
|
11869
12720
|
readonly responseKind: "json";
|
|
11870
|
-
readonly codes:
|
|
12721
|
+
readonly codes: 2;
|
|
11871
12722
|
};
|
|
11872
12723
|
readonly "schedules.create": {
|
|
11873
12724
|
readonly method: "POST";
|
|
@@ -11876,7 +12727,7 @@ export declare const OPERATIONS: {
|
|
|
11876
12727
|
readonly queryParams: readonly [];
|
|
11877
12728
|
readonly bodyKind: "json";
|
|
11878
12729
|
readonly responseKind: "json";
|
|
11879
|
-
readonly codes:
|
|
12730
|
+
readonly codes: 2;
|
|
11880
12731
|
};
|
|
11881
12732
|
readonly "schedules.delete": {
|
|
11882
12733
|
readonly method: "DELETE";
|
|
@@ -11903,7 +12754,7 @@ export declare const OPERATIONS: {
|
|
|
11903
12754
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
11904
12755
|
readonly bodyKind: "none";
|
|
11905
12756
|
readonly responseKind: "json";
|
|
11906
|
-
readonly codes:
|
|
12757
|
+
readonly codes: 2;
|
|
11907
12758
|
};
|
|
11908
12759
|
readonly "schedules.update": {
|
|
11909
12760
|
readonly method: "PATCH";
|
|
@@ -11921,7 +12772,7 @@ export declare const OPERATIONS: {
|
|
|
11921
12772
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
11922
12773
|
readonly bodyKind: "none";
|
|
11923
12774
|
readonly responseKind: "json";
|
|
11924
|
-
readonly codes:
|
|
12775
|
+
readonly codes: 2;
|
|
11925
12776
|
};
|
|
11926
12777
|
readonly "secrets.listNames": {
|
|
11927
12778
|
readonly method: "GET";
|
|
@@ -11930,7 +12781,7 @@ export declare const OPERATIONS: {
|
|
|
11930
12781
|
readonly queryParams: readonly [];
|
|
11931
12782
|
readonly bodyKind: "none";
|
|
11932
12783
|
readonly responseKind: "json";
|
|
11933
|
-
readonly codes:
|
|
12784
|
+
readonly codes: 2;
|
|
11934
12785
|
};
|
|
11935
12786
|
readonly "signals.callSignals": {
|
|
11936
12787
|
readonly method: "GET";
|
|
@@ -11939,7 +12790,7 @@ export declare const OPERATIONS: {
|
|
|
11939
12790
|
readonly queryParams: readonly ["locale"];
|
|
11940
12791
|
readonly bodyKind: "none";
|
|
11941
12792
|
readonly responseKind: "json";
|
|
11942
|
-
readonly codes:
|
|
12793
|
+
readonly codes: 53;
|
|
11943
12794
|
};
|
|
11944
12795
|
readonly "signals.create": {
|
|
11945
12796
|
readonly method: "POST";
|
|
@@ -11948,7 +12799,7 @@ export declare const OPERATIONS: {
|
|
|
11948
12799
|
readonly queryParams: readonly [];
|
|
11949
12800
|
readonly bodyKind: "json";
|
|
11950
12801
|
readonly responseKind: "json";
|
|
11951
|
-
readonly codes:
|
|
12802
|
+
readonly codes: 53;
|
|
11952
12803
|
};
|
|
11953
12804
|
readonly "signals.delete": {
|
|
11954
12805
|
readonly method: "DELETE";
|
|
@@ -11957,7 +12808,7 @@ export declare const OPERATIONS: {
|
|
|
11957
12808
|
readonly queryParams: readonly [];
|
|
11958
12809
|
readonly bodyKind: "none";
|
|
11959
12810
|
readonly responseKind: "json";
|
|
11960
|
-
readonly codes:
|
|
12811
|
+
readonly codes: 53;
|
|
11961
12812
|
};
|
|
11962
12813
|
readonly "signals.get": {
|
|
11963
12814
|
readonly method: "GET";
|
|
@@ -11966,7 +12817,7 @@ export declare const OPERATIONS: {
|
|
|
11966
12817
|
readonly queryParams: readonly [];
|
|
11967
12818
|
readonly bodyKind: "none";
|
|
11968
12819
|
readonly responseKind: "json";
|
|
11969
|
-
readonly codes:
|
|
12820
|
+
readonly codes: 53;
|
|
11970
12821
|
};
|
|
11971
12822
|
readonly "signals.list": {
|
|
11972
12823
|
readonly method: "GET";
|
|
@@ -12002,7 +12853,7 @@ export declare const OPERATIONS: {
|
|
|
12002
12853
|
readonly queryParams: readonly [];
|
|
12003
12854
|
readonly bodyKind: "json";
|
|
12004
12855
|
readonly responseKind: "json";
|
|
12005
|
-
readonly codes:
|
|
12856
|
+
readonly codes: 53;
|
|
12006
12857
|
};
|
|
12007
12858
|
readonly "signals.update": {
|
|
12008
12859
|
readonly method: "PATCH";
|
|
@@ -12011,7 +12862,7 @@ export declare const OPERATIONS: {
|
|
|
12011
12862
|
readonly queryParams: readonly [];
|
|
12012
12863
|
readonly bodyKind: "json";
|
|
12013
12864
|
readonly responseKind: "json";
|
|
12014
|
-
readonly codes:
|
|
12865
|
+
readonly codes: 53;
|
|
12015
12866
|
};
|
|
12016
12867
|
readonly "signals.upsertBySlug": {
|
|
12017
12868
|
readonly method: "PUT";
|
|
@@ -12020,7 +12871,7 @@ export declare const OPERATIONS: {
|
|
|
12020
12871
|
readonly queryParams: readonly [];
|
|
12021
12872
|
readonly bodyKind: "json";
|
|
12022
12873
|
readonly responseKind: "json";
|
|
12023
|
-
readonly codes:
|
|
12874
|
+
readonly codes: 53;
|
|
12024
12875
|
};
|
|
12025
12876
|
readonly "tts.listModels": {
|
|
12026
12877
|
readonly method: "GET";
|
|
@@ -12029,7 +12880,7 @@ export declare const OPERATIONS: {
|
|
|
12029
12880
|
readonly queryParams: readonly [];
|
|
12030
12881
|
readonly bodyKind: "none";
|
|
12031
12882
|
readonly responseKind: "json";
|
|
12032
|
-
readonly codes:
|
|
12883
|
+
readonly codes: 26;
|
|
12033
12884
|
};
|
|
12034
12885
|
readonly "tts.listVoices": {
|
|
12035
12886
|
readonly method: "GET";
|
|
@@ -12038,7 +12889,7 @@ export declare const OPERATIONS: {
|
|
|
12038
12889
|
readonly queryParams: readonly ["language", "model"];
|
|
12039
12890
|
readonly bodyKind: "none";
|
|
12040
12891
|
readonly responseKind: "json";
|
|
12041
|
-
readonly codes:
|
|
12892
|
+
readonly codes: 26;
|
|
12042
12893
|
};
|
|
12043
12894
|
readonly "tts.preview": {
|
|
12044
12895
|
readonly method: "POST";
|
|
@@ -12047,7 +12898,7 @@ export declare const OPERATIONS: {
|
|
|
12047
12898
|
readonly queryParams: readonly [];
|
|
12048
12899
|
readonly bodyKind: "json";
|
|
12049
12900
|
readonly responseKind: "binary";
|
|
12050
|
-
readonly codes:
|
|
12901
|
+
readonly codes: 33;
|
|
12051
12902
|
};
|
|
12052
12903
|
readonly "users.activateMember": {
|
|
12053
12904
|
readonly method: "POST";
|
|
@@ -12056,7 +12907,7 @@ export declare const OPERATIONS: {
|
|
|
12056
12907
|
readonly queryParams: readonly [];
|
|
12057
12908
|
readonly bodyKind: "none";
|
|
12058
12909
|
readonly responseKind: "json";
|
|
12059
|
-
readonly codes:
|
|
12910
|
+
readonly codes: 22;
|
|
12060
12911
|
};
|
|
12061
12912
|
readonly "users.createMember": {
|
|
12062
12913
|
readonly method: "POST";
|
|
@@ -12065,7 +12916,7 @@ export declare const OPERATIONS: {
|
|
|
12065
12916
|
readonly queryParams: readonly [];
|
|
12066
12917
|
readonly bodyKind: "json";
|
|
12067
12918
|
readonly responseKind: "json";
|
|
12068
|
-
readonly codes:
|
|
12919
|
+
readonly codes: 48;
|
|
12069
12920
|
};
|
|
12070
12921
|
readonly "users.listMembers": {
|
|
12071
12922
|
readonly method: "GET";
|
|
@@ -12074,7 +12925,7 @@ export declare const OPERATIONS: {
|
|
|
12074
12925
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "status"];
|
|
12075
12926
|
readonly bodyKind: "none";
|
|
12076
12927
|
readonly responseKind: "json";
|
|
12077
|
-
readonly codes:
|
|
12928
|
+
readonly codes: 2;
|
|
12078
12929
|
};
|
|
12079
12930
|
readonly "users.me": {
|
|
12080
12931
|
readonly method: "GET";
|
|
@@ -12092,7 +12943,25 @@ export declare const OPERATIONS: {
|
|
|
12092
12943
|
readonly queryParams: readonly [];
|
|
12093
12944
|
readonly bodyKind: "none";
|
|
12094
12945
|
readonly responseKind: "json";
|
|
12095
|
-
readonly codes:
|
|
12946
|
+
readonly codes: 36;
|
|
12947
|
+
};
|
|
12948
|
+
readonly "users.resetSecondFactor": {
|
|
12949
|
+
readonly method: "POST";
|
|
12950
|
+
readonly path: "/members/{user_id}/reset-second-factor";
|
|
12951
|
+
readonly pathParams: readonly ["user_id"];
|
|
12952
|
+
readonly queryParams: readonly [];
|
|
12953
|
+
readonly bodyKind: "none";
|
|
12954
|
+
readonly responseKind: "json";
|
|
12955
|
+
readonly codes: 32;
|
|
12956
|
+
};
|
|
12957
|
+
readonly "users.revokeMemberSessions": {
|
|
12958
|
+
readonly method: "POST";
|
|
12959
|
+
readonly path: "/members/{user_id}/revoke-sessions";
|
|
12960
|
+
readonly pathParams: readonly ["user_id"];
|
|
12961
|
+
readonly queryParams: readonly [];
|
|
12962
|
+
readonly bodyKind: "none";
|
|
12963
|
+
readonly responseKind: "json";
|
|
12964
|
+
readonly codes: 32;
|
|
12096
12965
|
};
|
|
12097
12966
|
readonly "users.suspendMember": {
|
|
12098
12967
|
readonly method: "POST";
|
|
@@ -12101,7 +12970,25 @@ export declare const OPERATIONS: {
|
|
|
12101
12970
|
readonly queryParams: readonly [];
|
|
12102
12971
|
readonly bodyKind: "none";
|
|
12103
12972
|
readonly responseKind: "json";
|
|
12104
|
-
readonly codes:
|
|
12973
|
+
readonly codes: 37;
|
|
12974
|
+
};
|
|
12975
|
+
readonly "users.unlockMember": {
|
|
12976
|
+
readonly method: "POST";
|
|
12977
|
+
readonly path: "/members/{user_id}/unlock";
|
|
12978
|
+
readonly pathParams: readonly ["user_id"];
|
|
12979
|
+
readonly queryParams: readonly [];
|
|
12980
|
+
readonly bodyKind: "none";
|
|
12981
|
+
readonly responseKind: "json";
|
|
12982
|
+
readonly codes: 32;
|
|
12983
|
+
};
|
|
12984
|
+
readonly "users.updateMyNotificationEmail": {
|
|
12985
|
+
readonly method: "PUT";
|
|
12986
|
+
readonly path: "/users/me/notification-email";
|
|
12987
|
+
readonly pathParams: readonly [];
|
|
12988
|
+
readonly queryParams: readonly [];
|
|
12989
|
+
readonly bodyKind: "json";
|
|
12990
|
+
readonly responseKind: "json";
|
|
12991
|
+
readonly codes: 0;
|
|
12105
12992
|
};
|
|
12106
12993
|
readonly "users.updateMyNotificationToast": {
|
|
12107
12994
|
readonly method: "PUT";
|
|
@@ -12119,7 +13006,7 @@ export declare const OPERATIONS: {
|
|
|
12119
13006
|
readonly queryParams: readonly [];
|
|
12120
13007
|
readonly bodyKind: "json";
|
|
12121
13008
|
readonly responseKind: "json";
|
|
12122
|
-
readonly codes:
|
|
13009
|
+
readonly codes: 44;
|
|
12123
13010
|
};
|
|
12124
13011
|
readonly "visualPlans.clone": {
|
|
12125
13012
|
readonly method: "POST";
|
|
@@ -12146,7 +13033,7 @@ export declare const OPERATIONS: {
|
|
|
12146
13033
|
readonly queryParams: readonly [];
|
|
12147
13034
|
readonly bodyKind: "none";
|
|
12148
13035
|
readonly responseKind: "json";
|
|
12149
|
-
readonly codes:
|
|
13036
|
+
readonly codes: 40;
|
|
12150
13037
|
};
|
|
12151
13038
|
readonly "visualPlans.getById": {
|
|
12152
13039
|
readonly method: "GET";
|
|
@@ -12173,7 +13060,7 @@ export declare const OPERATIONS: {
|
|
|
12173
13060
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "status"];
|
|
12174
13061
|
readonly bodyKind: "none";
|
|
12175
13062
|
readonly responseKind: "json";
|
|
12176
|
-
readonly codes:
|
|
13063
|
+
readonly codes: 2;
|
|
12177
13064
|
};
|
|
12178
13065
|
readonly "visualPlans.listVersions": {
|
|
12179
13066
|
readonly method: "GET";
|
|
@@ -12191,7 +13078,7 @@ export declare const OPERATIONS: {
|
|
|
12191
13078
|
readonly queryParams: readonly [];
|
|
12192
13079
|
readonly bodyKind: "json";
|
|
12193
13080
|
readonly responseKind: "json";
|
|
12194
|
-
readonly codes:
|
|
13081
|
+
readonly codes: 43;
|
|
12195
13082
|
};
|
|
12196
13083
|
readonly "visualPlans.update": {
|
|
12197
13084
|
readonly method: "PATCH";
|
|
@@ -12236,7 +13123,7 @@ export declare const OPERATIONS: {
|
|
|
12236
13123
|
readonly queryParams: readonly ["webhook_endpoint_id", "event_type", "status", "date_from", "date_to"];
|
|
12237
13124
|
readonly bodyKind: "none";
|
|
12238
13125
|
readonly responseKind: "json";
|
|
12239
|
-
readonly codes:
|
|
13126
|
+
readonly codes: 2;
|
|
12240
13127
|
};
|
|
12241
13128
|
readonly "webhooks.deliveries.getById": {
|
|
12242
13129
|
readonly method: "GET";
|
|
@@ -12245,7 +13132,7 @@ export declare const OPERATIONS: {
|
|
|
12245
13132
|
readonly queryParams: readonly [];
|
|
12246
13133
|
readonly bodyKind: "none";
|
|
12247
13134
|
readonly responseKind: "json";
|
|
12248
|
-
readonly codes:
|
|
13135
|
+
readonly codes: 2;
|
|
12249
13136
|
};
|
|
12250
13137
|
readonly "webhooks.deliveries.list": {
|
|
12251
13138
|
readonly method: "GET";
|
|
@@ -12263,7 +13150,7 @@ export declare const OPERATIONS: {
|
|
|
12263
13150
|
readonly queryParams: readonly [];
|
|
12264
13151
|
readonly bodyKind: "none";
|
|
12265
13152
|
readonly responseKind: "json";
|
|
12266
|
-
readonly codes:
|
|
13153
|
+
readonly codes: 2;
|
|
12267
13154
|
};
|
|
12268
13155
|
readonly "webhooks.deliveries.retry": {
|
|
12269
13156
|
readonly method: "POST";
|
|
@@ -12272,7 +13159,7 @@ export declare const OPERATIONS: {
|
|
|
12272
13159
|
readonly queryParams: readonly [];
|
|
12273
13160
|
readonly bodyKind: "none";
|
|
12274
13161
|
readonly responseKind: "json";
|
|
12275
|
-
readonly codes:
|
|
13162
|
+
readonly codes: 21;
|
|
12276
13163
|
};
|
|
12277
13164
|
readonly "webhooks.endpoints.create": {
|
|
12278
13165
|
readonly method: "POST";
|
|
@@ -12281,7 +13168,7 @@ export declare const OPERATIONS: {
|
|
|
12281
13168
|
readonly queryParams: readonly [];
|
|
12282
13169
|
readonly bodyKind: "json";
|
|
12283
13170
|
readonly responseKind: "json";
|
|
12284
|
-
readonly codes:
|
|
13171
|
+
readonly codes: 23;
|
|
12285
13172
|
};
|
|
12286
13173
|
readonly "webhooks.endpoints.delete": {
|
|
12287
13174
|
readonly method: "DELETE";
|
|
@@ -12290,7 +13177,7 @@ export declare const OPERATIONS: {
|
|
|
12290
13177
|
readonly queryParams: readonly [];
|
|
12291
13178
|
readonly bodyKind: "none";
|
|
12292
13179
|
readonly responseKind: "json";
|
|
12293
|
-
readonly codes:
|
|
13180
|
+
readonly codes: 23;
|
|
12294
13181
|
};
|
|
12295
13182
|
readonly "webhooks.endpoints.getById": {
|
|
12296
13183
|
readonly method: "GET";
|
|
@@ -12299,7 +13186,7 @@ export declare const OPERATIONS: {
|
|
|
12299
13186
|
readonly queryParams: readonly [];
|
|
12300
13187
|
readonly bodyKind: "none";
|
|
12301
13188
|
readonly responseKind: "json";
|
|
12302
|
-
readonly codes:
|
|
13189
|
+
readonly codes: 23;
|
|
12303
13190
|
};
|
|
12304
13191
|
readonly "webhooks.endpoints.list": {
|
|
12305
13192
|
readonly method: "GET";
|
|
@@ -12308,7 +13195,7 @@ export declare const OPERATIONS: {
|
|
|
12308
13195
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order"];
|
|
12309
13196
|
readonly bodyKind: "none";
|
|
12310
13197
|
readonly responseKind: "json";
|
|
12311
|
-
readonly codes:
|
|
13198
|
+
readonly codes: 2;
|
|
12312
13199
|
};
|
|
12313
13200
|
readonly "webhooks.endpoints.rotateSecret": {
|
|
12314
13201
|
readonly method: "POST";
|
|
@@ -12317,7 +13204,16 @@ export declare const OPERATIONS: {
|
|
|
12317
13204
|
readonly queryParams: readonly [];
|
|
12318
13205
|
readonly bodyKind: "none";
|
|
12319
13206
|
readonly responseKind: "json";
|
|
12320
|
-
readonly codes:
|
|
13207
|
+
readonly codes: 23;
|
|
13208
|
+
};
|
|
13209
|
+
readonly "webhooks.endpoints.test": {
|
|
13210
|
+
readonly method: "POST";
|
|
13211
|
+
readonly path: "/webhooks/{webhook_endpoint_id}/test";
|
|
13212
|
+
readonly pathParams: readonly ["webhook_endpoint_id"];
|
|
13213
|
+
readonly queryParams: readonly [];
|
|
13214
|
+
readonly bodyKind: "none";
|
|
13215
|
+
readonly responseKind: "json";
|
|
13216
|
+
readonly codes: 23;
|
|
12321
13217
|
};
|
|
12322
13218
|
readonly "webhooks.endpoints.update": {
|
|
12323
13219
|
readonly method: "PATCH";
|
|
@@ -12326,7 +13222,7 @@ export declare const OPERATIONS: {
|
|
|
12326
13222
|
readonly queryParams: readonly [];
|
|
12327
13223
|
readonly bodyKind: "json";
|
|
12328
13224
|
readonly responseKind: "json";
|
|
12329
|
-
readonly codes:
|
|
13225
|
+
readonly codes: 23;
|
|
12330
13226
|
};
|
|
12331
13227
|
readonly "webhooks.events.list": {
|
|
12332
13228
|
readonly method: "GET";
|
|
@@ -12335,7 +13231,7 @@ export declare const OPERATIONS: {
|
|
|
12335
13231
|
readonly queryParams: readonly [];
|
|
12336
13232
|
readonly bodyKind: "none";
|
|
12337
13233
|
readonly responseKind: "json";
|
|
12338
|
-
readonly codes:
|
|
13234
|
+
readonly codes: 2;
|
|
12339
13235
|
};
|
|
12340
13236
|
};
|
|
12341
13237
|
/** Defined error codes per operation. */
|
|
@@ -12376,6 +13272,7 @@ export type NivaErrorCodes = {
|
|
|
12376
13272
|
"audit.count": AuditCountErrorCode;
|
|
12377
13273
|
"audit.exportCsv": AuditExportCsvErrorCode;
|
|
12378
13274
|
"audit.list": AuditListErrorCode;
|
|
13275
|
+
"bugReports.create": BugReportsCreateErrorCode;
|
|
12379
13276
|
"callRecords.count": CallRecordsCountErrorCode;
|
|
12380
13277
|
"callRecords.exportCsv": CallRecordsExportCsvErrorCode;
|
|
12381
13278
|
"callRecords.getById": CallRecordsGetByIdErrorCode;
|
|
@@ -12451,6 +13348,8 @@ export type NivaErrorCodes = {
|
|
|
12451
13348
|
"insights.aggregate": InsightsAggregateErrorCode;
|
|
12452
13349
|
"license.modules": LicenseModulesErrorCode;
|
|
12453
13350
|
"license.status": LicenseStatusErrorCode;
|
|
13351
|
+
"nodes.list": NodesListErrorCode;
|
|
13352
|
+
"nodes.schema": NodesSchemaErrorCode;
|
|
12454
13353
|
"oauthGrants.list": OauthGrantsListErrorCode;
|
|
12455
13354
|
"oauthGrants.revoke": OauthGrantsRevokeErrorCode;
|
|
12456
13355
|
"oauthGrants.usage": OauthGrantsUsageErrorCode;
|
|
@@ -12481,7 +13380,11 @@ export type NivaErrorCodes = {
|
|
|
12481
13380
|
"users.listMembers": UsersListMembersErrorCode;
|
|
12482
13381
|
"users.me": UsersMeErrorCode;
|
|
12483
13382
|
"users.removeMember": UsersRemoveMemberErrorCode;
|
|
13383
|
+
"users.resetSecondFactor": UsersResetSecondFactorErrorCode;
|
|
13384
|
+
"users.revokeMemberSessions": UsersRevokeMemberSessionsErrorCode;
|
|
12484
13385
|
"users.suspendMember": UsersSuspendMemberErrorCode;
|
|
13386
|
+
"users.unlockMember": UsersUnlockMemberErrorCode;
|
|
13387
|
+
"users.updateMyNotificationEmail": UsersUpdateMyNotificationEmailErrorCode;
|
|
12485
13388
|
"users.updateMyNotificationToast": UsersUpdateMyNotificationToastErrorCode;
|
|
12486
13389
|
"users.updateRole": UsersUpdateRoleErrorCode;
|
|
12487
13390
|
"visualPlans.clone": VisualPlansCloneErrorCode;
|
|
@@ -12506,6 +13409,7 @@ export type NivaErrorCodes = {
|
|
|
12506
13409
|
"webhooks.endpoints.getById": WebhooksEndpointsGetByIdErrorCode;
|
|
12507
13410
|
"webhooks.endpoints.list": WebhooksEndpointsListErrorCode;
|
|
12508
13411
|
"webhooks.endpoints.rotateSecret": WebhooksEndpointsRotateSecretErrorCode;
|
|
13412
|
+
"webhooks.endpoints.test": WebhooksEndpointsTestErrorCode;
|
|
12509
13413
|
"webhooks.endpoints.update": WebhooksEndpointsUpdateErrorCode;
|
|
12510
13414
|
"webhooks.events.list": WebhooksEventsListErrorCode;
|
|
12511
13415
|
};
|
|
@@ -12691,6 +13595,11 @@ export interface OperationTypes {
|
|
|
12691
13595
|
output: AuditListOutput;
|
|
12692
13596
|
kind: "json";
|
|
12693
13597
|
};
|
|
13598
|
+
"bugReports.create": {
|
|
13599
|
+
input: BugReportsCreateInput;
|
|
13600
|
+
output: BugReportsCreateOutput;
|
|
13601
|
+
kind: "json";
|
|
13602
|
+
};
|
|
12694
13603
|
"callRecords.count": {
|
|
12695
13604
|
input: CallRecordsCountInput;
|
|
12696
13605
|
output: CallRecordsCountOutput;
|
|
@@ -13066,6 +13975,16 @@ export interface OperationTypes {
|
|
|
13066
13975
|
output: LicenseStatusOutput;
|
|
13067
13976
|
kind: "json";
|
|
13068
13977
|
};
|
|
13978
|
+
"nodes.list": {
|
|
13979
|
+
input: NodesListInput;
|
|
13980
|
+
output: NodesListOutput;
|
|
13981
|
+
kind: "json";
|
|
13982
|
+
};
|
|
13983
|
+
"nodes.schema": {
|
|
13984
|
+
input: NodesSchemaInput;
|
|
13985
|
+
output: NodesSchemaOutput;
|
|
13986
|
+
kind: "json";
|
|
13987
|
+
};
|
|
13069
13988
|
"oauthGrants.list": {
|
|
13070
13989
|
input: OauthGrantsListInput;
|
|
13071
13990
|
output: OauthGrantsListOutput;
|
|
@@ -13216,11 +14135,31 @@ export interface OperationTypes {
|
|
|
13216
14135
|
output: UsersRemoveMemberOutput;
|
|
13217
14136
|
kind: "json";
|
|
13218
14137
|
};
|
|
14138
|
+
"users.resetSecondFactor": {
|
|
14139
|
+
input: UsersResetSecondFactorInput;
|
|
14140
|
+
output: UsersResetSecondFactorOutput;
|
|
14141
|
+
kind: "json";
|
|
14142
|
+
};
|
|
14143
|
+
"users.revokeMemberSessions": {
|
|
14144
|
+
input: UsersRevokeMemberSessionsInput;
|
|
14145
|
+
output: UsersRevokeMemberSessionsOutput;
|
|
14146
|
+
kind: "json";
|
|
14147
|
+
};
|
|
13219
14148
|
"users.suspendMember": {
|
|
13220
14149
|
input: UsersSuspendMemberInput;
|
|
13221
14150
|
output: UsersSuspendMemberOutput;
|
|
13222
14151
|
kind: "json";
|
|
13223
14152
|
};
|
|
14153
|
+
"users.unlockMember": {
|
|
14154
|
+
input: UsersUnlockMemberInput;
|
|
14155
|
+
output: UsersUnlockMemberOutput;
|
|
14156
|
+
kind: "json";
|
|
14157
|
+
};
|
|
14158
|
+
"users.updateMyNotificationEmail": {
|
|
14159
|
+
input: UsersUpdateMyNotificationEmailInput;
|
|
14160
|
+
output: UsersUpdateMyNotificationEmailOutput;
|
|
14161
|
+
kind: "json";
|
|
14162
|
+
};
|
|
13224
14163
|
"users.updateMyNotificationToast": {
|
|
13225
14164
|
input: UsersUpdateMyNotificationToastInput;
|
|
13226
14165
|
output: UsersUpdateMyNotificationToastOutput;
|
|
@@ -13341,6 +14280,11 @@ export interface OperationTypes {
|
|
|
13341
14280
|
output: WebhooksEndpointsRotateSecretOutput;
|
|
13342
14281
|
kind: "json";
|
|
13343
14282
|
};
|
|
14283
|
+
"webhooks.endpoints.test": {
|
|
14284
|
+
input: WebhooksEndpointsTestInput;
|
|
14285
|
+
output: WebhooksEndpointsTestOutput;
|
|
14286
|
+
kind: "json";
|
|
14287
|
+
};
|
|
13344
14288
|
"webhooks.endpoints.update": {
|
|
13345
14289
|
input: WebhooksEndpointsUpdateInput;
|
|
13346
14290
|
output: WebhooksEndpointsUpdateOutput;
|