@babelforce/manager-sdk 0.2.1 → 0.4.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/dist/index.d.ts CHANGED
@@ -49,33 +49,1684 @@ type Environment = 'production';
49
49
  * A role associated with the Account
50
50
  */
51
51
  type AccountRole = 'manager' | 'owner' | 'reporter' | 'user' | 'agent' | 'supervisor' | 'sales' | 'router' | 'scheduler';
52
+ type Agent = {
53
+ /**
54
+ * The unique Identifier (UUID) of the object
55
+ */
56
+ id: string;
57
+ /**
58
+ * The ID of the external System the Agent was created from
59
+ */
60
+ sourceId?: string;
61
+ /**
62
+ * The Identifier for the external System the Agent was created from
63
+ */
64
+ agentSource?: string;
65
+ /**
66
+ * The Agent Name
67
+ */
68
+ name: string;
69
+ /**
70
+ * The Agents Login
71
+ */
72
+ email?: string;
73
+ /**
74
+ * The Agents current active Telephone-Number
75
+ */
76
+ number?: string;
77
+ /**
78
+ * Whether the Agent is able to receive Calls via Queue or not
79
+ */
80
+ enabled?: boolean;
81
+ state?: AgentLineStatus;
82
+ presence?: AgentPresence;
83
+ status?: AgentStatus;
84
+ activity?: string;
85
+ display_status?: string;
86
+ available?: boolean;
87
+ /**
88
+ * A List of Tags describing an Object
89
+ */
90
+ tags?: Array<Tag>;
91
+ groups?: Array<AgentGroupReference>;
92
+ /**
93
+ * Whether WebRTC is enabed for that Agent or not
94
+ */
95
+ webrtc?: boolean;
96
+ /**
97
+ * A List of features which are enabled for that particular Agent
98
+ */
99
+ features?: Array<string>;
100
+ dateCreated?: string;
101
+ lastUpdated?: string;
102
+ };
103
+ type AgentGroup = {
104
+ /**
105
+ * The unique Identifier (UUID) of the object
106
+ */
107
+ id: string;
108
+ name: string;
109
+ /**
110
+ * A List of Tags describing an Object
111
+ */
112
+ tags?: Array<Tag>;
113
+ };
114
+ type AgentGroupAdditionResponse = {
115
+ item?: AgentGroup;
116
+ agent?: Agent;
117
+ } & DefaultV2MessageResponse;
118
+ type AgentGroupItemResponse = {
119
+ item: AgentGroup;
120
+ /**
121
+ * Whether the Request was successful or not
122
+ */
123
+ success: boolean;
124
+ };
125
+ type AgentGroupReference = {
126
+ /**
127
+ * The unique Identifier (UUID) of the object
128
+ */
129
+ id: string;
130
+ /**
131
+ * The Group Name
132
+ */
133
+ name?: string;
134
+ dateCreated?: string;
135
+ };
136
+ type AgentItemResponse = {
137
+ item: Agent;
138
+ /**
139
+ * Whether the Request was successful or not
140
+ */
141
+ success: boolean;
142
+ };
143
+ type AgentLineStatus = 'available' | 'busy' | 'declined' | 'unreachable' | 'selected' | 'ringing' | 'in-call' | 'wrap-up';
144
+ type AgentPresence = {
145
+ available: boolean;
146
+ label: string;
147
+ name: string;
148
+ };
149
+ type AgentStatus = {
150
+ enabled: boolean;
151
+ available: boolean;
152
+ outbound_status: AgentStatusOutboundStatus;
153
+ line_status: AgentLineStatus;
154
+ presence: AgentPresence;
155
+ activity?: unknown;
156
+ display_status: string;
157
+ };
158
+ type AgentStatusOutboundStatus = 'offline' | 'online';
159
+ type AgenticApplication = {
160
+ /**
161
+ * The unique Identifier (UUID) of the object
162
+ */
163
+ id: string;
164
+ name: string;
165
+ friendlyName?: string;
166
+ enabled: boolean;
167
+ dateCreated: string;
168
+ lastUpdated: string;
169
+ /**
170
+ * A List of Tags describing an Object
171
+ */
172
+ tags: Array<Tag>;
173
+ routings: Array<ApplicationRouting>;
174
+ settings: AgenticApplicationSettings;
175
+ module: 'agentic';
176
+ };
177
+ type AgenticApplicationProviderSettings = {
178
+ providerName?: 'ultimate';
179
+ } & AgenticApplicationUltimateProviderSettings;
180
+ type AgenticApplicationSettings = {
181
+ flowEndApplication?: ResourceReference;
182
+ prompts?: Array<ApplicationPrompt>;
183
+ textToSpeech?: DefaultTextToSpeechSettings;
184
+ routes?: Array<ApplicationRoutesInner>;
185
+ speechToText: AgenticApplicationSettingsSpeechToText;
186
+ /**
187
+ * Max duration in seconds
188
+ */
189
+ maxDuration: number;
190
+ maxIterations: number;
191
+ stopTrigger?: ApplicationSettingsTrigger;
192
+ provider_settings: AgenticApplicationProviderSettings;
193
+ };
194
+ type AgenticApplicationSettingsSpeechToText = {
195
+ /**
196
+ * Continuous timeout in seconds
197
+ */
198
+ timeout: number;
199
+ provider: 'google' | 'azure';
200
+ language: string;
201
+ };
202
+ type AgenticApplicationUltimateProviderSettings = {
203
+ providerName: 'ultimate';
204
+ botId: string;
205
+ };
206
+ type AgenticApplicationUpdateBody = {
207
+ name?: string;
208
+ friendlyName?: string;
209
+ enabled?: boolean;
210
+ /**
211
+ * A List of Tags describing an Object
212
+ */
213
+ tags?: Array<Tag>;
214
+ routings?: Array<ApplicationRouting>;
215
+ settings?: AgenticApplicationSettings;
216
+ module: 'agentic';
217
+ };
218
+ type Application = ({
219
+ module?: 'agentQueue';
220
+ } & QueueAgentApplication) | ({
221
+ module?: 'agentic';
222
+ } & AgenticApplication) | ({
223
+ module?: 'audioPlayer';
224
+ } & AudioPlayerApplication) | ({
225
+ module?: 'consumerQueue';
226
+ } & QueueConsumerApplication) | ({
227
+ module?: 'inputReader';
228
+ } & InputReaderApplication) | ({
229
+ module?: 'inputReader.v2';
230
+ } & InputReaderV2Application) | ({
231
+ module?: 'promptPlayer';
232
+ } & PromptPlayerApplication) | ({
233
+ module?: 'recording';
234
+ } & RecordingApplication) | ({
235
+ module?: 'simpleMenu';
236
+ } & SimpleMenuApplication) | ({
237
+ module?: 'speechToText';
238
+ } & SpeechToTextApplication) | ({
239
+ module?: 'switchNode';
240
+ } & SwitchNodeApplication) | ({
241
+ module?: 'textToSpeech';
242
+ } & TextToSpeechApplication) | ({
243
+ module?: 'transfer';
244
+ } & TransferApplication);
245
+ type ApplicationCreateBody = {
246
+ name: string;
247
+ module: IvrModule;
248
+ };
249
+ type ApplicationItemResponse = {
250
+ item: Application;
251
+ /**
252
+ * Whether the Request was successful or not
253
+ */
254
+ success: boolean;
255
+ };
256
+ type ApplicationPrompt = ApplicationPromptFile | ApplicationPromptTts | ApplicationPromptUrl;
257
+ type ApplicationPromptBase = {
258
+ key: string;
259
+ enabled?: boolean;
260
+ startDelay?: number;
261
+ endPause?: number;
262
+ };
263
+ type ApplicationPromptFile = ApplicationPromptBase & {
264
+ id: ObjectUuid;
265
+ };
266
+ type ApplicationPromptTts = ApplicationPromptBase & {
267
+ text: string;
268
+ gender?: 'male' | 'female' | 'neutral';
269
+ language?: string;
270
+ /**
271
+ * Available voice according to the provider
272
+ */
273
+ voice?: string;
274
+ /**
275
+ * Specific provider settings for generating prompt
276
+ */
277
+ providerSettings?: ApplicationPromptTtsProviderSettingsElevenLabs;
278
+ };
279
+ type ApplicationPromptTtsProviderSettingsElevenLabs = {
280
+ apply_text_normalization?: string;
281
+ voice_settings?: {
282
+ stability?: number;
283
+ speed?: number;
284
+ };
285
+ };
286
+ type ApplicationPromptUrl = ApplicationPromptBase & {
287
+ url: string;
288
+ };
289
+ type ApplicationRoutesInner = {
290
+ conditions: Array<{
291
+ /**
292
+ * Existing trigger referenced by id. Mutually exclusive with inline triggers like
293
+ */
294
+ id?: string;
295
+ invert?: boolean;
296
+ /**
297
+ * Inline trigger, checks are 2 values equal in array
298
+ */
299
+ eq?: Array<string>;
300
+ }>;
301
+ application?: ResourceReference;
302
+ priority: number;
303
+ };
304
+ type ApplicationRouting = {
305
+ /**
306
+ * The unique Identifier (UUID) of the object
307
+ */
308
+ id: string;
309
+ number: ApplicationRoutingNumber;
310
+ };
311
+ type ApplicationRoutingNumber = {
312
+ /**
313
+ * The unique Identifier (UUID) of the object
314
+ */
315
+ id: string;
316
+ number: string;
317
+ sms: boolean;
318
+ enabled: boolean;
319
+ /**
320
+ * A List of Tags describing an Object
321
+ */
322
+ tags: Array<Tag>;
323
+ };
324
+ type ApplicationSettingsTrigger = {
325
+ /**
326
+ * The unique Identifier (UUID) of the object
327
+ */
328
+ id: string;
329
+ invert?: boolean;
330
+ enabled?: boolean;
331
+ };
332
+ type ApplicationUpdateBody = ({
333
+ module?: 'agentQueue';
334
+ } & QueueAgentApplicationUpdateBody) | ({
335
+ module?: 'agentic';
336
+ } & AgenticApplicationUpdateBody) | ({
337
+ module?: 'audioPlayer';
338
+ } & AudioPlayerApplicationUpdateBody) | ({
339
+ module?: 'consumerQueue';
340
+ } & QueueConsumerApplicationUpdateBody) | ({
341
+ module?: 'inputReader';
342
+ } & InputReaderApplicationUpdateBody) | ({
343
+ module?: 'inputReader.v2';
344
+ } & InputReaderV2ApplicationUpdateBody) | ({
345
+ module?: 'promptPlayer';
346
+ } & PromptPlayerApplicationUpdateBody) | ({
347
+ module?: 'recording';
348
+ } & RecordingApplicationUpdateBody) | ({
349
+ module?: 'simpleMenu';
350
+ } & SimpleMenuApplicationUpdateBody) | ({
351
+ module?: 'speechToText';
352
+ } & SpeechToTextApplicationUpdateBody) | ({
353
+ module?: 'switchNode';
354
+ } & SwitchNodeApplicationUpdateBody) | ({
355
+ module?: 'textToSpeech';
356
+ } & TextToSpeechApplicationUpdateBody) | ({
357
+ module?: 'transfer';
358
+ } & TransferApplicationUpdateBody);
359
+ type AudioPlayerApplication = {
360
+ /**
361
+ * The unique Identifier (UUID) of the object
362
+ */
363
+ id: string;
364
+ name: string;
365
+ friendlyName?: string;
366
+ enabled: boolean;
367
+ dateCreated: string;
368
+ lastUpdated: string;
369
+ /**
370
+ * A List of Tags describing an Object
371
+ */
372
+ tags: Array<Tag>;
373
+ routings: Array<ApplicationRouting>;
374
+ settings: AudioPlayerApplicationSettings;
375
+ module: 'audioPlayer';
376
+ };
377
+ type AudioPlayerApplicationSettings = {
378
+ flowEndApplication?: ResourceReference;
379
+ prompts?: Array<ApplicationPrompt>;
380
+ textToSpeech?: DefaultTextToSpeechSettings;
381
+ routes?: Array<ApplicationRoutesInner>;
382
+ };
383
+ type AudioPlayerApplicationUpdateBody = {
384
+ name?: string;
385
+ friendlyName?: string;
386
+ enabled?: boolean;
387
+ /**
388
+ * A List of Tags describing an Object
389
+ */
390
+ tags?: Array<Tag>;
391
+ routings?: Array<ApplicationRouting>;
392
+ settings?: AudioPlayerApplicationSettings;
393
+ module: 'audioPlayer';
394
+ };
395
+ type AutomationAction = {
396
+ name: string;
397
+ type: string;
398
+ code?: string;
399
+ provider?: string;
400
+ };
401
+ type AutomationTrigger = {
402
+ /**
403
+ * The unique Identifier (UUID) of the object
404
+ */
405
+ id: string;
406
+ };
407
+ type BaseAutomation = {
408
+ /**
409
+ * The unique Identifier (UUID) of the object
410
+ */
411
+ id: string;
412
+ priority: number;
413
+ label: string;
414
+ invertTrigger?: boolean;
415
+ trigger?: AutomationTrigger;
416
+ action: AutomationAction;
417
+ options: {
418
+ [key: string]: unknown;
419
+ };
420
+ /**
421
+ * A List of Tags describing an Object
422
+ */
423
+ tags?: Array<Tag>;
424
+ };
425
+ type Call = {
426
+ /**
427
+ * The unique Identifier (UUID) of the object
428
+ */
429
+ id: string;
430
+ /**
431
+ * The unique Identifier (UUID) of the object
432
+ */
433
+ parentId?: string;
434
+ /**
435
+ * The unique Identifier (UUID) of the object
436
+ */
437
+ sessionId: string;
438
+ /**
439
+ * The unique Identifier (UUID) of the object
440
+ */
441
+ conversationId?: string;
442
+ dateCreated?: string;
443
+ lastUpdated?: string;
444
+ dateEstablished?: string;
445
+ dateFinished?: string;
446
+ state: CallState;
447
+ finishReason?: CallFinishReason;
448
+ type: CallType;
449
+ from: string;
450
+ to: string;
451
+ source: CallSource;
452
+ domain: CallDomain;
453
+ duration?: number;
454
+ anonymous?: boolean;
455
+ recordings?: Array<Recording>;
456
+ bridged?: CallBridged;
457
+ };
458
+ type CallBridged = {
459
+ /**
460
+ * The unique Identifier (UUID) of the object
461
+ */
462
+ id: string;
463
+ /**
464
+ * Name of the bridged agent
465
+ */
466
+ name: string;
467
+ /**
468
+ * Number of the bridged agent
469
+ */
470
+ number: string;
471
+ /**
472
+ * The unique Identifier (UUID) of the object
473
+ */
474
+ queueId: string;
475
+ queueName: string;
476
+ agent?: CallBridgedAgent;
477
+ };
478
+ type CallBridgedAgent = {
479
+ /**
480
+ * The unique Identifier (UUID) of the object
481
+ */
482
+ id: string;
483
+ /**
484
+ * Name of the bridged agent
485
+ */
486
+ name: string;
487
+ /**
488
+ * Number of the bridged agent
489
+ */
490
+ number: string;
491
+ };
492
+ type CallDomain = 'internal' | 'external' | 'other';
493
+ type CallFinishReason = 'unknown' | 'hangup' | 'passive-hangup' | 'system-hangup' | 'failed' | 'timeout' | 'unreachable' | 'busy' | 'declined' | 'canceled' | 'transferred' | 'network-unreachable' | 'unallocated-number' | 'invalid-number' | 'no-answer' | 'dropped';
494
+ type CallSource = 'queue' | 'webrtc' | 'api' | 'dialer' | 'dial' | 'transfer' | 'test' | 'conference';
495
+ /**
496
+ * One Call State
497
+ */
498
+ type CallState = 'init' | 'scheduled' | 'ringing' | 'in-progress' | 'queued' | 'bridged' | 'canceled' | 'busy' | 'no-answer' | 'purged' | 'completed' | 'failed';
499
+ type CallType = 'inbound' | 'outbound';
52
500
  type CreateManagedUserRequest = {
53
501
  password?: string;
54
502
  email: string;
55
503
  activated?: boolean;
56
504
  /**
57
- * A List of Roles which are associated with the current User
505
+ * A List of Roles which are associated with the current User
506
+ */
507
+ roles: Array<AccountRole>;
508
+ };
509
+ type DefaultTextToSpeechSettings = {
510
+ language?: string;
511
+ voice?: string;
512
+ provider?: 'google' | 'azure';
513
+ };
514
+ type DefaultV2MessageResponse = {
515
+ message?: string;
516
+ /**
517
+ * Whether or not the request was successful
518
+ */
519
+ success: boolean;
520
+ };
521
+ type DispatchLocalAutomationsResponse = {
522
+ success?: boolean;
523
+ };
524
+ type FileReference = {
525
+ /**
526
+ * The unique Identifier (UUID) of the object
527
+ */
528
+ id: string;
529
+ state: FileState;
530
+ name: string;
531
+ size: number;
532
+ contentType: string;
533
+ };
534
+ type FileState = 'created' | 'storing' | 'stored' | 'failed' | 'deleted' | 'missing';
535
+ type InputReaderApplication = {
536
+ /**
537
+ * The unique Identifier (UUID) of the object
538
+ */
539
+ id: string;
540
+ name: string;
541
+ friendlyName?: string;
542
+ enabled: boolean;
543
+ dateCreated: string;
544
+ lastUpdated: string;
545
+ /**
546
+ * A List of Tags describing an Object
547
+ */
548
+ tags: Array<Tag>;
549
+ routings: Array<ApplicationRouting>;
550
+ settings: InputReaderApplicationSettings;
551
+ module: 'inputReader';
552
+ };
553
+ type InputReaderApplicationSettings = {
554
+ flowEndApplication?: ResourceReference;
555
+ prompts?: Array<ApplicationPrompt>;
556
+ resultVariableName: string;
557
+ terminationDigit?: InputReaderTerminationDigit;
558
+ readTimeout?: number;
559
+ min?: number;
560
+ max?: number;
561
+ maxRetries?: number;
562
+ ignoreNoInput?: boolean;
563
+ };
564
+ type InputReaderApplicationUpdateBody = {
565
+ name?: string;
566
+ friendlyName?: string;
567
+ enabled?: boolean;
568
+ /**
569
+ * A List of Tags describing an Object
570
+ */
571
+ tags?: Array<Tag>;
572
+ routings?: Array<ApplicationRouting>;
573
+ settings?: InputReaderApplicationSettings;
574
+ module: 'inputReader';
575
+ };
576
+ type InputReaderTerminationDigit = 'NONE' | 'ANY' | 'ASTERISK' | 'HASH' | 'KEY_0' | 'KEY_1' | 'KEY_2' | 'KEY_3' | 'KEY_4' | 'KEY_5' | 'KEY_6' | 'KEY_7' | 'KEY_8' | 'KEY_9';
577
+ type InputReaderV2Application = {
578
+ /**
579
+ * The unique Identifier (UUID) of the object
580
+ */
581
+ id: string;
582
+ name: string;
583
+ friendlyName?: string;
584
+ enabled: boolean;
585
+ dateCreated: string;
586
+ lastUpdated: string;
587
+ /**
588
+ * A List of Tags describing an Object
589
+ */
590
+ tags: Array<Tag>;
591
+ routings: Array<ApplicationRouting>;
592
+ settings: InputReaderV2ApplicationSettings;
593
+ module: 'inputReader.v2';
594
+ };
595
+ type InputReaderV2ApplicationSettings = {
596
+ flowEndApplication?: ResourceReference;
597
+ prompts?: Array<ApplicationPrompt>;
598
+ textToSpeech?: DefaultTextToSpeechSettings;
599
+ routes?: Array<ApplicationRoutesInner>;
600
+ resultVariableName: string;
601
+ bargeIn?: InputReaderV2ApplicationSettingsBargeIn;
602
+ dtmf?: InputReaderV2ApplicationSettingsDtmf;
603
+ voice?: InputReaderV2ApplicationSettingsVoice;
604
+ /**
605
+ * When set to true the resulting variable will be stored as boolean value
606
+ */
607
+ confirmation?: boolean;
608
+ numeric?: InputReaderV2ApplicationSettingsNumeric;
609
+ maxAttempts?: number;
610
+ ignoreNoInput?: boolean;
611
+ timeouts?: InputReaderV2ApplicationSettingsTimeouts;
612
+ };
613
+ type InputReaderV2ApplicationSettingsBargeIn = {
614
+ enabled?: boolean;
615
+ delay?: number;
616
+ };
617
+ type InputReaderV2ApplicationSettingsDtmf = {
618
+ enabled?: boolean;
619
+ termination?: InputReaderV2TerminationDigit;
620
+ };
621
+ type InputReaderV2ApplicationSettingsNumeric = {
622
+ min: number;
623
+ max: number;
624
+ };
625
+ type InputReaderV2ApplicationSettingsTimeouts = {
626
+ /**
627
+ * Initial timeout in seconds
628
+ */
629
+ initial: number;
630
+ /**
631
+ * Continuous timeout in seconds
632
+ */
633
+ continious: number;
634
+ };
635
+ type InputReaderV2ApplicationSettingsVoice = {
636
+ enabled: boolean;
637
+ language: string;
638
+ transformer?: 'confirmation';
639
+ transformerOptions?: {
640
+ [key: string]: unknown;
641
+ };
642
+ provider?: 'azure';
643
+ };
644
+ type InputReaderV2ApplicationUpdateBody = {
645
+ name?: string;
646
+ friendlyName?: string;
647
+ enabled?: boolean;
648
+ /**
649
+ * A List of Tags describing an Object
650
+ */
651
+ tags?: Array<Tag>;
652
+ routings?: Array<ApplicationRouting>;
653
+ settings?: InputReaderV2ApplicationSettings;
654
+ module: 'inputReader.v2';
655
+ };
656
+ type InputReaderV2TerminationDigit = 'ASTERISK' | 'HASH';
657
+ type IvrModule = 'agentQueue' | 'agentic' | 'audioPlayer' | 'consumerQueue' | 'inputReader' | 'inputReader.v2' | 'promptPlayer' | 'recording' | 'simpleMenu' | 'speechToText' | 'switchNode' | 'textToSpeech' | 'transfer';
658
+ type ListModulesResponse = {
659
+ items: Array<IvrModule>;
660
+ };
661
+ type LocalAutomation = BaseAutomation;
662
+ type LocalAutomationDispatch = {
663
+ /**
664
+ * The ID of a Call to add to context
665
+ */
666
+ callId?: string;
667
+ };
668
+ type LocalAutomationItemResponse = {
669
+ item: LocalAutomation;
670
+ /**
671
+ * Whether the Request was successful or not
672
+ */
673
+ success: boolean;
674
+ };
675
+ type ManagedUser = {
676
+ /**
677
+ * The unique Identifier (UUID) of the object
678
+ */
679
+ id: string;
680
+ email: string;
681
+ enabled?: boolean;
682
+ /**
683
+ * A List of Roles which are associated with the current User
684
+ */
685
+ roles: Array<AccountRole>;
686
+ };
687
+ type ManagedUserItemResponse = {
688
+ item: ManagedUser;
689
+ /**
690
+ * Whether the Request was successful or not
691
+ */
692
+ success: boolean;
693
+ };
694
+ type MetricDefinition = {
695
+ id?: MetricId;
696
+ description: string;
697
+ tags: Array<string>;
698
+ filters: Array<MetricDefinitionFilter>;
699
+ };
700
+ type MetricDefinitionFilter = {
701
+ name?: string;
702
+ description: string;
703
+ type: string;
704
+ format?: string;
705
+ enum?: Array<string>;
706
+ items?: MetricDefinitionFilterItems;
707
+ };
708
+ type MetricDefinitionFilterItems = {
709
+ type?: string;
710
+ enum?: Array<string>;
711
+ };
712
+ type MetricDefinitionItemResponse = {
713
+ item: MetricDefinition;
714
+ /**
715
+ * Whether the Request was successful or not
716
+ */
717
+ success: boolean;
718
+ };
719
+ type MetricId = 'abandon.total' | 'abandon.value' | 'agents.line-status.total' | 'agents.not_available.total' | 'agents.presence.total' | 'agents.state.available.total' | 'agents.state.busy.total' | 'agents.state.declined.total' | 'agents.state.in_call.total' | 'agents.state.originated.total' | 'agents.state.ringing.total' | 'agents.state.selected.total' | 'agents.state.unreachable.total' | 'agents.state.wrap_up.total' | 'agents.total' | 'calls.duration.avg' | 'calls.duration.total' | 'calls.hold.avg' | 'calls.hold.total' | 'calls.total' | 'conversations.events.total' | 'conversations.total' | 'date.value' | 'one.value' | 'outbound.campaign.agents.in_call.total' | 'outbound.campaign.agents.in_calls.total' | 'outbound.campaign.agents.in_dead_calls.total' | 'outbound.campaign.agents.in_disp.total' | 'outbound.campaign.agents.logged_in.total' | 'outbound.campaign.agents.paused.total' | 'outbound.campaign.agents.waiting.total' | 'outbound.campaign.calls.answer_ratio.total' | 'outbound.campaign.calls.answered.total' | 'outbound.campaign.calls.being_placed.total' | 'outbound.campaign.calls.drop_answer_ratio.total' | 'outbound.campaign.calls.drop_ratio.total' | 'outbound.campaign.calls.dropped.total' | 'outbound.campaign.calls.in_ivr.total' | 'outbound.campaign.calls.ringing.total' | 'outbound.campaign.calls.total_today.total' | 'outbound.campaign.calls.waiting_for_agents.total' | 'outbound.campaign.leads.dialable.total' | 'outbound.campaign.leads.in_hopper.total' | 'outbound.campaign.status.total' | 'queues.bridge-time.total' | 'queues.calls.total' | 'queues.calls.waiting.total' | 'queues.expected.wait-time.avg' | 'queues.handle-time.avg' | 'queues.handle-time.total' | 'queues.talk-time.avg' | 'queues.talk-time.total' | 'queues.total' | 'queues.wait-time.avg' | 'queues.wait-time.total' | 'queues.wrapup.avg' | 'queues.wrapup.total' | 'random.float.value' | 'random.int.value' | 'recordings.duration.avg' | 'recordings.duration.total' | 'recordings.total' | 'service-level.total' | 'service-level.value' | 'sms.total' | 'time.value' | 'zero.value';
720
+ type MetricIdItemsResponse = {
721
+ items: Array<MetricId>;
722
+ /**
723
+ * Whether or not the request was successful
724
+ */
725
+ success: boolean;
726
+ };
727
+ type MetricRequestPushResponse = {
728
+ [key: string]: unknown;
729
+ };
730
+ type MetricResetCountersResponse = {
731
+ [key: string]: unknown;
732
+ };
733
+ type MetricResponse = {
734
+ id: MetricId;
735
+ /**
736
+ * The Type of the Metric Value
737
+ */
738
+ type: string;
739
+ metric: MetricResponseMetric;
740
+ request: MetricResponseRequest;
741
+ success: boolean;
742
+ };
743
+ type MetricResponseMetric = {
744
+ /**
745
+ * The Value of the Metric
746
+ */
747
+ value: unknown;
748
+ };
749
+ type MetricResponseRequest = {
750
+ id: MetricId;
751
+ /**
752
+ * Evaluation Time of the Metric
753
+ */
754
+ runtime: unknown;
755
+ timeRange: MetricResponseRequestTimeRange;
756
+ };
757
+ /**
758
+ * Requested Time-Range for the Evaluation
759
+ */
760
+ type MetricResponseRequestTimeRange = {
761
+ from: string;
762
+ to: string;
763
+ value: MetricTimeRange;
764
+ /**
765
+ * Total duration of the requested range.
766
+ */
767
+ duration: number;
768
+ };
769
+ type MetricTimeRange = 'TODAY' | 'YESTERDAY' | 'LAST_DAY' | 'LAST_24_HOURS' | 'LAST_3_DAYS' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'THIS_WEEK' | 'PREVIOUS_WEEK' | 'THIS_MONTH' | 'PREVIOUS_MONTH' | 'LAST_3_MONTHS' | 'THIS_QUARTER' | 'PREVIOUS_QUARTER';
770
+ /**
771
+ * The unique Identifier (UUID) of the object
772
+ */
773
+ type ObjectUuid = string;
774
+ type PromptPlayerApplication = {
775
+ /**
776
+ * The unique Identifier (UUID) of the object
777
+ */
778
+ id: string;
779
+ name: string;
780
+ friendlyName?: string;
781
+ enabled: boolean;
782
+ dateCreated: string;
783
+ lastUpdated: string;
784
+ /**
785
+ * A List of Tags describing an Object
786
+ */
787
+ tags: Array<Tag>;
788
+ routings: Array<ApplicationRouting>;
789
+ settings: PromptPlayerApplicationSettings;
790
+ module: 'promptPlayer';
791
+ };
792
+ type PromptPlayerApplicationSettings = {
793
+ flowEndApplication?: ResourceReference;
794
+ prompts?: Array<ApplicationPrompt>;
795
+ language?: string;
796
+ gender?: string;
797
+ };
798
+ type PromptPlayerApplicationUpdateBody = {
799
+ name?: string;
800
+ friendlyName?: string;
801
+ enabled?: boolean;
802
+ /**
803
+ * A List of Tags describing an Object
804
+ */
805
+ tags?: Array<Tag>;
806
+ routings?: Array<ApplicationRouting>;
807
+ settings?: PromptPlayerApplicationSettings;
808
+ module: 'promptPlayer';
809
+ };
810
+ type QueueAgentApplication = {
811
+ /**
812
+ * The unique Identifier (UUID) of the object
813
+ */
814
+ id: string;
815
+ name: string;
816
+ friendlyName?: string;
817
+ enabled: boolean;
818
+ dateCreated: string;
819
+ lastUpdated: string;
820
+ /**
821
+ * A List of Tags describing an Object
822
+ */
823
+ tags: Array<Tag>;
824
+ routings: Array<ApplicationRouting>;
825
+ settings: QueueAgentApplicationSettings;
826
+ module: 'agentQueue';
827
+ };
828
+ type QueueAgentApplicationSettings = {
829
+ flowEndApplication?: ResourceReference;
830
+ prompts?: Array<ApplicationPrompt>;
831
+ ring?: boolean;
832
+ bridgeDelay?: number;
833
+ };
834
+ type QueueAgentApplicationUpdateBody = {
835
+ name?: string;
836
+ friendlyName?: string;
837
+ enabled?: boolean;
838
+ /**
839
+ * A List of Tags describing an Object
840
+ */
841
+ tags?: Array<Tag>;
842
+ routings?: Array<ApplicationRouting>;
843
+ settings?: QueueAgentApplicationSettings;
844
+ module: 'agentQueue';
845
+ };
846
+ type QueueConsumerApplication = {
847
+ /**
848
+ * The unique Identifier (UUID) of the object
849
+ */
850
+ id: string;
851
+ name: string;
852
+ friendlyName?: string;
853
+ enabled: boolean;
854
+ dateCreated: string;
855
+ lastUpdated: string;
856
+ /**
857
+ * A List of Tags describing an Object
858
+ */
859
+ tags: Array<Tag>;
860
+ routings: Array<ApplicationRouting>;
861
+ settings: QueueConsumerApplicationSettings;
862
+ module: 'consumerQueue';
863
+ };
864
+ type QueueConsumerApplicationSettings = {
865
+ flowEndApplication?: ResourceReference;
866
+ prompts?: Array<ApplicationPrompt>;
867
+ queue: ResourceReference;
868
+ queueExperience?: ResourceReference;
869
+ agentExperience?: ResourceReference;
870
+ trigger: ApplicationSettingsTrigger;
871
+ exitTrigger?: ApplicationSettingsTrigger;
872
+ recordTrigger?: ApplicationSettingsTrigger;
873
+ ringTime?: number;
874
+ record?: boolean;
875
+ };
876
+ type QueueConsumerApplicationUpdateBody = {
877
+ name?: string;
878
+ friendlyName?: string;
879
+ enabled?: boolean;
880
+ /**
881
+ * A List of Tags describing an Object
882
+ */
883
+ tags?: Array<Tag>;
884
+ routings?: Array<ApplicationRouting>;
885
+ settings?: QueueConsumerApplicationSettings;
886
+ module: 'consumerQueue';
887
+ };
888
+ type Recording = {
889
+ /**
890
+ * The unique Identifier (UUID) of the object
891
+ */
892
+ id: string;
893
+ /**
894
+ * Duration in Seconds
895
+ */
896
+ duration: number;
897
+ url: string;
898
+ state?: RecordingState;
899
+ file: FileReference;
900
+ call: RecordingCall;
901
+ agent?: RecordingAgent;
902
+ /**
903
+ * A List of Tags describing an Object
904
+ */
905
+ tags: Array<Tag>;
906
+ };
907
+ type RecordingAgent = {
908
+ /**
909
+ * The unique Identifier (UUID) of the object
910
+ */
911
+ id: string;
912
+ name: string;
913
+ number: string;
914
+ };
915
+ type RecordingApplication = {
916
+ /**
917
+ * The unique Identifier (UUID) of the object
918
+ */
919
+ id: string;
920
+ name: string;
921
+ friendlyName?: string;
922
+ enabled: boolean;
923
+ dateCreated: string;
924
+ lastUpdated: string;
925
+ /**
926
+ * A List of Tags describing an Object
927
+ */
928
+ tags: Array<Tag>;
929
+ routings: Array<ApplicationRouting>;
930
+ settings: RecordingApplicationSettings;
931
+ module: 'recording';
932
+ };
933
+ type RecordingApplicationSettings = {
934
+ flowEndApplication?: ResourceReference;
935
+ prompts?: Array<ApplicationPrompt>;
936
+ beep: boolean;
937
+ terminationDigit?: InputReaderTerminationDigit;
938
+ maxDuration: number;
939
+ /**
940
+ * A List of Tags describing an Object
941
+ */
942
+ tags: Array<Tag>;
943
+ };
944
+ type RecordingApplicationUpdateBody = {
945
+ name?: string;
946
+ friendlyName?: string;
947
+ enabled?: boolean;
948
+ /**
949
+ * A List of Tags describing an Object
58
950
  */
59
- roles: Array<AccountRole>;
951
+ tags?: Array<Tag>;
952
+ routings?: Array<ApplicationRouting>;
953
+ settings?: RecordingApplicationSettings;
954
+ module: 'recording';
60
955
  };
