@gtmi/ramp-agent-client 0.0.1

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.
@@ -0,0 +1,795 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+
3
+ export type ClientOptions = {
4
+ baseUrl: `${string}://${string}` | (string & {});
5
+ };
6
+
7
+ export type GetCountryConfigsData = {
8
+ body?: never;
9
+ path?: never;
10
+ query?: never;
11
+ url: '/country-configs';
12
+ };
13
+
14
+ export type GetCountryConfigsErrors = {
15
+ /**
16
+ * Unauthorized — requires Bearer token
17
+ */
18
+ 401: unknown;
19
+ /**
20
+ * Internal server error
21
+ */
22
+ 500: unknown;
23
+ };
24
+
25
+ export type GetCountryConfigsResponses = {
26
+ /**
27
+ * Success
28
+ */
29
+ 200: unknown;
30
+ };
31
+
32
+ export type GetRecentlyActiveNumbersData = {
33
+ body?: never;
34
+ path?: never;
35
+ query?: never;
36
+ url: '/recently-active-numbers';
37
+ };
38
+
39
+ export type GetRecentlyActiveNumbersErrors = {
40
+ /**
41
+ * Unauthorized — requires Bearer token
42
+ */
43
+ 401: unknown;
44
+ /**
45
+ * Internal server error
46
+ */
47
+ 500: unknown;
48
+ };
49
+
50
+ export type GetRecentlyActiveNumbersResponses = {
51
+ /**
52
+ * Success
53
+ */
54
+ 200: unknown;
55
+ };
56
+
57
+ export type GetStatsData = {
58
+ body?: never;
59
+ path?: never;
60
+ query?: never;
61
+ url: '/stats';
62
+ };
63
+
64
+ export type GetStatsErrors = {
65
+ /**
66
+ * Unauthorized — requires Bearer token
67
+ */
68
+ 401: unknown;
69
+ /**
70
+ * Internal server error
71
+ */
72
+ 500: unknown;
73
+ };
74
+
75
+ export type GetStatsResponses = {
76
+ /**
77
+ * Success
78
+ */
79
+ 200: unknown;
80
+ };
81
+
82
+ export type GetPhoneLogsByPhoneNumberData = {
83
+ body?: never;
84
+ path: {
85
+ phoneNumber: string;
86
+ };
87
+ query?: never;
88
+ url: '/phone-logs/{phoneNumber}';
89
+ };
90
+
91
+ export type GetPhoneLogsByPhoneNumberErrors = {
92
+ /**
93
+ * Unauthorized — requires Bearer token
94
+ */
95
+ 401: unknown;
96
+ /**
97
+ * Internal server error
98
+ */
99
+ 500: unknown;
100
+ };
101
+
102
+ export type GetPhoneLogsByPhoneNumberResponses = {
103
+ /**
104
+ * Success
105
+ */
106
+ 200: unknown;
107
+ };
108
+
109
+ export type PostOutboundCallData = {
110
+ body: {
111
+ /**
112
+ * The phone number to call (recipient). Required.
113
+ */
114
+ to: string;
115
+ /**
116
+ * The Twilio phone number to call from. Required.
117
+ */
118
+ from: string;
119
+ };
120
+ path?: never;
121
+ query?: never;
122
+ url: '/outbound-call';
123
+ };
124
+
125
+ export type PostOutboundCallErrors = {
126
+ /**
127
+ * Unauthorized — requires Bearer token
128
+ */
129
+ 401: unknown;
130
+ /**
131
+ * Internal server error
132
+ */
133
+ 500: unknown;
134
+ };
135
+
136
+ export type PostOutboundCallResponses = {
137
+ /**
138
+ * Success
139
+ */
140
+ 200: unknown;
141
+ };
142
+
143
+ export type GetOutboundCallByCallSidData = {
144
+ body?: never;
145
+ path: {
146
+ callSid: string;
147
+ };
148
+ query?: never;
149
+ url: '/outbound-call/{callSid}';
150
+ };
151
+
152
+ export type GetOutboundCallByCallSidErrors = {
153
+ /**
154
+ * Unauthorized — requires Bearer token
155
+ */
156
+ 401: unknown;
157
+ /**
158
+ * Internal server error
159
+ */
160
+ 500: unknown;
161
+ };
162
+
163
+ export type GetOutboundCallByCallSidResponses = {
164
+ /**
165
+ * Success
166
+ */
167
+ 200: unknown;
168
+ };
169
+
170
+ export type PostOutboundCommunicationTextData = {
171
+ body: {
172
+ [key: string]: unknown;
173
+ };
174
+ path?: never;
175
+ query?: never;
176
+ url: '/outbound-communication-text';
177
+ };
178
+
179
+ export type PostOutboundCommunicationTextErrors = {
180
+ /**
181
+ * Unauthorized — requires Bearer token
182
+ */
183
+ 401: unknown;
184
+ /**
185
+ * Internal server error
186
+ */
187
+ 500: unknown;
188
+ };
189
+
190
+ export type PostOutboundCommunicationTextResponses = {
191
+ /**
192
+ * Success
193
+ */
194
+ 200: unknown;
195
+ };
196
+
197
+ export type PostExportLogsData = {
198
+ body?: never;
199
+ path?: never;
200
+ query?: never;
201
+ url: '/export-logs';
202
+ };
203
+
204
+ export type PostExportLogsErrors = {
205
+ /**
206
+ * Unauthorized — requires Bearer token
207
+ */
208
+ 401: unknown;
209
+ /**
210
+ * Internal server error
211
+ */
212
+ 500: unknown;
213
+ };
214
+
215
+ export type PostExportLogsResponses = {
216
+ /**
217
+ * Success
218
+ */
219
+ 200: unknown;
220
+ };
221
+
222
+ export type DeleteLiveNumbersData = {
223
+ body?: never;
224
+ path?: never;
225
+ query?: never;
226
+ url: '/live-numbers';
227
+ };
228
+
229
+ export type DeleteLiveNumbersErrors = {
230
+ /**
231
+ * Unauthorized — requires Bearer token
232
+ */
233
+ 401: unknown;
234
+ /**
235
+ * Internal server error
236
+ */
237
+ 500: unknown;
238
+ };
239
+
240
+ export type DeleteLiveNumbersResponses = {
241
+ /**
242
+ * Success
243
+ */
244
+ 200: unknown;
245
+ };
246
+
247
+ export type GetLiveNumbersData = {
248
+ body?: never;
249
+ path?: never;
250
+ query?: never;
251
+ url: '/live-numbers';
252
+ };
253
+
254
+ export type GetLiveNumbersErrors = {
255
+ /**
256
+ * Unauthorized — requires Bearer token
257
+ */
258
+ 401: unknown;
259
+ /**
260
+ * Internal server error
261
+ */
262
+ 500: unknown;
263
+ };
264
+
265
+ export type GetLiveNumbersResponses = {
266
+ /**
267
+ * Success
268
+ */
269
+ 200: unknown;
270
+ };
271
+
272
+ export type DeleteLiveNumbersByPhoneNumberData = {
273
+ body?: never;
274
+ path: {
275
+ phoneNumber: string;
276
+ };
277
+ query?: never;
278
+ url: '/live-numbers/{phoneNumber}';
279
+ };
280
+
281
+ export type DeleteLiveNumbersByPhoneNumberErrors = {
282
+ /**
283
+ * Internal server error
284
+ */
285
+ 500: unknown;
286
+ };
287
+
288
+ export type DeleteLiveNumbersByPhoneNumberResponses = {
289
+ /**
290
+ * Success
291
+ */
292
+ 200: unknown;
293
+ };
294
+
295
+ export type DeleteKillConversationByPhoneNumberData = {
296
+ body?: never;
297
+ path: {
298
+ phoneNumber: string;
299
+ };
300
+ query?: never;
301
+ url: '/kill-conversation/{phoneNumber}';
302
+ };
303
+
304
+ export type DeleteKillConversationByPhoneNumberErrors = {
305
+ /**
306
+ * Unauthorized — requires Bearer token
307
+ */
308
+ 401: unknown;
309
+ /**
310
+ * Internal server error
311
+ */
312
+ 500: unknown;
313
+ };
314
+
315
+ export type DeleteKillConversationByPhoneNumberResponses = {
316
+ /**
317
+ * Success
318
+ */
319
+ 200: unknown;
320
+ };
321
+
322
+ export type PostSendEmailData = {
323
+ body: {
324
+ /**
325
+ * Recipient email address. Required.
326
+ */
327
+ to: string;
328
+ /**
329
+ * Email subject. Required.
330
+ */
331
+ subject: string;
332
+ /**
333
+ * Plain text body. Required.
334
+ */
335
+ text: string;
336
+ };
337
+ path?: never;
338
+ query?: never;
339
+ url: '/send-email';
340
+ };
341
+
342
+ export type PostSendEmailErrors = {
343
+ /**
344
+ * Unauthorized — requires Bearer token
345
+ */
346
+ 401: unknown;
347
+ /**
348
+ * Internal server error
349
+ */
350
+ 500: unknown;
351
+ };
352
+
353
+ export type PostSendEmailResponses = {
354
+ /**
355
+ * Success
356
+ */
357
+ 200: unknown;
358
+ };
359
+
360
+ export type PostAddMessageData = {
361
+ body: {
362
+ /**
363
+ * The customer's phone number (PrefixedAddress). Required.
364
+ */
365
+ to: string;
366
+ /**
367
+ * The message content to inject. Required.
368
+ */
369
+ content: string;
370
+ };
371
+ path?: never;
372
+ query?: never;
373
+ url: '/add-message';
374
+ };
375
+
376
+ export type PostAddMessageErrors = {
377
+ /**
378
+ * Unauthorized — requires Bearer token
379
+ */
380
+ 401: unknown;
381
+ /**
382
+ * Internal server error
383
+ */
384
+ 500: unknown;
385
+ };
386
+
387
+ export type PostAddMessageResponses = {
388
+ /**
389
+ * Success
390
+ */
391
+ 200: unknown;
392
+ };
393
+
394
+ export type PostActiveConversationsAgentClaimData = {
395
+ body: {
396
+ [key: string]: unknown;
397
+ };
398
+ path?: never;
399
+ query?: never;
400
+ url: '/active-conversations/agent/claim';
401
+ };
402
+
403
+ export type PostActiveConversationsAgentClaimErrors = {
404
+ /**
405
+ * Unauthorized — requires Bearer token
406
+ */
407
+ 401: unknown;
408
+ /**
409
+ * Internal server error
410
+ */
411
+ 500: unknown;
412
+ };
413
+
414
+ export type PostActiveConversationsAgentClaimResponses = {
415
+ /**
416
+ * Success
417
+ */
418
+ 200: unknown;
419
+ };
420
+
421
+ export type GetActiveConversationsAgentByAgentNumberData = {
422
+ body?: never;
423
+ path: {
424
+ agentNumber: string;
425
+ };
426
+ query?: never;
427
+ url: '/active-conversations/agent/{agentNumber}';
428
+ };
429
+
430
+ export type GetActiveConversationsAgentByAgentNumberErrors = {
431
+ /**
432
+ * Unauthorized — requires Bearer token
433
+ */
434
+ 401: unknown;
435
+ /**
436
+ * Internal server error
437
+ */
438
+ 500: unknown;
439
+ };
440
+
441
+ export type GetActiveConversationsAgentByAgentNumberResponses = {
442
+ /**
443
+ * Success
444
+ */
445
+ 200: unknown;
446
+ };
447
+
448
+ export type GetActiveConversationsByCustomerNumberData = {
449
+ body?: never;
450
+ path: {
451
+ customerNumber: string;
452
+ };
453
+ query?: never;
454
+ url: '/active-conversations/{customerNumber}';
455
+ };
456
+
457
+ export type GetActiveConversationsByCustomerNumberErrors = {
458
+ /**
459
+ * Unauthorized — requires Bearer token
460
+ */
461
+ 401: unknown;
462
+ /**
463
+ * Internal server error
464
+ */
465
+ 500: unknown;
466
+ };
467
+
468
+ export type GetActiveConversationsByCustomerNumberResponses = {
469
+ /**
470
+ * Success
471
+ */
472
+ 200: unknown;
473
+ };
474
+
475
+ export type GetHealthData = {
476
+ body?: never;
477
+ path?: never;
478
+ query?: never;
479
+ url: '/health';
480
+ };
481
+
482
+ export type GetHealthErrors = {
483
+ /**
484
+ * Internal server error
485
+ */
486
+ 500: unknown;
487
+ };
488
+
489
+ export type GetHealthResponses = {
490
+ /**
491
+ * Success
492
+ */
493
+ 200: unknown;
494
+ };
495
+
496
+ export type PostCallData = {
497
+ body: {
498
+ [key: string]: unknown;
499
+ };
500
+ path?: never;
501
+ query?: never;
502
+ url: '/call';
503
+ };
504
+
505
+ export type PostCallErrors = {
506
+ /**
507
+ * Internal server error
508
+ */
509
+ 500: unknown;
510
+ };
511
+
512
+ export type PostCallResponses = {
513
+ /**
514
+ * Success
515
+ */
516
+ 200: unknown;
517
+ };
518
+
519
+ export type PostLiveAgentData = {
520
+ body: {
521
+ /**
522
+ * Caller phone number
523
+ */
524
+ From: string;
525
+ /**
526
+ * Called phone number (Twilio number)
527
+ */
528
+ To: string;
529
+ /**
530
+ * Call direction ('inbound' or 'outbound-api')
531
+ */
532
+ Direction: string;
533
+ };
534
+ path?: never;
535
+ query?: never;
536
+ url: '/live-agent';
537
+ };
538
+
539
+ export type PostLiveAgentErrors = {
540
+ /**
541
+ * Internal server error
542
+ */
543
+ 500: unknown;
544
+ };
545
+
546
+ export type PostLiveAgentResponses = {
547
+ /**
548
+ * Success
549
+ */
550
+ 200: unknown;
551
+ };
552
+
553
+ export type PostRedirectToLiveAgentData = {
554
+ body: {
555
+ [key: string]: unknown;
556
+ };
557
+ path?: never;
558
+ query?: never;
559
+ url: '/redirect-to-live-agent';
560
+ };
561
+
562
+ export type PostRedirectToLiveAgentErrors = {
563
+ /**
564
+ * Internal server error
565
+ */
566
+ 500: unknown;
567
+ };
568
+
569
+ export type PostRedirectToLiveAgentResponses = {
570
+ /**
571
+ * Success
572
+ */
573
+ 200: unknown;
574
+ };
575
+
576
+ export type GetStressTestData = {
577
+ body?: never;
578
+ path?: never;
579
+ query?: {
580
+ From?: string;
581
+ To?: string;
582
+ CallSid?: string;
583
+ SpeechResult?: string;
584
+ Confidence?: string;
585
+ CallStatus?: string;
586
+ };
587
+ url: '/stress-test';
588
+ };
589
+
590
+ export type GetStressTestErrors = {
591
+ /**
592
+ * Internal server error
593
+ */
594
+ 500: unknown;
595
+ };
596
+
597
+ export type GetStressTestResponses = {
598
+ /**
599
+ * Success
600
+ */
601
+ 200: unknown;
602
+ };
603
+
604
+ export type PostStressTestSmsData = {
605
+ body: {
606
+ [key: string]: unknown;
607
+ };
608
+ path?: never;
609
+ query?: {
610
+ From?: string;
611
+ To?: string;
612
+ CallSid?: string;
613
+ SpeechResult?: string;
614
+ Confidence?: string;
615
+ CallStatus?: string;
616
+ };
617
+ url: '/stress-test-sms';
618
+ };
619
+
620
+ export type PostStressTestSmsErrors = {
621
+ /**
622
+ * Internal server error
623
+ */
624
+ 500: unknown;
625
+ };
626
+
627
+ export type PostStressTestSmsResponses = {
628
+ /**
629
+ * Success
630
+ */
631
+ 200: unknown;
632
+ };
633
+
634
+ export type PostWebchatSendData = {
635
+ body: {
636
+ [key: string]: unknown;
637
+ };
638
+ path?: never;
639
+ query?: never;
640
+ url: '/webchat-send';
641
+ };
642
+
643
+ export type PostWebchatSendErrors = {
644
+ /**
645
+ * Internal server error
646
+ */
647
+ 500: unknown;
648
+ };
649
+
650
+ export type PostWebchatSendResponses = {
651
+ /**
652
+ * Success
653
+ */
654
+ 200: unknown;
655
+ };
656
+
657
+ export type PostCintelOperatorsData = {
658
+ body: {
659
+ [key: string]: unknown;
660
+ };
661
+ path?: never;
662
+ query?: never;
663
+ url: '/cintel-operators';
664
+ };
665
+
666
+ export type PostCintelOperatorsErrors = {
667
+ /**
668
+ * Internal server error
669
+ */
670
+ 500: unknown;
671
+ };
672
+
673
+ export type PostCintelOperatorsResponses = {
674
+ /**
675
+ * Success
676
+ */
677
+ 200: unknown;
678
+ };
679
+
680
+ export type PostFlexTranscriptionData = {
681
+ body: {
682
+ [key: string]: unknown;
683
+ };
684
+ path?: never;
685
+ query?: never;
686
+ url: '/flex-transcription';
687
+ };
688
+
689
+ export type PostFlexTranscriptionErrors = {
690
+ /**
691
+ * Internal server error
692
+ */
693
+ 500: unknown;
694
+ };
695
+
696
+ export type PostFlexTranscriptionResponses = {
697
+ /**
698
+ * Success
699
+ */
700
+ 200: unknown;
701
+ };
702
+
703
+ export type PostTaskrouterWebhookData = {
704
+ body: {
705
+ [key: string]: unknown;
706
+ };
707
+ path?: never;
708
+ query?: never;
709
+ url: '/taskrouter-webhook';
710
+ };
711
+
712
+ export type PostTaskrouterWebhookErrors = {
713
+ /**
714
+ * Internal server error
715
+ */
716
+ 500: unknown;
717
+ };
718
+
719
+ export type PostTaskrouterWebhookResponses = {
720
+ /**
721
+ * Success
722
+ */
723
+ 200: unknown;
724
+ };
725
+
726
+ export type PostResolvePhoneData = {
727
+ body: {
728
+ [key: string]: unknown;
729
+ };
730
+ path?: never;
731
+ query?: never;
732
+ url: '/resolve-phone';
733
+ };
734
+
735
+ export type PostResolvePhoneErrors = {
736
+ /**
737
+ * Internal server error
738
+ */
739
+ 500: unknown;
740
+ };
741
+
742
+ export type PostResolvePhoneResponses = {
743
+ /**
744
+ * Success
745
+ */
746
+ 200: unknown;
747
+ };
748
+
749
+ export type PostCommunicationTextData = {
750
+ body: {
751
+ [key: string]: unknown;
752
+ };
753
+ path?: never;
754
+ query?: never;
755
+ url: '/communication-text';
756
+ };
757
+
758
+ export type PostCommunicationTextErrors = {
759
+ /**
760
+ * Internal server error
761
+ */
762
+ 500: unknown;
763
+ };
764
+
765
+ export type PostCommunicationTextResponses = {
766
+ /**
767
+ * Success
768
+ */
769
+ 200: unknown;
770
+ };
771
+
772
+ export type GetDocsOpenapiJsonData = {
773
+ body?: never;
774
+ path?: never;
775
+ query?: never;
776
+ url: '/docs/openapi.json';
777
+ };
778
+
779
+ export type GetDocsOpenapiJsonErrors = {
780
+ /**
781
+ * Unauthorized — requires Bearer token
782
+ */
783
+ 401: unknown;
784
+ /**
785
+ * Internal server error
786
+ */
787
+ 500: unknown;
788
+ };
789
+
790
+ export type GetDocsOpenapiJsonResponses = {
791
+ /**
792
+ * Success
793
+ */
794
+ 200: unknown;
795
+ };