-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathapi.ts
More file actions
3791 lines (3530 loc) · 169 KB
/
Copy pathapi.ts
File metadata and controls
3791 lines (3530 loc) · 169 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* tslint:disable */
/* eslint-disable */
/**
* Hostinger Mail API
*
* API Version: 1.1.0
*
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
*/
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
import type { RequestArgs } from './base';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
/**
* Standard error envelope. Frontend translations key off `code`, never off `error`.
* @export
* @interface ModelError
*/
export interface ModelError {
/**
* Human-readable error message.
* @type {string}
* @memberof ModelError
*/
'error': string;
/**
* Machine-readable error code in SCREAMING_SNAKE_CASE.
* @type {string}
* @memberof ModelError
*/
'code': string;
/**
* Additional structured context for the error. May be omitted.
* @type {{ [key: string]: any; }}
* @memberof ModelError
*/
'params': { [key: string]: any; };
}
/**
* Pagination metadata for paginated collections.
* @export
* @interface Pagination
*/
export interface Pagination {
/**
* Current page number (1-based).
* @type {number}
* @memberof Pagination
*/
'page': number;
/**
* Items per page.
* @type {number}
* @memberof Pagination
*/
'perPage': number;
/**
* Total number of items across all pages.
* @type {number}
* @memberof Pagination
*/
'total': number;
/**
* Total number of pages.
* @type {number}
* @memberof Pagination
*/
'totalPages': number;
}
/**
* Paginated list of messages.
* @export
* @interface V1FolderMessagesCollection
*/
export interface V1FolderMessagesCollection {
/**
*
* @type {Array<V1FolderMessagesMessage>}
* @memberof V1FolderMessagesCollection
*/
'data': Array<V1FolderMessagesMessage>;
/**
*
* @type {Pagination}
* @memberof V1FolderMessagesCollection
*/
'pagination': Pagination;
}
/**
* Body for permanently deleting multiple messages.
* @export
* @interface V1FolderMessagesDeleteBulkRequest
*/
export interface V1FolderMessagesDeleteBulkRequest {
/**
* Message UIDs to delete. 1-100 entries, each > 0.
* @type {Array<number>}
* @memberof V1FolderMessagesDeleteBulkRequest
*/
'uids': Array<number>;
}
/**
* Add and/or remove flags on multiple messages. At least one of addFlags or removeFlags must be set.
* @export
* @interface V1FolderMessagesFlagsBulkRequest
*/
export interface V1FolderMessagesFlagsBulkRequest {
/**
* Message UIDs to update. 1-100 entries, each > 0.
* @type {Array<number>}
* @memberof V1FolderMessagesFlagsBulkRequest
*/
'uids': Array<number>;
/**
*
* @type {Array<string>}
* @memberof V1FolderMessagesFlagsBulkRequest
*/
'addFlags': Array<string>;
/**
*
* @type {Array<string>}
* @memberof V1FolderMessagesFlagsBulkRequest
*/
'removeFlags': Array<string>;
}
/**
* Add and/or remove flags on a message. At least one of addFlags or removeFlags must be set.
* @export
* @interface V1FolderMessagesFlagsRequest
*/
export interface V1FolderMessagesFlagsRequest {
/**
*
* @type {Array<string>}
* @memberof V1FolderMessagesFlagsRequest
*/
'addFlags': Array<string>;
/**
*
* @type {Array<string>}
* @memberof V1FolderMessagesFlagsRequest
*/
'removeFlags': Array<string>;
}
/**
* A message in a folder of the managed mailbox.
* @export
* @interface V1FolderMessagesMessage
*/
export interface V1FolderMessagesMessage {
/**
*
* @type {number}
* @memberof V1FolderMessagesMessage
*/
'uid': number;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessage
*/
'path': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessage
*/
'date': string;
/**
*
* @type {Array<string>}
* @memberof V1FolderMessagesMessage
*/
'flags': Array<string>;
/**
*
* @type {boolean}
* @memberof V1FolderMessagesMessage
*/
'unseen': boolean;
/**
*
* @type {number}
* @memberof V1FolderMessagesMessage
*/
'size': number;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessage
*/
'subject': string | null;
/**
*
* @type {V1FolderMessagesMessageAddress}
* @memberof V1FolderMessagesMessage
*/
'from': V1FolderMessagesMessageAddress | null;
/**
*
* @type {Array<V1FolderMessagesMessageAddress>}
* @memberof V1FolderMessagesMessage
*/
'to': Array<V1FolderMessagesMessageAddress>;
/**
*
* @type {Array<V1FolderMessagesMessageAddress>}
* @memberof V1FolderMessagesMessage
*/
'cc': Array<V1FolderMessagesMessageAddress>;
/**
*
* @type {Array<V1FolderMessagesMessageAddress>}
* @memberof V1FolderMessagesMessage
*/
'bcc': Array<V1FolderMessagesMessageAddress>;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessage
*/
'messageId': string | null;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessage
*/
'inReplyTo': string | null;
/**
*
* @type {Array<V1FolderMessagesMessageAttachment>}
* @memberof V1FolderMessagesMessage
*/
'attachments': Array<V1FolderMessagesMessageAttachment>;
}
/**
* A single email address with optional display name.
* @export
* @interface V1FolderMessagesMessageAddress
*/
export interface V1FolderMessagesMessageAddress {
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageAddress
*/
'name': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageAddress
*/
'address': string;
}
/**
* Attachment metadata attached to a message.
* @export
* @interface V1FolderMessagesMessageAttachment
*/
export interface V1FolderMessagesMessageAttachment {
/**
* Opaque attachment identifier. Use as the {attachmentId} path parameter on the download endpoint.
* @type {string}
* @memberof V1FolderMessagesMessageAttachment
*/
'id': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageAttachment
*/
'contentType': string;
/**
*
* @type {number}
* @memberof V1FolderMessagesMessageAttachment
*/
'sizeBytes': number;
/**
*
* @type {boolean}
* @memberof V1FolderMessagesMessageAttachment
*/
'inline': boolean;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageAttachment
*/
'filename': string | null;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageAttachment
*/
'contentId': string | null;
}
/**
* Rendered text and HTML parts of a message.
* @export
* @interface V1FolderMessagesMessageText
*/
export interface V1FolderMessagesMessageText {
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageText
*/
'text': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesMessageText
*/
'html': string;
}
/**
* Single message text payload.
* @export
* @interface V1FolderMessagesMessageTextResource
*/
export interface V1FolderMessagesMessageTextResource {
/**
*
* @type {V1FolderMessagesMessageText}
* @memberof V1FolderMessagesMessageTextResource
*/
'data': V1FolderMessagesMessageText;
}
/**
* Body for moving multiple messages to a target folder.
* @export
* @interface V1FolderMessagesMoveBulkRequest
*/
export interface V1FolderMessagesMoveBulkRequest {
/**
* Message UIDs to move. 1-100 entries, each > 0.
* @type {Array<number>}
* @memberof V1FolderMessagesMoveBulkRequest
*/
'uids': Array<number>;
/**
* Destination folder path.
* @type {string}
* @memberof V1FolderMessagesMoveBulkRequest
*/
'targetFolder': string;
}
/**
* Body for moving a single message to a target folder.
* @export
* @interface V1FolderMessagesMoveRequest
*/
export interface V1FolderMessagesMoveRequest {
/**
* Destination folder path.
* @type {string}
* @memberof V1FolderMessagesMoveRequest
*/
'targetFolder': string;
}
/**
* Single message payload.
* @export
* @interface V1FolderMessagesResource
*/
export interface V1FolderMessagesResource {
/**
*
* @type {V1FolderMessagesMessage}
* @memberof V1FolderMessagesResource
*/
'data': V1FolderMessagesMessage;
}
/**
* Search criteria. All fields optional; combine to narrow results.
* @export
* @interface V1FolderMessagesSearchRequest
*/
export interface V1FolderMessagesSearchRequest {
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'since': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'before': string;
/**
*
* @type {Array<string>}
* @memberof V1FolderMessagesSearchRequest
*/
'flags': Array<string>;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'uid': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'subject': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'from': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'to': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'cc': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'body': string;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'header': string;
/**
*
* @type {number}
* @memberof V1FolderMessagesSearchRequest
*/
'larger': number;
/**
*
* @type {number}
* @memberof V1FolderMessagesSearchRequest
*/
'smaller': number;
/**
*
* @type {string}
* @memberof V1FolderMessagesSearchRequest
*/
'text': string;
}
/**
* Per-UID outcome of a bulk flag update. 200 when every UID succeeded, 207 when at least one failed.
* @export
* @interface V1FolderMessagesUpdateFlagsResult
*/
export interface V1FolderMessagesUpdateFlagsResult {
/**
*
* @type {V1FolderMessagesUpdateFlagsResultData}
* @memberof V1FolderMessagesUpdateFlagsResult
*/
'data': V1FolderMessagesUpdateFlagsResultData;
}
/**
*
* @export
* @interface V1FolderMessagesUpdateFlagsResultData
*/
export interface V1FolderMessagesUpdateFlagsResultData {
/**
*
* @type {Array<number>}
* @memberof V1FolderMessagesUpdateFlagsResultData
*/
'successful': Array<number>;
/**
*
* @type {Array<V1FolderMessagesUpdateFlagsResultDataFailedInner>}
* @memberof V1FolderMessagesUpdateFlagsResultData
*/
'failed': Array<V1FolderMessagesUpdateFlagsResultDataFailedInner>;
}
/**
*
* @export
* @interface V1FolderMessagesUpdateFlagsResultDataFailedInner
*/
export interface V1FolderMessagesUpdateFlagsResultDataFailedInner {
/**
*
* @type {number}
* @memberof V1FolderMessagesUpdateFlagsResultDataFailedInner
*/
'uid': number;
/**
*
* @type {string}
* @memberof V1FolderMessagesUpdateFlagsResultDataFailedInner
*/
'reason': string;
}
/**
* Paginated list of folders.
* @export
* @interface V1FoldersCollection
*/
export interface V1FoldersCollection {
/**
*
* @type {Array<V1FoldersFolder>}
* @memberof V1FoldersCollection
*/
'data': Array<V1FoldersFolder>;
/**
*
* @type {Pagination}
* @memberof V1FoldersCollection
*/
'pagination': Pagination;
}
/**
* Body for creating a folder.
* @export
* @interface V1FoldersCreateRequest
*/
export interface V1FoldersCreateRequest {
/**
* Folder name. Length 1-100 after trimming.
* @type {string}
* @memberof V1FoldersCreateRequest
*/
'name': string;
}
/**
* A folder (IMAP mailbox) in the managed mailbox.
* @export
* @interface V1FoldersFolder
*/
export interface V1FoldersFolder {
/**
* Full hierarchical folder path including the delimiter.
* @type {string}
* @memberof V1FoldersFolder
*/
'path': string;
/**
* Leaf name of the folder.
* @type {string}
* @memberof V1FoldersFolder
*/
'name': string;
/**
* Hierarchy delimiter used by the IMAP server.
* @type {string}
* @memberof V1FoldersFolder
*/
'delimiter': string;
/**
* IMAP SPECIAL-USE attribute (RFC 6154). `null` for regular folders.
* @type {string}
* @memberof V1FoldersFolder
*/
'specialUse': string | null;
/**
* Total number of messages in the folder.
* @type {number}
* @memberof V1FoldersFolder
*/
'messageCount': number;
/**
* Number of unread messages in the folder.
* @type {number}
* @memberof V1FoldersFolder
*/
'unreadCount': number;
}
/**
* Single folder payload.
* @export
* @interface V1FoldersResource
*/
export interface V1FoldersResource {
/**
*
* @type {V1FoldersFolder}
* @memberof V1FoldersResource
*/
'data': V1FoldersFolder;
}
/**
* Body for renaming a folder.
* @export
* @interface V1FoldersUpdateRequest
*/
export interface V1FoldersUpdateRequest {
/**
* New folder name. Length 1-100 after trimming.
* @type {string}
* @memberof V1FoldersUpdateRequest
*/
'name': string;
}
/**
* A mailbox the authenticated API token can manage.
* @export
* @interface V1MeMailbox
*/
export interface V1MeMailbox {
/**
* Unique identifier of the mailbox.
* @type {string}
* @memberof V1MeMailbox
*/
'resourceId': string;
/**
* Email address of the mailbox.
* @type {string}
* @memberof V1MeMailbox
*/
'address': string;
}
/**
* Authenticated account payload.
* @export
* @interface V1MeResource
*/
export interface V1MeResource {
/**
*
* @type {V1MeResourceData}
* @memberof V1MeResource
*/
'data': V1MeResourceData;
}
/**
*
* @export
* @interface V1MeResourceData
*/
export interface V1MeResourceData {
/**
* Identifier of the order this API token is scoped to.
* @type {string}
* @memberof V1MeResourceData
*/
'orderResourceId': string;
/**
* Mailboxes that the authenticated API token can manage.
* @type {Array<V1MeMailbox>}
* @memberof V1MeResourceData
*/
'mailboxes': Array<V1MeMailbox>;
}
/**
* Storage and message quota usage for the managed mailbox.
* @export
* @interface V1QuotaQuota
*/
export interface V1QuotaQuota {
/**
* Per-resource quota breakdown reported by the IMAP server.
* @type {Array<V1QuotaQuotaResource>}
* @memberof V1QuotaQuota
*/
'quotas': Array<V1QuotaQuotaResource>;
/**
* Aggregate storage usage across all resources, in bytes.
* @type {number}
* @memberof V1QuotaQuota
*/
'totalUsage': number;
/**
* Aggregate storage limit across all resources, in bytes.
* @type {number}
* @memberof V1QuotaQuota
*/
'totalLimit': number;
/**
* Aggregate storage usage as a percentage of the total limit.
* @type {number}
* @memberof V1QuotaQuota
*/
'totalPercentage': number;
/**
* Whether the IMAP server reports quota information for this mailbox.
* @type {boolean}
* @memberof V1QuotaQuota
*/
'supported': boolean;
}
/**
* Usage and limit for a single IMAP quota resource.
* @export
* @interface V1QuotaQuotaResource
*/
export interface V1QuotaQuotaResource {
/**
* Name of the quota resource as reported by the IMAP server.
* @type {string}
* @memberof V1QuotaQuotaResource
*/
'resourceName': string;
/**
* Current usage of the resource (bytes for STORAGE, count for MESSAGE).
* @type {number}
* @memberof V1QuotaQuotaResource
*/
'usage': number;
/**
* Maximum allowed value for the resource (bytes for STORAGE, count for MESSAGE).
* @type {number}
* @memberof V1QuotaQuotaResource
*/
'limit': number;
/**
* Usage as a percentage of the limit.
* @type {number}
* @memberof V1QuotaQuotaResource
*/
'percentage': number;
}
/**
* Mailbox quota payload.
* @export
* @interface V1QuotaResource
*/
export interface V1QuotaResource {
/**
*
* @type {V1QuotaQuota}
* @memberof V1QuotaResource
*/
'data': V1QuotaQuota;
}
/**
* Attachment payload for outgoing mail. Supports regular attachments and inline images linked via Content-ID.
* @export
* @interface V1SendAttachment
*/
export interface V1SendAttachment {
/**
*
* @type {string}
* @memberof V1SendAttachment
*/
'filename': string;
/**
* Attachment body. Base64-encoded by default; set encoding to switch.
* @type {string}
* @memberof V1SendAttachment
*/
'content': string;
/**
*
* @type {string}
* @memberof V1SendAttachment
*/
'contentType': string;
/**
* Content-ID for inline images. Reference from HTML as <img src=\"cid:logo\">.
* @type {string}
* @memberof V1SendAttachment
*/
'cid': string;
/**
* Encoding of content. Defaults to base64.
* @type {string}
* @memberof V1SendAttachment
*/
'encoding': string;
}
/**
* Reference to a source message by UID within a folder, used for reply/forward threading. Both fields are required.
* @export
* @interface V1SendMessageRef
*/
export interface V1SendMessageRef {
/**
* UID of the source message.
* @type {number}
* @memberof V1SendMessageRef
*/
'uid': number;
/**
* Folder containing the source message.
* @type {string}
* @memberof V1SendMessageRef
*/
'folder': string;
}
/**
* Outgoing message payload. At least one of to, cc, or bcc must be present.
* @export
* @interface V1SendRequest
*/
export interface V1SendRequest {
/**
*
* @type {Array<string>}
* @memberof V1SendRequest
*/
'to': Array<string>;
/**
*
* @type {string}
* @memberof V1SendRequest
*/
'displayName': string;
/**
*
* @type {Array<string>}
* @memberof V1SendRequest
*/
'cc': Array<string>;
/**
*
* @type {Array<string>}
* @memberof V1SendRequest
*/
'bcc': Array<string>;
/**
*
* @type {string}
* @memberof V1SendRequest
*/
'subject': string;
/**
*
* @type {string}
* @memberof V1SendRequest
*/
'text': string;
/**
*
* @type {string}
* @memberof V1SendRequest
*/
'html': string;
/**
*
* @type {Array<V1SendAttachment>}
* @memberof V1SendRequest
*/
'attachments': Array<V1SendAttachment>;
/**
* Source message this is a reply to. Copies its Message-Id/References into In-Reply-To/References and flags it \\Answered. Mutually exclusive with forwardOf.
* @type {V1SendMessageRef}
* @memberof V1SendRequest
*/
'inReplyTo': V1SendMessageRef;
/**
* Source message this forwards. Copies its Message-Id/References into In-Reply-To/References and flags it $forwarded. Mutually exclusive with inReplyTo.
* @type {V1SendMessageRef}
* @memberof V1SendRequest
*/
'forwardOf': V1SendMessageRef;
}
/**
* Paginated list of webhooks.
* @export
* @interface V1WebhooksCollection
*/
export interface V1WebhooksCollection {
/**
*
* @type {Array<V1WebhooksWebhook>}
* @memberof V1WebhooksCollection
*/
'data': Array<V1WebhooksWebhook>;
/**
*
* @type {Pagination}
* @memberof V1WebhooksCollection
*/
'pagination': Pagination;
}
/**
* Body for creating a webhook.
* @export
* @interface V1WebhooksCreateRequest
*/
export interface V1WebhooksCreateRequest {
/**
*
* @type {string}
* @memberof V1WebhooksCreateRequest
*/
'name': string;
/**
*
* @type {string}
* @memberof V1WebhooksCreateRequest
*/
'description': string | null;
/**
*
* @type {Array<string>}
* @memberof V1WebhooksCreateRequest
*/
'events': Array<V1WebhooksCreateRequestEventsEnum>;
/**
*
* @type {string}
* @memberof V1WebhooksCreateRequest
*/
'status': V1WebhooksCreateRequestStatusEnum;
/**
*
* @type {string}
* @memberof V1WebhooksCreateRequest
*/
'url': string;
}
export const V1WebhooksCreateRequestEventsEnum = {
MessageReceived: 'message.received'
} as const;
export type V1WebhooksCreateRequestEventsEnum = typeof V1WebhooksCreateRequestEventsEnum[keyof typeof V1WebhooksCreateRequestEventsEnum];
export const V1WebhooksCreateRequestStatusEnum = {
Active: 'active',
Paused: 'paused',
Disabled: 'disabled'
} as const;
export type V1WebhooksCreateRequestStatusEnum = typeof V1WebhooksCreateRequestStatusEnum[keyof typeof V1WebhooksCreateRequestStatusEnum];
/**
* Single webhook payload.
* @export
* @interface V1WebhooksResource
*/
export interface V1WebhooksResource {
/**
*
* @type {V1WebhooksWebhook}
* @memberof V1WebhooksResource
*/
'data': V1WebhooksWebhook;
}
/**
* Single webhook payload including the one-time secret.
* @export
* @interface V1WebhooksResourceWithSecret
*/
export interface V1WebhooksResourceWithSecret {
/**
*
* @type {V1WebhooksWebhookWithSecret}
* @memberof V1WebhooksResourceWithSecret
*/
'data': V1WebhooksWebhookWithSecret;
}
/**
* Result of a webhook test delivery.
* @export
* @interface V1WebhooksTestResult
*/
export interface V1WebhooksTestResult {
/**
*
* @type {V1WebhooksTestResultData}
* @memberof V1WebhooksTestResult
*/
'data': V1WebhooksTestResultData;
}
/**
*
* @export
* @interface V1WebhooksTestResultData
*/
export interface V1WebhooksTestResultData {
/**
*
* @type {number}
* @memberof V1WebhooksTestResultData
*/
'httpStatus': number;
/**
*
* @type {boolean}