61
- type ManagedUser = {
956
+ type RecordingCall = {
62
957
  /**
63
958
  * The unique Identifier (UUID) of the object
64
959
  */
65
960
  id: string;
66
- email: string;
961
+ /**
962
+ * The unique Identifier (UUID) of the object
963
+ */
964
+ conversationId: string;
965
+ type: CallType;
966
+ from: string;
967
+ to: string;
968
+ };
969
+ type RecordingState = 'init' | 'recording' | 'failed' | 'stopped' | 'stored' | 'deleted' | 'missing';
970
+ /**
971
+ * A Reporting Call
972
+ */
973
+ type ReportingCall = {
974
+ /**
975
+ * The unique Identifier (UUID) of the object
976
+ */
977
+ id: string;
978
+ /**
979
+ * The unique Identifier (UUID) of the object
980
+ */
981
+ sessionId: string;
982
+ dateCreated: string;
983
+ lastUpdated: string;
984
+ type: ReportingCallType;
985
+ queueName?: string;
986
+ agentName?: string;
987
+ bridged: boolean;
988
+ duration: number;
989
+ waitTime: number;
990
+ queueWaitTime: number;
991
+ bridgeTime: number;
992
+ talkTime: number;
993
+ holdTime: number;
994
+ wrapupTime: number;
995
+ handleTime: number;
996
+ };
997
+ type ReportingCallType = 'inboundCall' | 'outboundCall';
998
+ /**
999
+ * Filter for Number
1000
+ */
1001
+ type ReportingNumberFilter = string;
1002
+ /**
1003
+ * Reference by ID
1004
+ */
1005
+ type ResourceReference = {
1006
+ /**
1007
+ * The unique Identifier (UUID) of the object
1008
+ */
1009
+ id: string;
1010
+ };
1011
+ type RestCreateAgent = {
1012
+ /**
1013
+ * The ID of the external System the Agent was created from
1014
+ */
1015
+ sourceId?: string;
1016
+ /**
1017
+ * The Identifier for the external System the Agent was created from
1018
+ */
1019
+ agentSource?: string;
1020
+ /**
1021
+ * The Agent Name
1022
+ */
1023
+ name: string;
1024
+ /**
1025
+ * The Agents Login
1026
+ */
1027
+ email?: string;
1028
+ /**
1029
+ * The Agents current active Telephone-Number
1030
+ */
1031
+ number?: string;
1032
+ /**
1033
+ * Whether the Agent is able to receive Calls via Queue or not
1034
+ */
67
1035
  enabled?: boolean;
1036
+ state?: AgentLineStatus;
1037
+ presence?: AgentPresence;
1038
+ status?: AgentStatus;
1039
+ activity?: string;
1040
+ display_status?: string;
1041
+ available?: boolean;
68
1042
  /**
69
- * A List of Roles which are associated with the current User
1043
+ * A List of Tags describing an Object
70
1044
  */
71
- roles: Array<AccountRole>;
1045
+ tags?: Array<Tag>;
1046
+ groups?: Array<AgentGroupReference>;
1047
+ /**
1048
+ * Whether WebRTC is enabed for that Agent or not
1049
+ */
1050
+ webrtc?: boolean;
1051
+ /**
1052
+ * A List of features which are enabled for that particular Agent
1053
+ */
1054
+ features?: Array<string>;
72
1055
  };
73
- type ManagedUserItemResponse = {
74
- item: ManagedUser;
1056
+ type RestCreateAgentGroup = {
1057
+ name: string;
75
1058
  /**
76
- * Whether the Request was successful or not
1059
+ * A List of Tags describing an Object
77
1060
  */
78
- success: boolean;
1061
+ tags?: Array<Tag>;
1062
+ };
1063
+ type RestCreateBaseAutomation = {
1064
+ priority: number;
1065
+ label: string;
1066
+ invertTrigger?: boolean;
1067
+ trigger?: AutomationTrigger;
1068
+ action: AutomationAction;
1069
+ options: {
1070
+ [key: string]: unknown;
1071
+ };
1072
+ /**
1073
+ * A List of Tags describing an Object
1074
+ */
1075
+ tags?: Array<Tag>;
1076
+ };
1077
+ type RestCreateLocalAutomation = RestCreateBaseAutomation;
1078
+ type RestUpdateAgent = {
1079
+ /**
1080
+ * The ID of the external System the Agent was created from
1081
+ */
1082
+ sourceId?: string;
1083
+ /**
1084
+ * The Identifier for the external System the Agent was created from
1085
+ */
1086
+ agentSource?: string;
1087
+ /**
1088
+ * The Agent Name
1089
+ */
1090
+ name?: string;
1091
+ /**
1092
+ * The Agents Login
1093
+ */
1094
+ email?: string;
1095
+ /**
1096
+ * The Agents current active Telephone-Number
1097
+ */
1098
+ number?: string;
1099
+ /**
1100
+ * Whether the Agent is able to receive Calls via Queue or not
1101
+ */
1102
+ enabled?: boolean;
1103
+ state?: AgentLineStatus;
1104
+ presence?: AgentPresence;
1105
+ status?: AgentStatus;
1106
+ activity?: string;
1107
+ display_status?: string;
1108
+ available?: boolean;
1109
+ /**
1110
+ * A List of Tags describing an Object
1111
+ */
1112
+ tags?: Array<Tag>;
1113
+ groups?: Array<AgentGroupReference>;
1114
+ /**
1115
+ * Whether WebRTC is enabed for that Agent or not
1116
+ */
1117
+ webrtc?: boolean;
1118
+ /**
1119
+ * A List of features which are enabled for that particular Agent
1120
+ */
1121
+ features?: Array<string>;
1122
+ };
1123
+ type RestUpdateAgentGroup = {
1124
+ name?: string;
1125
+ /**
1126
+ * A List of Tags describing an Object
1127
+ */
1128
+ tags?: Array<Tag>;
1129
+ };
1130
+ type RestUpdateBaseAutomation = {
1131
+ priority?: number;
1132
+ label?: string;
1133
+ invertTrigger?: boolean;
1134
+ trigger?: AutomationTrigger;
1135
+ action?: AutomationAction;
1136
+ options?: {
1137
+ [key: string]: unknown;
1138
+ };
1139
+ /**
1140
+ * A List of Tags describing an Object
1141
+ */
1142
+ tags?: Array<Tag>;
1143
+ };
1144
+ type RestUpdateLocalAutomation = RestUpdateBaseAutomation;
1145
+ type SettingsAppCustomerLogging = {
1146
+ enabled: boolean;
1147
+ };
1148
+ type SettingsAppConversations = {
1149
+ conversationScope: 'OWN' | 'GROUP' | 'ALL';
1150
+ autoClose: boolean;
1151
+ };
1152
+ type SettingsAppIntegrations = {
1153
+ taskIntegration: string | null;
1154
+ conversationTaskKey: string | null;
1155
+ scriptingIntegration: string | null;
1156
+ conversationScriptKey: string | null;
1157
+ conversationScriptCampaignKey: string | null;
1158
+ };
1159
+ type SettingsAppAgentStatus = {
1160
+ selectionEnabled: boolean;
1161
+ };
1162
+ type SettingsTelephonyAgentInbound = {
1163
+ wrapUpBusy: number;
1164
+ wrapUpUnreachable: number;
1165
+ wrapUpDeclined: number;
1166
+ };
1167
+ type SettingsTelephonyAgentOutbound = {
1168
+ wrapUpBusy: number;
1169
+ wrapUpUnreachable: number;
1170
+ wrapUpDeclined: number;
1171
+ };
1172
+ type SettingsTelephonyAgentRecording = {
1173
+ hideRecordingUi: boolean;
1174
+ allowDelete: boolean;
1175
+ tag: string;
1176
+ availableTags: Array<string>;
1177
+ alwaysRecordOutbound: boolean;
1178
+ };
1179
+ type SettingsTelephonyAgentWrapup = {
1180
+ cancelWrapUp: boolean;
1181
+ extendWrapUp: boolean;
1182
+ maxExtension: number;
1183
+ enabledOutbound: boolean;
1184
+ cancelWrapUpOutbound: boolean;
1185
+ extendWrapUpOutbound: boolean;
1186
+ maxExtensionOutbound: number;
1187
+ wrapupTimeOutbound: number;
1188
+ };
1189
+ type SettingsTelephonyPostCall = {
1190
+ applicationId: ObjectUuid;
1191
+ };
1192
+ type SettingsAuditDefault = {
1193
+ enabled: boolean;
1194
+ anonymized: boolean;
1195
+ };
1196
+ type SettingsUiI18N = {
1197
+ locale: string;
1198
+ timezone: string;
1199
+ };
1200
+ type SettingsRetentionPeriods = {
1201
+ defaultPeriod: number;
1202
+ recordingFiles: number;
1203
+ calls: number;
1204
+ };
1205
+ type SimpleMenuApplication = {
1206
+ /**
1207
+ * The unique Identifier (UUID) of the object
1208
+ */
1209
+ id: string;
1210
+ name: string;
1211
+ friendlyName?: string;
1212
+ enabled: boolean;
1213
+ dateCreated: string;
1214
+ lastUpdated: string;
1215
+ /**
1216
+ * A List of Tags describing an Object
1217
+ */
1218
+ tags: Array<Tag>;
1219
+ routings: Array<ApplicationRouting>;
1220
+ settings: SimpleMenuApplicationSettings;
1221
+ module: 'simpleMenu';
1222
+ };
1223
+ type SimpleMenuApplicationSettings = {
1224
+ flowEndApplication?: ResourceReference;
1225
+ prompts?: Array<ApplicationPrompt>;
1226
+ resultVariableName: string;
1227
+ readTimeout: number;
1228
+ maxRetries: number;
1229
+ menuItems: Array<SimpleMenuItem>;
1230
+ };
1231
+ type SimpleMenuApplicationUpdateBody = {
1232
+ name?: string;
1233
+ friendlyName?: string;
1234
+ enabled?: boolean;
1235
+ /**
1236
+ * A List of Tags describing an Object
1237
+ */
1238
+ tags?: Array<Tag>;
1239
+ routings?: Array<ApplicationRouting>;
1240
+ settings?: SimpleMenuApplicationSettings;
1241
+ module: 'simpleMenu';
1242
+ };
1243
+ type SimpleMenuItem = {
1244
+ key: InputReaderTerminationDigit;
1245
+ application: ResourceReference;
1246
+ };
1247
+ type SimpleReportingReportType = 'inbound' | 'outbound' | 'dialer';
1248
+ type SpeechToTextApplication = {
1249
+ /**
1250
+ * The unique Identifier (UUID) of the object
1251
+ */
1252
+ id: string;
1253
+ name: string;
1254
+ friendlyName?: string;
1255
+ enabled: boolean;
1256
+ dateCreated: string;
1257
+ lastUpdated: string;
1258
+ /**
1259
+ * A List of Tags describing an Object
1260
+ */
1261
+ tags: Array<Tag>;
1262
+ routings: Array<ApplicationRouting>;
1263
+ settings: SpeechToTextApplicationSettings;
1264
+ module: 'speechToText';
1265
+ };
1266
+ type SpeechToTextApplicationSettings = {
1267
+ flowEndApplication?: ResourceReference;
1268
+ prompts?: Array<ApplicationPrompt>;
1269
+ model: string;
1270
+ language: string;
1271
+ industryNaicsCode?: string;
1272
+ pattern?: string;
1273
+ numeric?: boolean;
1274
+ enableDtmf?: boolean;
1275
+ template?: 'confirmation';
1276
+ };
1277
+ type SpeechToTextApplicationUpdateBody = {
1278
+ name?: string;
1279
+ friendlyName?: string;
1280
+ enabled?: boolean;
1281
+ /**
1282
+ * A List of Tags describing an Object
1283
+ */
1284
+ tags?: Array<Tag>;
1285
+ routings?: Array<ApplicationRouting>;
1286
+ settings?: SpeechToTextApplicationSettings;
1287
+ module: 'speechToText';
1288
+ };
1289
+ type SwitchNodeApplication = {
1290
+ /**
1291
+ * The unique Identifier (UUID) of the object
1292
+ */
1293
+ id: string;
1294
+ name: string;
1295
+ friendlyName?: string;
1296
+ enabled: boolean;
1297
+ dateCreated: string;
1298
+ lastUpdated: string;
1299
+ /**
1300
+ * A List of Tags describing an Object
1301
+ */
1302
+ tags: Array<Tag>;
1303
+ routings: Array<ApplicationRouting>;
1304
+ settings: SwitchNodeApplicationSettings;
1305
+ module: 'switchNode';
1306
+ };
1307
+ type SwitchNodeApplicationSettings = {
1308
+ flowEndApplication?: ResourceReference;
1309
+ prompts?: Array<ApplicationPrompt>;
1310
+ enableSwitching?: boolean;
1311
+ triggers: Array<SwitchNodeTrigger>;
1312
+ };
1313
+ type SwitchNodeApplicationUpdateBody = {
1314
+ name?: string;
1315
+ friendlyName?: string;
1316
+ enabled?: boolean;
1317
+ /**
1318
+ * A List of Tags describing an Object
1319
+ */
1320
+ tags?: Array<Tag>;
1321
+ routings?: Array<ApplicationRouting>;
1322
+ settings?: SwitchNodeApplicationSettings;
1323
+ module: 'switchNode';
1324
+ };
1325
+ type SwitchNodeTrigger = {
1326
+ trigger?: ApplicationSettingsTrigger;
1327
+ application?: ResourceReference;
1328
+ priority?: number;
1329
+ };
1330
+ /**
1331
+ * A Tag describing an Object
1332
+ */
1333
+ type Tag = string;
1334
+ type TextToSpeechApplication = {
1335
+ /**
1336
+ * The unique Identifier (UUID) of the object
1337
+ */
1338
+ id: string;
1339
+ name: string;
1340
+ friendlyName?: string;
1341
+ enabled: boolean;
1342
+ dateCreated: string;
1343
+ lastUpdated: string;
1344
+ /**
1345
+ * A List of Tags describing an Object
1346
+ */
1347
+ tags: Array<Tag>;
1348
+ routings: Array<ApplicationRouting>;
1349
+ settings: TextToSpeechApplicationSettings;
1350
+ module: 'textToSpeech';
1351
+ };
1352
+ type TextToSpeechApplicationSettings = {
1353
+ flowEndApplication?: ResourceReference;
1354
+ prompts?: Array<ApplicationPrompt>;
1355
+ text: string;
1356
+ language: string;
1357
+ gender: string;
1358
+ voice: string;
1359
+ };
1360
+ type TextToSpeechApplicationUpdateBody = {
1361
+ name?: string;
1362
+ friendlyName?: string;
1363
+ enabled?: boolean;
1364
+ /**
1365
+ * A List of Tags describing an Object
1366
+ */
1367
+ tags?: Array<Tag>;
1368
+ routings?: Array<ApplicationRouting>;
1369
+ settings?: TextToSpeechApplicationSettings;
1370
+ module: 'textToSpeech';
1371
+ };
1372
+ type TransferApplication = {
1373
+ /**
1374
+ * The unique Identifier (UUID) of the object
1375
+ */
1376
+ id: string;
1377
+ name: string;
1378
+ friendlyName?: string;
1379
+ enabled: boolean;
1380
+ dateCreated: string;
1381
+ lastUpdated: string;
1382
+ /**
1383
+ * A List of Tags describing an Object
1384
+ */
1385
+ tags: Array<Tag>;
1386
+ routings: Array<ApplicationRouting>;
1387
+ settings: TransferApplicationSettings;
1388
+ module: 'transfer';
1389
+ };
1390
+ type TransferApplicationSettings = {
1391
+ flowEndApplication?: ResourceReference;
1392
+ prompts?: Array<ApplicationPrompt>;
1393
+ display?: string;
1394
+ timeout?: number;
1395
+ number: string;
1396
+ };
1397
+ type TransferApplicationUpdateBody = {
1398
+ name?: string;
1399
+ friendlyName?: string;
1400
+ enabled?: boolean;
1401
+ /**
1402
+ * A List of Tags describing an Object
1403
+ */
1404
+ tags?: Array<Tag>;
1405
+ routings?: Array<ApplicationRouting>;
1406
+ settings?: TransferApplicationSettings;
1407
+ module: 'transfer';
1408
+ };
1409
+ /**
1410
+ * Unix timestamp
1411
+ */
1412
+ type UnixTimestamp = number;
1413
+ type UpdateAgentStatusRequest = {
1414
+ enabled?: boolean;
1415
+ presence?: UpdateAgentStatusRequestPresence;
1416
+ };
1417
+ type UpdateAgentStatusRequestPresence = {
1418
+ name?: string;
1419
+ };
1420
+ type ListReportingCallsDomainParameter = CallDomain | Array<CallDomain>;
1421
+ type ListReportingCallsFinishReasonParameter = CallFinishReason | Array<CallFinishReason>;
1422
+ type ListReportingCallsIdParameter = ObjectUuid | Array<ObjectUuid>;
1423
+ type ListReportingCallsSourceParameter = CallSource | Array<CallSource>;
1424
+ type ListReportingCallsStateParameter = CallState | Array<CallState>;
1425
+ type ListReportingCallsToParameter = ReportingNumberFilter | Array<ReportingNumberFilter>;
1426
+ type ListReportingCallsTypeParameter = CallType | Array<CallType>;
1427
+ type RestCreateAgentBody = RestCreateAgent;
1428
+ type RestCreateAgentGroupBody = RestCreateAgentGroup;
1429
+ type RestCreateLocalAutomationBody = RestCreateLocalAutomation;
1430
+ type RestUpdateAgentBody = RestUpdateAgent;
1431
+ type RestUpdateAgentGroupBody = RestUpdateAgentGroup;
1432
+ type RestUpdateLocalAutomationBody = RestUpdateLocalAutomation;
1433
+ type ListReportingCallsData = {
1434
+ body?: never;
1435
+ path?: never;
1436
+ query?: {
1437
+ /**
1438
+ * Parameter [page]
1439
+ */
1440
+ page?: number;
1441
+ /**
1442
+ * Parameter [max]
1443
+ */
1444
+ max?: number;
1445
+ /**
1446
+ * Parameter [sessionId]
1447
+ */
1448
+ sessionId?: ObjectUuid;
1449
+ /**
1450
+ * Parameter [conversationId]
1451
+ */
1452
+ conversationId?: ObjectUuid;
1453
+ /**
1454
+ * Parameter [id]
1455
+ */
1456
+ id?: ListReportingCallsIdParameter;
1457
+ /**
1458
+ * Parameter [parentId]
1459
+ */
1460
+ parentId?: ListReportingCallsIdParameter;
1461
+ /**
1462
+ * Parameter [type]
1463
+ */
1464
+ type?: ListReportingCallsTypeParameter;
1465
+ /**
1466
+ * Parameter [from]
1467
+ */
1468
+ from?: ReportingNumberFilter;
1469
+ /**
1470
+ * Parameter [fromNumber]
1471
+ */
1472
+ fromNumber?: ReportingNumberFilter;
1473
+ /**
1474
+ * Parameter [to]
1475
+ */
1476
+ to?: ListReportingCallsToParameter;
1477
+ /**
1478
+ * Parameter [toNumber]
1479
+ */
1480
+ toNumber?: ListReportingCallsToParameter;
1481
+ /**
1482
+ * Parameter [time.start]
1483
+ */
1484
+ 'time.start'?: UnixTimestamp;
1485
+ /**
1486
+ * Parameter [time.end]
1487
+ */
1488
+ 'time.end'?: UnixTimestamp;
1489
+ /**
1490
+ * Parameter [agentId]
1491
+ */
1492
+ agentId?: ListReportingCallsIdParameter;
1493
+ /**
1494
+ * Free Text Query
1495
+ */
1496
+ q?: string;
1497
+ /**
1498
+ * Parameter [state]
1499
+ */
1500
+ state?: ListReportingCallsStateParameter;
1501
+ /**
1502
+ * Parameter [domain]
1503
+ */
1504
+ domain?: ListReportingCallsDomainParameter;
1505
+ /**
1506
+ * Parameter [source]
1507
+ */
1508
+ source?: ListReportingCallsSourceParameter;
1509
+ /**
1510
+ * Parameter [finishReason]
1511
+ */
1512
+ finishReason?: ListReportingCallsFinishReasonParameter;
1513
+ /**
1514
+ * Parameter [anonymous]
1515
+ */
1516
+ anonymous?: boolean;
1517
+ /**
1518
+ * Parameter [filters.sessionId]
1519
+ */
1520
+ 'filters.sessionId'?: ObjectUuid;
1521
+ /**
1522
+ * Parameter [filters.conversationId]
1523
+ */
1524
+ 'filters.conversationId'?: ObjectUuid;
1525
+ /**
1526
+ * Parameter [filters.id]
1527
+ */
1528
+ 'filters.id'?: ListReportingCallsIdParameter;
1529
+ /**
1530
+ * Parameter [filters.parentId]
1531
+ */
1532
+ 'filters.parentId'?: ListReportingCallsIdParameter;
1533
+ /**
1534
+ * Parameter [filters.type]
1535
+ */
1536
+ 'filters.type'?: ListReportingCallsTypeParameter;
1537
+ /**
1538
+ * Parameter [filters.from]
1539
+ */
1540
+ 'filters.from'?: ReportingNumberFilter;
1541
+ /**
1542
+ * Parameter [filters.fromNumber]
1543
+ */
1544
+ 'filters.fromNumber'?: ReportingNumberFilter;
1545
+ /**
1546
+ * Parameter [filters.to]
1547
+ */
1548
+ 'filters.to'?: ListReportingCallsToParameter;
1549
+ /**
1550
+ * Parameter [filters.toNumber]
1551
+ */
1552
+ 'filters.toNumber'?: ListReportingCallsToParameter;
1553
+ /**
1554
+ * Parameter [filters.time.start]
1555
+ */
1556
+ 'filters.time.start'?: UnixTimestamp;
1557
+ /**
1558
+ * Parameter [filters.time.end]
1559
+ */
1560
+ 'filters.time.end'?: UnixTimestamp;
1561
+ /**
1562
+ * Parameter [filters.agentId]
1563
+ */
1564
+ 'filters.agentId'?: ListReportingCallsIdParameter;
1565
+ /**
1566
+ * Free Text Query
1567
+ */
1568
+ 'filters.q'?: string;
1569
+ /**
1570
+ * Parameter [filters.state]
1571
+ */
1572
+ 'filters.state'?: ListReportingCallsStateParameter;
1573
+ /**
1574
+ * Parameter [filters.domain]
1575
+ */
1576
+ 'filters.domain'?: ListReportingCallsDomainParameter;
1577
+ /**
1578
+ * Parameter [filters.source]
1579
+ */
1580
+ 'filters.source'?: ListReportingCallsSourceParameter;
1581
+ /**
1582
+ * Parameter [filters.finishReason]
1583
+ */
1584
+ 'filters.finishReason'?: ListReportingCallsFinishReasonParameter;
1585
+ /**
1586
+ * Parameter [filters.anonymous]
1587
+ */
1588
+ 'filters.anonymous'?: boolean;
1589
+ };
1590
+ url: '/api/v2/calls/reporting';
1591
+ };
1592
+ type ListAllSimpleReportingCallsData = {
1593
+ body?: never;
1594
+ path?: never;
1595
+ query?: {
1596
+ /**
1597
+ * Parameter [page]
1598
+ */
1599
+ page?: number;
1600
+ /**
1601
+ * Parameter [max]
1602
+ */
1603
+ max?: number;
1604
+ /**
1605
+ * Parameter [sessionId]
1606
+ */
1607
+ sessionId?: ObjectUuid;
1608
+ /**
1609
+ * Parameter [conversationId]
1610
+ */
1611
+ conversationId?: ObjectUuid;
1612
+ /**
1613
+ * Parameter [id]
1614
+ */
1615
+ id?: ListReportingCallsIdParameter;
1616
+ /**
1617
+ * Parameter [parentId]
1618
+ */
1619
+ parentId?: ListReportingCallsIdParameter;
1620
+ /**
1621
+ * Parameter [type]
1622
+ */
1623
+ type?: ListReportingCallsTypeParameter;
1624
+ /**
1625
+ * Parameter [from]
1626
+ */
1627
+ from?: ReportingNumberFilter;
1628
+ /**
1629
+ * Parameter [fromNumber]
1630
+ */
1631
+ fromNumber?: ReportingNumberFilter;
1632
+ /**
1633
+ * Parameter [to]
1634
+ */
1635
+ to?: ListReportingCallsToParameter;
1636
+ /**
1637
+ * Parameter [toNumber]
1638
+ */
1639
+ toNumber?: ListReportingCallsToParameter;
1640
+ /**
1641
+ * Parameter [time.start]
1642
+ */
1643
+ 'time.start'?: UnixTimestamp;
1644
+ /**
1645
+ * Parameter [time.end]
1646
+ */
1647
+ 'time.end'?: UnixTimestamp;
1648
+ /**
1649
+ * Parameter [agentId]
1650
+ */
1651
+ agentId?: ListReportingCallsIdParameter;
1652
+ /**
1653
+ * Filter by Queue Name
1654
+ */
1655
+ queueName?: string;
1656
+ /**
1657
+ * Filter by Agent Name
1658
+ */
1659
+ agentName?: string;
1660
+ /**
1661
+ * Parameter [bridged]
1662
+ */
1663
+ bridged?: boolean;
1664
+ /**
1665
+ * Parameter [duration.start]
1666
+ */
1667
+ 'duration.start'?: number;
1668
+ /**
1669
+ * Parameter [duration.end]
1670
+ */
1671
+ 'duration.end'?: number;
1672
+ /**
1673
+ * Parameter [waitTime.start]
1674
+ */
1675
+ 'waitTime.start'?: number;
1676
+ /**
1677
+ * Parameter [waitTime.end]
1678
+ */
1679
+ 'waitTime.end'?: number;
1680
+ /**
1681
+ * Parameter [queueWaitTime.start]
1682
+ */
1683
+ 'queueWaitTime.start'?: number;
1684
+ /**
1685
+ * Parameter [queueWaitTime.end]
1686
+ */
1687
+ 'queueWaitTime.end'?: number;
1688
+ /**
1689
+ * Parameter [bridgeTime.start]
1690
+ */
1691
+ 'bridgeTime.start'?: number;
1692
+ /**
1693
+ * Parameter [bridgeTime.end]
1694
+ */
1695
+ 'bridgeTime.end'?: number;
1696
+ /**
1697
+ * Parameter [talkTime.start]
1698
+ */
1699
+ 'talkTime.start'?: number;
1700
+ /**
1701
+ * Parameter [talkTime.end]
1702
+ */
1703
+ 'talkTime.end'?: number;
1704
+ /**
1705
+ * Parameter [holdTime.start]
1706
+ */
1707
+ 'holdTime.start'?: number;
1708
+ /**
1709
+ * Parameter [holdTime.end]
1710
+ */
1711
+ 'holdTime.end'?: number;
1712
+ /**
1713
+ * Parameter [wrapupTime.start]
1714
+ */
1715
+ 'wrapupTime.start'?: number;
1716
+ /**
1717
+ * Parameter [wrapupTime.end]
1718
+ */
1719
+ 'wrapupTime.end'?: number;
1720
+ /**
1721
+ * Parameter [handleTime.start]
1722
+ */
1723
+ 'handleTime.start'?: number;
1724
+ /**
1725
+ * Parameter [handleTime.end]
1726
+ */
1727
+ 'handleTime.end'?: number;
1728
+ };
1729
+ url: '/api/v2/calls/reporting/simple';
79
1730
  };
80
1731
 
81
1732
  interface ListUsersQuery {
@@ -106,6 +1757,256 @@ declare class UsersResource {
106
1757
  delete(emails: string[]): Promise<void>;
107
1758
  }
108
1759
 
1760
+ interface ListAgentsQuery {
1761
+ /** Free-text search across name, group name, number, email, sourceId and integration label. */
1762
+ q?: string;
1763
+ /** Only enabled (`true`) or only disabled (`false`) agents. */
1764
+ enabled?: boolean;
1765
+ /** Filter by agent name. */
1766
+ name?: string;
1767
+ /** Filter by the agent's number. */
1768
+ number?: string;
1769
+ /** Filter by integration source id. */
1770
+ sourceId?: string;
1771
+ /** Filter by line status. */
1772
+ state?: AgentLineStatus;
1773
+ /** Filter by source integration. */
1774
+ source?: string;
1775
+ /** Restrict to agents in these group id(s). */
1776
+ groupIds?: string | string[];
1777
+ /** Restrict to agents in these group name(s). */
1778
+ groups?: string | string[];
1779
+ /** Filter by tag(s). */
1780
+ tags?: string | string[];
1781
+ /** Page size (the API's `max`); defaults to the server default. */
1782
+ pageSize?: number;
1783
+ }
1784
+ /** Agent management — `/api/v2/agents`. */
1785
+ declare class AgentsResource {
1786
+ private readonly client;
1787
+ /** Agent groups — `/api/v2/agents/groups`. */
1788
+ readonly groups: AgentGroupsResource;
1789
+ constructor(client: Client);
1790
+ /**
1791
+ * List agents, auto-paginating across pages.
1792
+ *
1793
+ * ```ts
1794
+ * for await (const agent of mgr.agents.list({ enabled: true })) console.log(agent.name);
1795
+ * ```
1796
+ */
1797
+ list(query?: ListAgentsQuery): AsyncGenerator<Agent>;
1798
+ /** Collect every agent into an array (convenience over {@link list}). */
1799
+ listAll(query?: ListAgentsQuery): Promise<Agent[]>;
1800
+ /** Create an agent. */
1801
+ create(body: RestCreateAgentBody): Promise<AgentItemResponse>;
1802
+ /** Get an agent by id. */
1803
+ get(id: string): Promise<AgentItemResponse>;
1804
+ /** Update an agent. */
1805
+ update(id: string, body: RestUpdateAgentBody): Promise<AgentItemResponse>;
1806
+ /** Delete an agent by id. */
1807
+ delete(id: string): Promise<void>;
1808
+ /** Update an agent's status (enabled flag and/or presence). */
1809
+ updateStatus(id: string, status: UpdateAgentStatusRequest): Promise<AgentStatus>;
1810
+ }
1811
+ /** Agent groups — `/api/v2/agents/groups`. */
1812
+ declare class AgentGroupsResource {
1813
+ private readonly client;
1814
+ constructor(client: Client);
1815
+ /** List agent groups, auto-paginating across pages. */
1816
+ list(pageSize?: number): AsyncGenerator<AgentGroup>;
1817
+ /** Collect every agent group into an array. */
1818
+ listAll(pageSize?: number): Promise<AgentGroup[]>;
1819
+ /** Create an agent group. */
1820
+ create(body: RestCreateAgentGroupBody): Promise<AgentGroupItemResponse>;
1821
+ /** Get an agent group by id. */
1822
+ get(id: string): Promise<AgentGroupItemResponse>;
1823
+ /** Update an agent group. */
1824
+ update(id: string, body: RestUpdateAgentGroupBody): Promise<AgentGroupItemResponse>;
1825
+ /** Delete an agent group by id. */
1826
+ delete(id: string): Promise<void>;
1827
+ /** Add an agent (by id) to a group. */
1828
+ addAgent(groupId: string, agentId: string): Promise<AgentGroupAdditionResponse>;
1829
+ }
1830
+
1831
+ /**
1832
+ * Filters for the detailed call report (`calls.reporting.list`). This is the generated query
1833
+ * surface (rich filter set, including the dotted `time.start` / `filters.*` variants) minus the
1834
+ * `page` / `max` paging controls, which the auto-paginator manages.
1835
+ */
1836
+ type ReportingCallsQuery = Omit<NonNullable<ListReportingCallsData['query']>, 'page' | 'max'> & {
1837
+ /** Page size (the API's `max`); defaults to the server default. */
1838
+ pageSize?: number;
1839
+ };
1840
+ /** Filters for the simple call reports (`calls.reporting.simple` / `simpleByType`). */
1841
+ type SimpleReportingCallsQuery = Omit<NonNullable<ListAllSimpleReportingCallsData['query']>, 'page' | 'max'> & {
1842
+ /** Page size (the API's `max`); defaults to the server default. */
1843
+ pageSize?: number;
1844
+ };
1845
+ /** Call reporting and (future) call control — `/api/v2/calls`. */
1846
+ declare class CallsResource {
1847
+ /** Call reporting — `/api/v2/calls/reporting`. */
1848
+ readonly reporting: ReportingResource;
1849
+ constructor(client: Client);
1850
+ }
1851
+ /** Call reporting — `/api/v2/calls/reporting`. */
1852
+ declare class ReportingResource {
1853
+ private readonly client;
1854
+ constructor(client: Client);
1855
+ /**
1856
+ * The detailed call report, auto-paginating across pages.
1857
+ *
1858
+ * ```ts
1859
+ * for await (const call of mgr.calls.reporting.list({ "time.start": 1700000000 })) { … }
1860
+ * ```
1861
+ */
1862
+ list(query?: ReportingCallsQuery): AsyncGenerator<Call>;
1863
+ /** Collect every call from the detailed report into an array. */
1864
+ listAll(query?: ReportingCallsQuery): Promise<Call[]>;
1865
+ /**
1866
+ * The simple call report across all report types (`/api/v2/calls/reporting/simple`),
1867
+ * auto-paginating across pages.
1868
+ */
1869
+ simple(query?: SimpleReportingCallsQuery): AsyncGenerator<ReportingCall>;
1870
+ /** Collect every call from the simple report into an array. */
1871
+ simpleAll(query?: SimpleReportingCallsQuery): Promise<ReportingCall[]>;
1872
+ /**
1873
+ * The simple call report for a single report type
1874
+ * (`/api/v2/calls/reporting/simple/{reportType}`), auto-paginating across pages.
1875
+ */
1876
+ simpleByType(reportType: SimpleReportingReportType, query?: SimpleReportingCallsQuery): AsyncGenerator<ReportingCall>;
1877
+ /** Collect every call from a single report type into an array. */
1878
+ simpleAllByType(reportType: SimpleReportingReportType, query?: SimpleReportingCallsQuery): Promise<ReportingCall[]>;
1879
+ }
1880
+
1881
+ /** Metrics — `/api/v2/metrics`. */
1882
+ declare class MetricsResource {
1883
+ private readonly client;
1884
+ constructor(client: Client);
1885
+ /** List the available metric ids. */
1886
+ listIds(): Promise<MetricIdItemsResponse>;
1887
+ /** Get a metric's current value by id. */
1888
+ get(id: string): Promise<MetricResponse>;
1889
+ /** Describe a metric's definition by id. */
1890
+ describe(id: string): Promise<MetricDefinitionItemResponse>;
1891
+ /** Trigger a metrics push. */
1892
+ push(): Promise<MetricRequestPushResponse>;
1893
+ /** Reset the metric counters. */
1894
+ reset(): Promise<MetricResetCountersResponse>;
1895
+ }
1896
+
1897
+ interface ListApplicationsQuery {
1898
+ /** Page size (the API's `max`); defaults to the server default. */
1899
+ pageSize?: number;
1900
+ }
1901
+ /** Application (IVR) management — `/api/v2/applications`. */
1902
+ declare class ApplicationsResource {
1903
+ private readonly client;
1904
+ /** Per-application actions (local automations) — `/api/v2/applications/{applicationId}/actions`. */
1905
+ readonly actions: AppActionsResource;
1906
+ constructor(client: Client);
1907
+ /**
1908
+ * List applications, auto-paginating across pages.
1909
+ *
1910
+ * ```ts
1911
+ * for await (const app of mgr.applications.list()) console.log(app.id, app.name);
1912
+ * ```
1913
+ */
1914
+ list(query?: ListApplicationsQuery): AsyncGenerator<Application>;
1915
+ /** Collect every application into an array (convenience over {@link list}). */
1916
+ listAll(query?: ListApplicationsQuery): Promise<Application[]>;
1917
+ /** Create an application. */
1918
+ create(body: ApplicationCreateBody): Promise<ApplicationItemResponse>;
1919
+ /** Get an application by id. */
1920
+ get(id: string): Promise<ApplicationItemResponse>;
1921
+ /** Update an application. */
1922
+ update(id: string, body: ApplicationUpdateBody): Promise<ApplicationItemResponse>;
1923
+ /** Delete an application by id. */
1924
+ delete(id: string): Promise<void>;
1925
+ /** Bulk-delete applications by id. */
1926
+ deleteMany(ids: string[]): Promise<DefaultV2MessageResponse>;
1927
+ /** List the available IVR modules (the building blocks of applications). */
1928
+ listModules(): Promise<ListModulesResponse>;
1929
+ /** Dispatch the local automations configured at a position in an application. */
1930
+ dispatch(id: string, position: string, async: boolean, body?: LocalAutomationDispatch): Promise<DispatchLocalAutomationsResponse>;
1931
+ }
1932
+ /** Per-application actions (local automations) — `/api/v2/applications/{applicationId}/actions`. */
1933
+ declare class AppActionsResource {
1934
+ private readonly client;
1935
+ constructor(client: Client);
1936
+ /** List an application's actions, auto-paginating across pages. */
1937
+ list(applicationId: string, pageSize?: number): AsyncGenerator<LocalAutomation>;
1938
+ /** Collect every action of an application into an array. */
1939
+ listAll(applicationId: string, pageSize?: number): Promise<LocalAutomation[]>;
1940
+ /** Create an action in an application. */
1941
+ create(applicationId: string, body: RestCreateLocalAutomationBody): Promise<LocalAutomationItemResponse>;
1942
+ /** Get one of an application's actions by id. */
1943
+ get(applicationId: string, id: string): Promise<LocalAutomationItemResponse>;
1944
+ /** Update one of an application's actions. */
1945
+ update(applicationId: string, id: string, body: RestUpdateLocalAutomationBody): Promise<LocalAutomationItemResponse>;
1946
+ /** Delete one of an application's actions. */
1947
+ delete(applicationId: string, id: string): Promise<void>;
1948
+ }
1949
+
1950
+ type Result = PromiseLike<{
1951
+ data?: unknown;
1952
+ error?: unknown;
1953
+ response: Response;
1954
+ }>;
1955
+ type GetOp = (options: {
1956
+ client: Client;
1957
+ }) => Result;
1958
+ type UpdateOp = (options: {
1959
+ client: Client;
1960
+ body: any;
1961
+ }) => Result;
1962
+ /**
1963
+ * A single settings group. Read and write its `data` payload directly — the `{ scope, key }`
1964
+ * envelope the API wraps it in is handled for you.
1965
+ */
1966
+ declare class SettingAccessor<TData> {
1967
+ private readonly client;
1968
+ private readonly scope;
1969
+ private readonly key;
1970
+ private readonly getOp;
1971
+ private readonly updateOp;
1972
+ constructor(client: Client, scope: string, key: string, getOp: GetOp, updateOp: UpdateOp);
1973
+ /** Read the current value of this settings group. */
1974
+ get(): Promise<TData>;
1975
+ /** Update this settings group; returns the new value. */
1976
+ update(data: TData): Promise<TData>;
1977
+ }
1978
+ /** Global settings — `/api/v2/settings`, grouped by scope. */
1979
+ declare class SettingsResource {
1980
+ /** `app` settings. */
1981
+ readonly app: {
1982
+ customerLogging: SettingAccessor<SettingsAppCustomerLogging>;
1983
+ conversations: SettingAccessor<SettingsAppConversations>;
1984
+ integrations: SettingAccessor<SettingsAppIntegrations>;
1985
+ agentStatus: SettingAccessor<SettingsAppAgentStatus>;
1986
+ };
1987
+ /** `telephony` settings. */
1988
+ readonly telephony: {
1989
+ agentInbound: SettingAccessor<SettingsTelephonyAgentInbound>;
1990
+ agentOutbound: SettingAccessor<SettingsTelephonyAgentOutbound>;
1991
+ agentRecording: SettingAccessor<SettingsTelephonyAgentRecording>;
1992
+ agentWrapup: SettingAccessor<SettingsTelephonyAgentWrapup>;
1993
+ postCall: SettingAccessor<SettingsTelephonyPostCall>;
1994
+ };
1995
+ /** `audit` settings. */
1996
+ readonly audit: {
1997
+ default: SettingAccessor<SettingsAuditDefault>;
1998
+ };
1999
+ /** `ui` settings. */
2000
+ readonly ui: {
2001
+ i18n: SettingAccessor<SettingsUiI18N>;
2002
+ };
2003
+ /** `retention` settings. */
2004
+ readonly retention: {
2005
+ periods: SettingAccessor<SettingsRetentionPeriods>;
2006
+ };
2007
+ constructor(client: Client);
2008
+ }
2009
+
109
2010
  /**
110
2011
  * a unique identifier
111
2012
  */
@@ -372,6 +2273,16 @@ declare class ManagerClient {
372
2273
  readonly client: Client;
373
2274
  /** User management — `/api/v2/users`. */
374
2275
  readonly users: UsersResource;
2276
+ /** Agent management — `/api/v2/agents`. */
2277
+ readonly agents: AgentsResource;
2278
+ /** Call reporting — `/api/v2/calls`. */
2279
+ readonly calls: CallsResource;
2280
+ /** Metrics — `/api/v2/metrics`. */
2281
+ readonly metrics: MetricsResource;
2282
+ /** Application (IVR) management — `/api/v2/applications`. */
2283
+ readonly applications: ApplicationsResource;
2284
+ /** Global settings — `/api/v2/settings`. */
2285
+ readonly settings: SettingsResource;
375
2286
  /** Task automations — `/api/v3/tasks`. */
376
2287
  readonly tasks: TasksResource;
377
2288
  private constructor();
@@ -392,4 +2303,4 @@ declare class ManagerApiError extends Error {
392
2303
  static from(response: Response, body: unknown): ManagerApiError;
393
2304
  }
394
2305
 
395
- export { type AccountRole, type Auth, type CreateManagedUserRequest, type Environment, type InterruptionTargetStates, type ListTasksQuery, type ListUsersQuery, type ManagedUser, type ManagedUserItemResponse, ManagerApiError, ManagerClient, type ManagerClientOptions, type SubmitTaskBody, type SubmitTaskScheduleBody, type Task, type TaskSchedule, TaskSchedulesResource, type TaskTemplateOverrides, TasksResource, type TokenResponse, type UpdateTaskBody, UsersResource, passwordGrant };
2306
+ export { type AccountRole, type Agent, type AgentGroup, type AgentGroupItemResponse, AgentGroupsResource, type AgentItemResponse, type AgentLineStatus, type AgentStatus, AgentsResource, AppActionsResource, type Application, type ApplicationCreateBody, type ApplicationItemResponse, type ApplicationUpdateBody, ApplicationsResource, type Auth, type Call, CallsResource, type CreateManagedUserRequest, type Environment, type InterruptionTargetStates, type IvrModule, type ListAgentsQuery, type ListApplicationsQuery, type ListTasksQuery, type ListUsersQuery, type LocalAutomation, type LocalAutomationItemResponse, type ManagedUser, type ManagedUserItemResponse, ManagerApiError, ManagerClient, type ManagerClientOptions, type MetricDefinitionItemResponse, type MetricIdItemsResponse, type MetricResponse, MetricsResource, type ReportingCall, type ReportingCallsQuery, ReportingResource, type RestCreateAgentBody, type RestCreateAgentGroupBody, type RestCreateLocalAutomationBody, type RestUpdateAgentBody, type RestUpdateAgentGroupBody, type RestUpdateLocalAutomationBody, SettingAccessor, type SettingsAppAgentStatus, type SettingsAppConversations, type SettingsAppCustomerLogging, type SettingsAppIntegrations, type SettingsAuditDefault, SettingsResource, type SettingsRetentionPeriods, type SettingsTelephonyAgentInbound, type SettingsTelephonyAgentOutbound, type SettingsTelephonyAgentRecording, type SettingsTelephonyAgentWrapup, type SettingsTelephonyPostCall, type SettingsUiI18N, type SimpleReportingCallsQuery, type SimpleReportingReportType, type SubmitTaskBody, type SubmitTaskScheduleBody, type Task, type TaskSchedule, TaskSchedulesResource, type TaskTemplateOverrides, TasksResource, type TokenResponse, type UpdateAgentStatusRequest, type UpdateTaskBody, UsersResource, passwordGrant };