@sentdm/sentdm 0.36.0 → 0.38.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.
Files changed (137) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +31 -0
  3. package/client.d.mts +28 -14
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +28 -14
  6. package/client.d.ts.map +1 -1
  7. package/client.js +10 -0
  8. package/client.js.map +1 -1
  9. package/client.mjs +10 -0
  10. package/client.mjs.map +1 -1
  11. package/core/pagination.d.mts +164 -0
  12. package/core/pagination.d.mts.map +1 -0
  13. package/core/pagination.d.ts +164 -0
  14. package/core/pagination.d.ts.map +1 -0
  15. package/core/pagination.js +212 -0
  16. package/core/pagination.js.map +1 -0
  17. package/core/pagination.mjs +202 -0
  18. package/core/pagination.mjs.map +1 -0
  19. package/index.d.mts +1 -0
  20. package/index.d.mts.map +1 -1
  21. package/index.d.ts +1 -0
  22. package/index.d.ts.map +1 -1
  23. package/index.js +3 -1
  24. package/index.js.map +1 -1
  25. package/index.mjs +1 -0
  26. package/index.mjs.map +1 -1
  27. package/internal/tslib.js +17 -17
  28. package/package.json +11 -1
  29. package/pagination.d.mts +3 -0
  30. package/pagination.d.mts.map +1 -0
  31. package/pagination.d.ts +3 -0
  32. package/pagination.d.ts.map +1 -0
  33. package/pagination.js +6 -0
  34. package/pagination.js.map +1 -0
  35. package/pagination.mjs +3 -0
  36. package/pagination.mjs.map +1 -0
  37. package/resources/contacts.d.mts +79 -626
  38. package/resources/contacts.d.mts.map +1 -1
  39. package/resources/contacts.d.ts +79 -626
  40. package/resources/contacts.d.ts.map +1 -1
  41. package/resources/contacts.js +12 -11
  42. package/resources/contacts.js.map +1 -1
  43. package/resources/contacts.mjs +12 -11
  44. package/resources/contacts.mjs.map +1 -1
  45. package/resources/conversations.d.mts +72 -346
  46. package/resources/conversations.d.mts.map +1 -1
  47. package/resources/conversations.d.ts +72 -346
  48. package/resources/conversations.d.ts.map +1 -1
  49. package/resources/conversations.js +16 -13
  50. package/resources/conversations.js.map +1 -1
  51. package/resources/conversations.mjs +16 -13
  52. package/resources/conversations.mjs.map +1 -1
  53. package/resources/index.d.mts +7 -7
  54. package/resources/index.d.mts.map +1 -1
  55. package/resources/index.d.ts +7 -7
  56. package/resources/index.d.ts.map +1 -1
  57. package/resources/index.js.map +1 -1
  58. package/resources/index.mjs.map +1 -1
  59. package/resources/me.d.mts +48 -129
  60. package/resources/me.d.mts.map +1 -1
  61. package/resources/me.d.ts +48 -129
  62. package/resources/me.d.ts.map +1 -1
  63. package/resources/me.js.map +1 -1
  64. package/resources/me.mjs.map +1 -1
  65. package/resources/messages.d.mts +8 -171
  66. package/resources/messages.d.mts.map +1 -1
  67. package/resources/messages.d.ts +8 -171
  68. package/resources/messages.d.ts.map +1 -1
  69. package/resources/messages.js.map +1 -1
  70. package/resources/messages.mjs.map +1 -1
  71. package/resources/numbers.d.mts +3 -42
  72. package/resources/numbers.d.mts.map +1 -1
  73. package/resources/numbers.d.ts +3 -42
  74. package/resources/numbers.d.ts.map +1 -1
  75. package/resources/numbers.js.map +1 -1
  76. package/resources/numbers.mjs.map +1 -1
  77. package/resources/profiles/campaigns.d.mts +149 -544
  78. package/resources/profiles/campaigns.d.mts.map +1 -1
  79. package/resources/profiles/campaigns.d.ts +149 -544
  80. package/resources/profiles/campaigns.d.ts.map +1 -1
  81. package/resources/profiles/index.d.mts +2 -2
  82. package/resources/profiles/index.d.mts.map +1 -1
  83. package/resources/profiles/index.d.ts +2 -2
  84. package/resources/profiles/index.d.ts.map +1 -1
  85. package/resources/profiles/index.js.map +1 -1
  86. package/resources/profiles/index.mjs.map +1 -1
  87. package/resources/profiles/profiles.d.mts +411 -1821
  88. package/resources/profiles/profiles.d.mts.map +1 -1
  89. package/resources/profiles/profiles.d.ts +411 -1821
  90. package/resources/profiles/profiles.d.ts.map +1 -1
  91. package/resources/profiles/profiles.js.map +1 -1
  92. package/resources/profiles/profiles.mjs.map +1 -1
  93. package/resources/templates.d.mts +87 -532
  94. package/resources/templates.d.mts.map +1 -1
  95. package/resources/templates.d.ts +87 -532
  96. package/resources/templates.d.ts.map +1 -1
  97. package/resources/templates.js +11 -10
  98. package/resources/templates.js.map +1 -1
  99. package/resources/templates.mjs +11 -10
  100. package/resources/templates.mjs.map +1 -1
  101. package/resources/users.d.mts +47 -437
  102. package/resources/users.d.mts.map +1 -1
  103. package/resources/users.d.ts +47 -437
  104. package/resources/users.d.ts.map +1 -1
  105. package/resources/users.js +3 -3
  106. package/resources/users.js.map +1 -1
  107. package/resources/users.mjs +3 -3
  108. package/resources/users.mjs.map +1 -1
  109. package/resources/webhooks.d.mts +192 -856
  110. package/resources/webhooks.d.mts.map +1 -1
  111. package/resources/webhooks.d.ts +192 -856
  112. package/resources/webhooks.d.ts.map +1 -1
  113. package/resources/webhooks.js +23 -19
  114. package/resources/webhooks.js.map +1 -1
  115. package/resources/webhooks.mjs +23 -19
  116. package/resources/webhooks.mjs.map +1 -1
  117. package/src/client.ts +124 -45
  118. package/src/core/pagination.ts +428 -0
  119. package/src/index.ts +1 -0
  120. package/src/pagination.ts +2 -0
  121. package/src/resources/contacts.ts +89 -726
  122. package/src/resources/conversations.ts +99 -427
  123. package/src/resources/index.ts +31 -23
  124. package/src/resources/me.ts +59 -148
  125. package/src/resources/messages.ts +8 -194
  126. package/src/resources/numbers.ts +3 -47
  127. package/src/resources/profiles/campaigns.ts +174 -673
  128. package/src/resources/profiles/index.ts +14 -6
  129. package/src/resources/profiles/profiles.ts +529 -2216
  130. package/src/resources/templates.ts +110 -629
  131. package/src/resources/users.ts +48 -505
  132. package/src/resources/webhooks.ts +307 -1091
  133. package/src/version.ts +1 -1
  134. package/version.d.mts +1 -1
  135. package/version.d.ts +1 -1
  136. package/version.js +1 -1
  137. package/version.mjs +1 -1
@@ -3,6 +3,13 @@
3
3
  import { APIResource } from '../core/resource';
4
4
  import * as WebhooksAPI from './webhooks';
5
5
  import { APIPromise } from '../core/api-promise';
6
+ import {
7
+ PagePromise,
8
+ WebhookEventsPage,
9
+ type WebhookEventsPageParams,
10
+ WebhooksPage,
11
+ type WebhooksPageParams,
12
+ } from '../core/pagination';
6
13
  import { buildHeaders } from '../internal/headers';
7
14
  import { RequestOptions } from '../internal/request-options';
8
15
  import { path } from '../internal/utils/path';
@@ -20,10 +27,10 @@ export class Webhooks extends APIResource {
20
27
  *
21
28
  * @example
22
29
  * ```ts
23
- * const webhook = await client.webhooks.create();
30
+ * const apiResponseWebhook = await client.webhooks.create();
24
31
  * ```
25
32
  */
26
- create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
33
+ create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<APIResponseWebhook> {
27
34
  const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
28
35
  return this._client.post('/v3/webhooks', {
29
36
  body,
@@ -43,7 +50,7 @@ export class Webhooks extends APIResource {
43
50
  *
44
51
  * @example
45
52
  * ```ts
46
- * const webhook = await client.webhooks.retrieve(
53
+ * const apiResponseWebhook = await client.webhooks.retrieve(
47
54
  * 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
48
55
  * );
49
56
  * ```
@@ -52,7 +59,7 @@ export class Webhooks extends APIResource {
52
59
  id: string,
53
60
  params: WebhookRetrieveParams | null | undefined = {},
54
61
  options?: RequestOptions,
55
- ): APIPromise<WebhookRetrieveResponse> {
62
+ ): APIPromise<APIResponseWebhook> {
56
63
  const { 'x-profile-id': xProfileID } = params ?? {};
57
64
  return this._client.get(path`/v3/webhooks/${id}`, {
58
65
  ...options,
@@ -68,16 +75,12 @@ export class Webhooks extends APIResource {
68
75
  *
69
76
  * @example
70
77
  * ```ts
71
- * const webhook = await client.webhooks.update(
78
+ * const apiResponseWebhook = await client.webhooks.update(
72
79
  * 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
73
80
  * );
74
81
  * ```
75
82
  */
76
- update(
77
- id: string,
78
- params: WebhookUpdateParams,
79
- options?: RequestOptions,
80
- ): APIPromise<WebhookUpdateResponse> {
83
+ update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<APIResponseWebhook> {
81
84
  const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
82
85
  return this._client.put(path`/v3/webhooks/${id}`, {
83
86
  body,
@@ -97,15 +100,18 @@ export class Webhooks extends APIResource {
97
100
  *
98
101
  * @example
99
102
  * ```ts
100
- * const webhooks = await client.webhooks.list({
101
- * page: 0,
102
- * page_size: 0,
103
- * });
103
+ * // Automatically fetches more pages as needed.
104
+ * for await (const webhookResponse of client.webhooks.list()) {
105
+ * // ...
106
+ * }
104
107
  * ```
105
108
  */
106
- list(params: WebhookListParams, options?: RequestOptions): APIPromise<WebhookListResponse> {
107
- const { 'x-profile-id': xProfileID, ...query } = params;
108
- return this._client.get('/v3/webhooks', {
109
+ list(
110
+ params: WebhookListParams | null | undefined = {},
111
+ options?: RequestOptions,
112
+ ): PagePromise<WebhookResponsesWebhooksPage, WebhookResponse> {
113
+ const { 'x-profile-id': xProfileID, ...query } = params ?? {};
114
+ return this._client.getAPIList('/v3/webhooks', WebhooksPage<WebhookResponse>, {
109
115
  query,
110
116
  ...options,
111
117
  headers: buildHeaders([
@@ -167,26 +173,32 @@ export class Webhooks extends APIResource {
167
173
  *
168
174
  * @example
169
175
  * ```ts
170
- * const response = await client.webhooks.listEvents(
176
+ * // Automatically fetches more pages as needed.
177
+ * for await (const webhookListEventsResponse of client.webhooks.listEvents(
171
178
  * 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
172
- * { page: 0, page_size: 0 },
173
- * );
179
+ * )) {
180
+ * // ...
181
+ * }
174
182
  * ```
175
183
  */
176
184
  listEvents(
177
185
  id: string,
178
- params: WebhookListEventsParams,
186
+ params: WebhookListEventsParams | null | undefined = {},
179
187
  options?: RequestOptions,
180
- ): APIPromise<WebhookListEventsResponse> {
181
- const { 'x-profile-id': xProfileID, ...query } = params;
182
- return this._client.get(path`/v3/webhooks/${id}/events`, {
183
- query,
184
- ...options,
185
- headers: buildHeaders([
186
- { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
187
- options?.headers,
188
- ]),
189
- });
188
+ ): PagePromise<WebhookListEventsResponsesWebhookEventsPage, WebhookListEventsResponse> {
189
+ const { 'x-profile-id': xProfileID, ...query } = params ?? {};
190
+ return this._client.getAPIList(
191
+ path`/v3/webhooks/${id}/events`,
192
+ WebhookEventsPage<WebhookListEventsResponse>,
193
+ {
194
+ query,
195
+ ...options,
196
+ headers: buildHeaders([
197
+ { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
198
+ options?.headers,
199
+ ]),
200
+ },
201
+ );
190
202
  }
191
203
 
192
204
  /**
@@ -249,16 +261,17 @@ export class Webhooks extends APIResource {
249
261
  *
250
262
  * @example
251
263
  * ```ts
252
- * const response = await client.webhooks.toggleStatus(
253
- * 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
254
- * );
264
+ * const apiResponseWebhook =
265
+ * await client.webhooks.toggleStatus(
266
+ * 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
267
+ * );
255
268
  * ```
256
269
  */
257
270
  toggleStatus(
258
271
  id: string,
259
272
  params: WebhookToggleStatusParams,
260
273
  options?: RequestOptions,
261
- ): APIPromise<WebhookToggleStatusResponse> {
274
+ ): APIPromise<APIResponseWebhook> {
262
275
  const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
263
276
  return this._client.patch(path`/v3/webhooks/${id}/toggle-status`, {
264
277
  body,
@@ -274,6 +287,80 @@ export class Webhooks extends APIResource {
274
287
  }
275
288
  }
276
289
 
290
+ export type WebhookResponsesWebhooksPage = WebhooksPage<WebhookResponse>;
291
+
292
+ export type WebhookListEventsResponsesWebhookEventsPage = WebhookEventsPage<WebhookListEventsResponse>;
293
+
294
+ /**
295
+ * Request and response metadata
296
+ */
297
+ export interface APIMeta {
298
+ /**
299
+ * Unique identifier for this request (for tracing and support)
300
+ */
301
+ request_id?: string;
302
+
303
+ /**
304
+ * Server timestamp when the response was generated
305
+ */
306
+ timestamp?: string;
307
+
308
+ /**
309
+ * API version used for this request
310
+ */
311
+ version?: string;
312
+ }
313
+
314
+ /**
315
+ * Standard API response envelope for all v3 endpoints
316
+ */
317
+ export interface APIResponseWebhook {
318
+ /**
319
+ * The response data (null if error)
320
+ */
321
+ data?: WebhookResponse | null;
322
+
323
+ /**
324
+ * Error information
325
+ */
326
+ error?: ErrorDetail | null;
327
+
328
+ /**
329
+ * Request and response metadata
330
+ */
331
+ meta?: APIMeta;
332
+
333
+ /**
334
+ * Indicates whether the request was successful
335
+ */
336
+ success?: boolean;
337
+ }
338
+
339
+ /**
340
+ * Error information
341
+ */
342
+ export interface ErrorDetail {
343
+ /**
344
+ * Machine-readable error code (e.g., "RESOURCE_001")
345
+ */
346
+ code?: string;
347
+
348
+ /**
349
+ * Additional validation error details (field-level errors)
350
+ */
351
+ details?: { [key: string]: Array<string> } | null;
352
+
353
+ /**
354
+ * URL to documentation about this error
355
+ */
356
+ doc_url?: string | null;
357
+
358
+ /**
359
+ * Human-readable error message
360
+ */
361
+ message?: string;
362
+ }
363
+
277
364
  /**
278
365
  * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
279
366
  * this shape and varies only in Payload.
@@ -445,6 +532,66 @@ export interface MessageEventPayload {
445
532
  updated_at?: string;
446
533
  }
447
534
 
535
+ export interface MutationRequest {
536
+ /**
537
+ * Sandbox flag - when true, the operation is simulated without side effects Useful
538
+ * for testing integrations without actual execution
539
+ */
540
+ sandbox?: boolean;
541
+ }
542
+
543
+ /**
544
+ * Pagination metadata for list responses
545
+ */
546
+ export interface PaginationMeta {
547
+ /**
548
+ * @deprecated Cursor-based pagination. Never populated — see Cursors.
549
+ */
550
+ cursors?: PaginationMeta.Cursors | null;
551
+
552
+ /**
553
+ * Whether there are more pages after this one
554
+ */
555
+ has_more?: boolean;
556
+
557
+ /**
558
+ * Current page number (1-indexed)
559
+ */
560
+ page?: number;
561
+
562
+ /**
563
+ * Number of items per page
564
+ */
565
+ page_size?: number;
566
+
567
+ /**
568
+ * Total number of items across all pages
569
+ */
570
+ total_count?: number;
571
+
572
+ /**
573
+ * Total number of pages
574
+ */
575
+ total_pages?: number;
576
+ }
577
+
578
+ export namespace PaginationMeta {
579
+ /**
580
+ * @deprecated Cursor-based pagination. Never populated — see Cursors.
581
+ */
582
+ export interface Cursors {
583
+ /**
584
+ * Cursor to fetch the next page.
585
+ */
586
+ after?: string | null;
587
+
588
+ /**
589
+ * Cursor to fetch the previous page.
590
+ */
591
+ before?: string | null;
592
+ }
593
+ }
594
+
448
595
  /**
449
596
  * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
450
597
  * this shape and varies only in Payload.
@@ -530,135 +677,74 @@ export interface TemplateEventPayload {
530
677
  template_name?: string;
531
678
  }
532
679
 
533
- /**
534
- * Standard API response envelope for all v3 endpoints
535
- */
536
- export interface WebhookCreateResponse {
537
- /**
538
- * The response data (null if error)
539
- */
540
- data?: WebhookCreateResponse.Data | null;
541
-
542
- /**
543
- * Error information
544
- */
545
- error?: WebhookCreateResponse.Error | null;
546
-
547
- /**
548
- * Request and response metadata
549
- */
550
- meta?: WebhookCreateResponse.Meta;
551
-
552
- /**
553
- * Indicates whether the request was successful
554
- */
555
- success?: boolean;
556
- }
557
-
558
- export namespace WebhookCreateResponse {
559
- /**
560
- * The response data (null if error)
561
- */
562
- export interface Data {
563
- id?: string;
564
-
565
- consecutive_failures?: number;
680
+ export interface WebhookEventType {
681
+ description?: string | null;
566
682
 
567
- created_at?: string;
683
+ display_name?: string;
568
684
 
569
- /**
570
- * Which customer owns this — the key's own, or the profile named in x-profile-id.
571
- * Says whose resource this is, which the resource's own id does not.
572
- */
573
- customer_id?: string;
685
+ event_type?: string | null;
574
686
 
575
- display_name?: string;
687
+ is_active?: boolean;
576
688
 
577
- endpoint_url?: string;
689
+ name?: string;
578
690
 
579
- event_filters?: { [key: string]: Array<string> } | null;
691
+ sub_types?: Array<WebhookEventType> | null;
692
+ }
580
693
 
581
- event_types?: Array<string>;
694
+ export interface WebhookResponse {
695
+ id?: string;
582
696
 
583
- is_active?: boolean;
697
+ consecutive_failures?: number;
584
698
 
585
- last_delivery_attempt_at?: string | null;
699
+ created_at?: string;
586
700
 
587
- last_successful_delivery_at?: string | null;
701
+ /**
702
+ * Which customer owns this — the key's own, or the profile named in x-profile-id.
703
+ * Says whose resource this is, which the resource's own id does not.
704
+ */
705
+ customer_id?: string;
588
706
 
589
- retry_count?: number;
707
+ display_name?: string;
590
708
 
591
- signing_secret?: string | null;
709
+ endpoint_url?: string;
592
710
 
593
- timeout_seconds?: number;
711
+ event_filters?: { [key: string]: Array<string> } | null;
594
712
 
595
- updated_at?: string | null;
596
- }
713
+ event_types?: Array<string>;
597
714
 
598
- /**
599
- * Error information
600
- */
601
- export interface Error {
602
- /**
603
- * Machine-readable error code (e.g., "RESOURCE_001")
604
- */
605
- code?: string;
715
+ is_active?: boolean;
606
716
 
607
- /**
608
- * Additional validation error details (field-level errors)
609
- */
610
- details?: { [key: string]: Array<string> } | null;
717
+ last_delivery_attempt_at?: string | null;
611
718
 
612
- /**
613
- * URL to documentation about this error
614
- */
615
- doc_url?: string | null;
719
+ last_successful_delivery_at?: string | null;
616
720
 
617
- /**
618
- * Human-readable error message
619
- */
620
- message?: string;
621
- }
721
+ retry_count?: number;
622
722
 
623
- /**
624
- * Request and response metadata
625
- */
626
- export interface Meta {
627
- /**
628
- * Unique identifier for this request (for tracing and support)
629
- */
630
- request_id?: string;
723
+ signing_secret?: string | null;
631
724
 
632
- /**
633
- * Server timestamp when the response was generated
634
- */
635
- timestamp?: string;
725
+ timeout_seconds?: number;
636
726
 
637
- /**
638
- * API version used for this request
639
- */
640
- version?: string;
641
- }
727
+ updated_at?: string | null;
642
728
  }
643
729
 
644
730
  /**
645
731
  * Standard API response envelope for all v3 endpoints
646
732
  */
647
- export interface WebhookRetrieveResponse {
733
+ export interface WebhookListEventTypesResponse {
648
734
  /**
649
- * The response data (null if error)
735
+ * The webhook event types a customer can subscribe to.
650
736
  */
651
- data?: WebhookRetrieveResponse.Data | null;
737
+ data?: WebhookListEventTypesResponse.Data | null;
652
738
 
653
739
  /**
654
740
  * Error information
655
741
  */
656
- error?: WebhookRetrieveResponse.Error | null;
742
+ error?: ErrorDetail | null;
657
743
 
658
744
  /**
659
745
  * Request and response metadata
660
746
  */
661
- meta?: WebhookRetrieveResponse.Meta;
747
+ meta?: APIMeta;
662
748
 
663
749
  /**
664
750
  * Indicates whether the request was successful
@@ -666,110 +752,105 @@ export interface WebhookRetrieveResponse {
666
752
  success?: boolean;
667
753
  }
668
754
 
669
- export namespace WebhookRetrieveResponse {
755
+ export namespace WebhookListEventTypesResponse {
670
756
  /**
671
- * The response data (null if error)
757
+ * The webhook event types a customer can subscribe to.
672
758
  */
673
759
  export interface Data {
674
- id?: string;
675
-
676
- consecutive_failures?: number;
677
-
678
- created_at?: string;
760
+ /**
761
+ * The event_types on this page.
762
+ */
763
+ event_types?: Array<WebhooksAPI.WebhookEventType>;
679
764
 
680
765
  /**
681
- * Which customer owns this — the key's own, or the profile named in x-profile-id.
682
- * Says whose resource this is, which the resource's own id does not.
766
+ * Pagination metadata for list responses
683
767
  */
684
- customer_id?: string;
768
+ pagination?: WebhooksAPI.PaginationMeta;
769
+ }
770
+ }
685
771
 
686
- display_name?: string;
772
+ export interface WebhookListEventsResponse {
773
+ id?: string;
687
774
 
688
- endpoint_url?: string;
775
+ created_at?: string;
689
776
 
690
- event_filters?: { [key: string]: Array<string> } | null;
777
+ delivery_attempts?: number;
691
778
 
692
- event_types?: Array<string>;
779
+ delivery_status?: string;
693
780
 
694
- is_active?: boolean;
781
+ error_message?: string | null;
695
782
 
696
- last_delivery_attempt_at?: string | null;
783
+ /**
784
+ * The exact event body that was delivered, or attempted, for this record. One of
785
+ * the three webhook envelopes: a message status change, an inbound message, or a
786
+ * template status change. Read field and event to tell which, the same way your
787
+ * endpoint does.
788
+ */
789
+ event_data?: MessageEvent | InboundMessageEvent | TemplateEvent;
697
790
 
698
- last_successful_delivery_at?: string | null;
791
+ event_type?: string;
699
792
 
700
- retry_count?: number;
793
+ http_status_code?: number | null;
701
794
 
702
- signing_secret?: string | null;
795
+ processing_completed_at?: string | null;
703
796
 
704
- timeout_seconds?: number;
797
+ processing_started_at?: string | null;
705
798
 
706
- updated_at?: string | null;
707
- }
799
+ response_body?: string | null;
800
+ }
708
801
 
802
+ /**
803
+ * Standard API response envelope for all v3 endpoints
804
+ */
805
+ export interface WebhookRotateSecretResponse {
709
806
  /**
710
- * Error information
807
+ * The response data (null if error)
711
808
  */
712
- export interface Error {
713
- /**
714
- * Machine-readable error code (e.g., "RESOURCE_001")
715
- */
716
- code?: string;
717
-
718
- /**
719
- * Additional validation error details (field-level errors)
720
- */
721
- details?: { [key: string]: Array<string> } | null;
722
-
723
- /**
724
- * URL to documentation about this error
725
- */
726
- doc_url?: string | null;
809
+ data?: WebhookRotateSecretResponse.Data | null;
727
810
 
728
- /**
729
- * Human-readable error message
730
- */
731
- message?: string;
732
- }
811
+ /**
812
+ * Error information
813
+ */
814
+ error?: ErrorDetail | null;
733
815
 
734
816
  /**
735
817
  * Request and response metadata
736
818
  */
737
- export interface Meta {
738
- /**
739
- * Unique identifier for this request (for tracing and support)
740
- */
741
- request_id?: string;
819
+ meta?: APIMeta;
742
820
 
743
- /**
744
- * Server timestamp when the response was generated
745
- */
746
- timestamp?: string;
821
+ /**
822
+ * Indicates whether the request was successful
823
+ */
824
+ success?: boolean;
825
+ }
747
826
 
748
- /**
749
- * API version used for this request
750
- */
751
- version?: string;
827
+ export namespace WebhookRotateSecretResponse {
828
+ /**
829
+ * The response data (null if error)
830
+ */
831
+ export interface Data {
832
+ signing_secret?: string;
752
833
  }
753
834
  }
754
835
 
755
836
  /**
756
837
  * Standard API response envelope for all v3 endpoints
757
838
  */
758
- export interface WebhookUpdateResponse {
839
+ export interface WebhookTestResponse {
759
840
  /**
760
841
  * The response data (null if error)
761
842
  */
762
- data?: WebhookUpdateResponse.Data | null;
843
+ data?: WebhookTestResponse.Data | null;
763
844
 
764
845
  /**
765
846
  * Error information
766
847
  */
767
- error?: WebhookUpdateResponse.Error | null;
848
+ error?: ErrorDetail | null;
768
849
 
769
850
  /**
770
851
  * Request and response metadata
771
852
  */
772
- meta?: WebhookUpdateResponse.Meta;
853
+ meta?: APIMeta;
773
854
 
774
855
  /**
775
856
  * Indicates whether the request was successful
@@ -777,891 +858,42 @@ export interface WebhookUpdateResponse {
777
858
  success?: boolean;
778
859
  }
779
860
 
780
- export namespace WebhookUpdateResponse {
861
+ export namespace WebhookTestResponse {
781
862
  /**
782
863
  * The response data (null if error)
783
864
  */
784
865
  export interface Data {
785
- id?: string;
786
-
787
- consecutive_failures?: number;
788
-
789
- created_at?: string;
866
+ message?: string;
790
867
 
791
- /**
792
- * Which customer owns this — the key's own, or the profile named in x-profile-id.
793
- * Says whose resource this is, which the resource's own id does not.
794
- */
795
- customer_id?: string;
868
+ success?: boolean;
869
+ }
870
+ }
796
871
 
797
- display_name?: string;
872
+ export interface WebhookCreateParams {
873
+ /**
874
+ * Body param
875
+ */
876
+ display_name?: string;
798
877
 
799
- endpoint_url?: string;
878
+ /**
879
+ * Body param
880
+ */
881
+ endpoint_url?: string;
800
882
 
801
- event_filters?: { [key: string]: Array<string> } | null;
883
+ /**
884
+ * Body param
885
+ */
886
+ event_filters?: { [key: string]: Array<string> } | null;
802
887
 
803
- event_types?: Array<string>;
888
+ /**
889
+ * Body param
890
+ */
891
+ event_types?: Array<string>;
804
892
 
805
- is_active?: boolean;
806
-
807
- last_delivery_attempt_at?: string | null;
808
-
809
- last_successful_delivery_at?: string | null;
810
-
811
- retry_count?: number;
812
-
813
- signing_secret?: string | null;
814
-
815
- timeout_seconds?: number;
816
-
817
- updated_at?: string | null;
818
- }
819
-
820
- /**
821
- * Error information
822
- */
823
- export interface Error {
824
- /**
825
- * Machine-readable error code (e.g., "RESOURCE_001")
826
- */
827
- code?: string;
828
-
829
- /**
830
- * Additional validation error details (field-level errors)
831
- */
832
- details?: { [key: string]: Array<string> } | null;
833
-
834
- /**
835
- * URL to documentation about this error
836
- */
837
- doc_url?: string | null;
838
-
839
- /**
840
- * Human-readable error message
841
- */
842
- message?: string;
843
- }
844
-
845
- /**
846
- * Request and response metadata
847
- */
848
- export interface Meta {
849
- /**
850
- * Unique identifier for this request (for tracing and support)
851
- */
852
- request_id?: string;
853
-
854
- /**
855
- * Server timestamp when the response was generated
856
- */
857
- timestamp?: string;
858
-
859
- /**
860
- * API version used for this request
861
- */
862
- version?: string;
863
- }
864
- }
865
-
866
- /**
867
- * Standard API response envelope for all v3 endpoints
868
- */
869
- export interface WebhookListResponse {
870
- /**
871
- * A paginated list of webhooks.
872
- */
873
- data?: WebhookListResponse.Data | null;
874
-
875
- /**
876
- * Error information
877
- */
878
- error?: WebhookListResponse.Error | null;
879
-
880
- /**
881
- * Request and response metadata
882
- */
883
- meta?: WebhookListResponse.Meta;
884
-
885
- /**
886
- * Indicates whether the request was successful
887
- */
888
- success?: boolean;
889
- }
890
-
891
- export namespace WebhookListResponse {
892
- /**
893
- * A paginated list of webhooks.
894
- */
895
- export interface Data {
896
- /**
897
- * Pagination metadata for list responses
898
- */
899
- pagination?: Data.Pagination;
900
-
901
- /**
902
- * The webhooks on this page.
903
- */
904
- webhooks?: Array<Data.Webhook>;
905
- }
906
-
907
- export namespace Data {
908
- /**
909
- * Pagination metadata for list responses
910
- */
911
- export interface Pagination {
912
- /**
913
- * @deprecated Cursor-based pagination. Never populated — see Cursors.
914
- */
915
- cursors?: Pagination.Cursors | null;
916
-
917
- /**
918
- * Whether there are more pages after this one
919
- */
920
- has_more?: boolean;
921
-
922
- /**
923
- * Current page number (1-indexed)
924
- */
925
- page?: number;
926
-
927
- /**
928
- * Number of items per page
929
- */
930
- page_size?: number;
931
-
932
- /**
933
- * Total number of items across all pages
934
- */
935
- total_count?: number;
936
-
937
- /**
938
- * Total number of pages
939
- */
940
- total_pages?: number;
941
- }
942
-
943
- export namespace Pagination {
944
- /**
945
- * @deprecated Cursor-based pagination. Never populated — see Cursors.
946
- */
947
- export interface Cursors {
948
- /**
949
- * Cursor to fetch the next page.
950
- */
951
- after?: string | null;
952
-
953
- /**
954
- * Cursor to fetch the previous page.
955
- */
956
- before?: string | null;
957
- }
958
- }
959
-
960
- export interface Webhook {
961
- id?: string;
962
-
963
- consecutive_failures?: number;
964
-
965
- created_at?: string;
966
-
967
- /**
968
- * Which customer owns this — the key's own, or the profile named in x-profile-id.
969
- * Says whose resource this is, which the resource's own id does not.
970
- */
971
- customer_id?: string;
972
-
973
- display_name?: string;
974
-
975
- endpoint_url?: string;
976
-
977
- event_filters?: { [key: string]: Array<string> } | null;
978
-
979
- event_types?: Array<string>;
980
-
981
- is_active?: boolean;
982
-
983
- last_delivery_attempt_at?: string | null;
984
-
985
- last_successful_delivery_at?: string | null;
986
-
987
- retry_count?: number;
988
-
989
- signing_secret?: string | null;
990
-
991
- timeout_seconds?: number;
992
-
993
- updated_at?: string | null;
994
- }
995
- }
996
-
997
- /**
998
- * Error information
999
- */
1000
- export interface Error {
1001
- /**
1002
- * Machine-readable error code (e.g., "RESOURCE_001")
1003
- */
1004
- code?: string;
1005
-
1006
- /**
1007
- * Additional validation error details (field-level errors)
1008
- */
1009
- details?: { [key: string]: Array<string> } | null;
1010
-
1011
- /**
1012
- * URL to documentation about this error
1013
- */
1014
- doc_url?: string | null;
1015
-
1016
- /**
1017
- * Human-readable error message
1018
- */
1019
- message?: string;
1020
- }
1021
-
1022
- /**
1023
- * Request and response metadata
1024
- */
1025
- export interface Meta {
1026
- /**
1027
- * Unique identifier for this request (for tracing and support)
1028
- */
1029
- request_id?: string;
1030
-
1031
- /**
1032
- * Server timestamp when the response was generated
1033
- */
1034
- timestamp?: string;
1035
-
1036
- /**
1037
- * API version used for this request
1038
- */
1039
- version?: string;
1040
- }
1041
- }
1042
-
1043
- /**
1044
- * Standard API response envelope for all v3 endpoints
1045
- */
1046
- export interface WebhookListEventTypesResponse {
1047
- /**
1048
- * The webhook event types a customer can subscribe to.
1049
- */
1050
- data?: WebhookListEventTypesResponse.Data | null;
1051
-
1052
- /**
1053
- * Error information
1054
- */
1055
- error?: WebhookListEventTypesResponse.Error | null;
1056
-
1057
- /**
1058
- * Request and response metadata
1059
- */
1060
- meta?: WebhookListEventTypesResponse.Meta;
1061
-
1062
- /**
1063
- * Indicates whether the request was successful
1064
- */
1065
- success?: boolean;
1066
- }
1067
-
1068
- export namespace WebhookListEventTypesResponse {
1069
- /**
1070
- * The webhook event types a customer can subscribe to.
1071
- */
1072
- export interface Data {
1073
- /**
1074
- * The event_types on this page.
1075
- */
1076
- event_types?: Array<Data.EventType>;
1077
-
1078
- /**
1079
- * Pagination metadata for list responses
1080
- */
1081
- pagination?: Data.Pagination;
1082
- }
1083
-
1084
- export namespace Data {
1085
- export interface EventType {
1086
- description?: string | null;
1087
-
1088
- display_name?: string;
1089
-
1090
- event_type?: string | null;
1091
-
1092
- is_active?: boolean;
1093
-
1094
- name?: string;
1095
-
1096
- sub_types?: Array<unknown> | null;
1097
- }
1098
-
1099
- /**
1100
- * Pagination metadata for list responses
1101
- */
1102
- export interface Pagination {
1103
- /**
1104
- * @deprecated Cursor-based pagination. Never populated — see Cursors.
1105
- */
1106
- cursors?: Pagination.Cursors | null;
1107
-
1108
- /**
1109
- * Whether there are more pages after this one
1110
- */
1111
- has_more?: boolean;
1112
-
1113
- /**
1114
- * Current page number (1-indexed)
1115
- */
1116
- page?: number;
1117
-
1118
- /**
1119
- * Number of items per page
1120
- */
1121
- page_size?: number;
1122
-
1123
- /**
1124
- * Total number of items across all pages
1125
- */
1126
- total_count?: number;
1127
-
1128
- /**
1129
- * Total number of pages
1130
- */
1131
- total_pages?: number;
1132
- }
1133
-
1134
- export namespace Pagination {
1135
- /**
1136
- * @deprecated Cursor-based pagination. Never populated — see Cursors.
1137
- */
1138
- export interface Cursors {
1139
- /**
1140
- * Cursor to fetch the next page.
1141
- */
1142
- after?: string | null;
1143
-
1144
- /**
1145
- * Cursor to fetch the previous page.
1146
- */
1147
- before?: string | null;
1148
- }
1149
- }
1150
- }
1151
-
1152
- /**
1153
- * Error information
1154
- */
1155
- export interface Error {
1156
- /**
1157
- * Machine-readable error code (e.g., "RESOURCE_001")
1158
- */
1159
- code?: string;
1160
-
1161
- /**
1162
- * Additional validation error details (field-level errors)
1163
- */
1164
- details?: { [key: string]: Array<string> } | null;
1165
-
1166
- /**
1167
- * URL to documentation about this error
1168
- */
1169
- doc_url?: string | null;
1170
-
1171
- /**
1172
- * Human-readable error message
1173
- */
1174
- message?: string;
1175
- }
1176
-
1177
- /**
1178
- * Request and response metadata
1179
- */
1180
- export interface Meta {
1181
- /**
1182
- * Unique identifier for this request (for tracing and support)
1183
- */
1184
- request_id?: string;
1185
-
1186
- /**
1187
- * Server timestamp when the response was generated
1188
- */
1189
- timestamp?: string;
1190
-
1191
- /**
1192
- * API version used for this request
1193
- */
1194
- version?: string;
1195
- }
1196
- }
1197
-
1198
- /**
1199
- * Standard API response envelope for all v3 endpoints
1200
- */
1201
- export interface WebhookListEventsResponse {
1202
- /**
1203
- * A paginated list of webhook delivery records.
1204
- */
1205
- data?: WebhookListEventsResponse.Data | null;
1206
-
1207
- /**
1208
- * Error information
1209
- */
1210
- error?: WebhookListEventsResponse.Error | null;
1211
-
1212
- /**
1213
- * Request and response metadata
1214
- */
1215
- meta?: WebhookListEventsResponse.Meta;
1216
-
1217
- /**
1218
- * Indicates whether the request was successful
1219
- */
1220
- success?: boolean;
1221
- }
1222
-
1223
- export namespace WebhookListEventsResponse {
1224
- /**
1225
- * A paginated list of webhook delivery records.
1226
- */
1227
- export interface Data {
1228
- /**
1229
- * The events on this page.
1230
- */
1231
- events?: Array<Data.Event>;
1232
-
1233
- /**
1234
- * Pagination metadata for list responses
1235
- */
1236
- pagination?: Data.Pagination;
1237
- }
1238
-
1239
- export namespace Data {
1240
- export interface Event {
1241
- id?: string;
1242
-
1243
- created_at?: string;
1244
-
1245
- delivery_attempts?: number;
1246
-
1247
- delivery_status?: string;
1248
-
1249
- error_message?: string | null;
1250
-
1251
- /**
1252
- * The exact event body that was delivered, or attempted, for this record. One of
1253
- * the three webhook envelopes: a message status change, an inbound message, or a
1254
- * template status change. Read field and event to tell which, the same way your
1255
- * endpoint does.
1256
- */
1257
- event_data?: WebhooksAPI.MessageEvent | WebhooksAPI.InboundMessageEvent | WebhooksAPI.TemplateEvent;
1258
-
1259
- event_type?: string;
1260
-
1261
- http_status_code?: number | null;
1262
-
1263
- processing_completed_at?: string | null;
1264
-
1265
- processing_started_at?: string | null;
1266
-
1267
- response_body?: string | null;
1268
- }
1269
-
1270
- /**
1271
- * Pagination metadata for list responses
1272
- */
1273
- export interface Pagination {
1274
- /**
1275
- * @deprecated Cursor-based pagination. Never populated — see Cursors.
1276
- */
1277
- cursors?: Pagination.Cursors | null;
1278
-
1279
- /**
1280
- * Whether there are more pages after this one
1281
- */
1282
- has_more?: boolean;
1283
-
1284
- /**
1285
- * Current page number (1-indexed)
1286
- */
1287
- page?: number;
1288
-
1289
- /**
1290
- * Number of items per page
1291
- */
1292
- page_size?: number;
1293
-
1294
- /**
1295
- * Total number of items across all pages
1296
- */
1297
- total_count?: number;
1298
-
1299
- /**
1300
- * Total number of pages
1301
- */
1302
- total_pages?: number;
1303
- }
1304
-
1305
- export namespace Pagination {
1306
- /**
1307
- * @deprecated Cursor-based pagination. Never populated — see Cursors.
1308
- */
1309
- export interface Cursors {
1310
- /**
1311
- * Cursor to fetch the next page.
1312
- */
1313
- after?: string | null;
1314
-
1315
- /**
1316
- * Cursor to fetch the previous page.
1317
- */
1318
- before?: string | null;
1319
- }
1320
- }
1321
- }
1322
-
1323
- /**
1324
- * Error information
1325
- */
1326
- export interface Error {
1327
- /**
1328
- * Machine-readable error code (e.g., "RESOURCE_001")
1329
- */
1330
- code?: string;
1331
-
1332
- /**
1333
- * Additional validation error details (field-level errors)
1334
- */
1335
- details?: { [key: string]: Array<string> } | null;
1336
-
1337
- /**
1338
- * URL to documentation about this error
1339
- */
1340
- doc_url?: string | null;
1341
-
1342
- /**
1343
- * Human-readable error message
1344
- */
1345
- message?: string;
1346
- }
1347
-
1348
- /**
1349
- * Request and response metadata
1350
- */
1351
- export interface Meta {
1352
- /**
1353
- * Unique identifier for this request (for tracing and support)
1354
- */
1355
- request_id?: string;
1356
-
1357
- /**
1358
- * Server timestamp when the response was generated
1359
- */
1360
- timestamp?: string;
1361
-
1362
- /**
1363
- * API version used for this request
1364
- */
1365
- version?: string;
1366
- }
1367
- }
1368
-
1369
- /**
1370
- * Standard API response envelope for all v3 endpoints
1371
- */
1372
- export interface WebhookRotateSecretResponse {
1373
- /**
1374
- * The response data (null if error)
1375
- */
1376
- data?: WebhookRotateSecretResponse.Data | null;
1377
-
1378
- /**
1379
- * Error information
1380
- */
1381
- error?: WebhookRotateSecretResponse.Error | null;
1382
-
1383
- /**
1384
- * Request and response metadata
1385
- */
1386
- meta?: WebhookRotateSecretResponse.Meta;
1387
-
1388
- /**
1389
- * Indicates whether the request was successful
1390
- */
1391
- success?: boolean;
1392
- }
1393
-
1394
- export namespace WebhookRotateSecretResponse {
1395
- /**
1396
- * The response data (null if error)
1397
- */
1398
- export interface Data {
1399
- signing_secret?: string;
1400
- }
1401
-
1402
- /**
1403
- * Error information
1404
- */
1405
- export interface Error {
1406
- /**
1407
- * Machine-readable error code (e.g., "RESOURCE_001")
1408
- */
1409
- code?: string;
1410
-
1411
- /**
1412
- * Additional validation error details (field-level errors)
1413
- */
1414
- details?: { [key: string]: Array<string> } | null;
1415
-
1416
- /**
1417
- * URL to documentation about this error
1418
- */
1419
- doc_url?: string | null;
1420
-
1421
- /**
1422
- * Human-readable error message
1423
- */
1424
- message?: string;
1425
- }
1426
-
1427
- /**
1428
- * Request and response metadata
1429
- */
1430
- export interface Meta {
1431
- /**
1432
- * Unique identifier for this request (for tracing and support)
1433
- */
1434
- request_id?: string;
1435
-
1436
- /**
1437
- * Server timestamp when the response was generated
1438
- */
1439
- timestamp?: string;
1440
-
1441
- /**
1442
- * API version used for this request
1443
- */
1444
- version?: string;
1445
- }
1446
- }
1447
-
1448
- /**
1449
- * Standard API response envelope for all v3 endpoints
1450
- */
1451
- export interface WebhookTestResponse {
1452
- /**
1453
- * The response data (null if error)
1454
- */
1455
- data?: WebhookTestResponse.Data | null;
1456
-
1457
- /**
1458
- * Error information
1459
- */
1460
- error?: WebhookTestResponse.Error | null;
1461
-
1462
- /**
1463
- * Request and response metadata
1464
- */
1465
- meta?: WebhookTestResponse.Meta;
1466
-
1467
- /**
1468
- * Indicates whether the request was successful
1469
- */
1470
- success?: boolean;
1471
- }
1472
-
1473
- export namespace WebhookTestResponse {
1474
- /**
1475
- * The response data (null if error)
1476
- */
1477
- export interface Data {
1478
- message?: string;
1479
-
1480
- success?: boolean;
1481
- }
1482
-
1483
- /**
1484
- * Error information
1485
- */
1486
- export interface Error {
1487
- /**
1488
- * Machine-readable error code (e.g., "RESOURCE_001")
1489
- */
1490
- code?: string;
1491
-
1492
- /**
1493
- * Additional validation error details (field-level errors)
1494
- */
1495
- details?: { [key: string]: Array<string> } | null;
1496
-
1497
- /**
1498
- * URL to documentation about this error
1499
- */
1500
- doc_url?: string | null;
1501
-
1502
- /**
1503
- * Human-readable error message
1504
- */
1505
- message?: string;
1506
- }
1507
-
1508
- /**
1509
- * Request and response metadata
1510
- */
1511
- export interface Meta {
1512
- /**
1513
- * Unique identifier for this request (for tracing and support)
1514
- */
1515
- request_id?: string;
1516
-
1517
- /**
1518
- * Server timestamp when the response was generated
1519
- */
1520
- timestamp?: string;
1521
-
1522
- /**
1523
- * API version used for this request
1524
- */
1525
- version?: string;
1526
- }
1527
- }
1528
-
1529
- /**
1530
- * Standard API response envelope for all v3 endpoints
1531
- */
1532
- export interface WebhookToggleStatusResponse {
1533
- /**
1534
- * The response data (null if error)
1535
- */
1536
- data?: WebhookToggleStatusResponse.Data | null;
1537
-
1538
- /**
1539
- * Error information
1540
- */
1541
- error?: WebhookToggleStatusResponse.Error | null;
1542
-
1543
- /**
1544
- * Request and response metadata
1545
- */
1546
- meta?: WebhookToggleStatusResponse.Meta;
1547
-
1548
- /**
1549
- * Indicates whether the request was successful
1550
- */
1551
- success?: boolean;
1552
- }
1553
-
1554
- export namespace WebhookToggleStatusResponse {
1555
- /**
1556
- * The response data (null if error)
1557
- */
1558
- export interface Data {
1559
- id?: string;
1560
-
1561
- consecutive_failures?: number;
1562
-
1563
- created_at?: string;
1564
-
1565
- /**
1566
- * Which customer owns this — the key's own, or the profile named in x-profile-id.
1567
- * Says whose resource this is, which the resource's own id does not.
1568
- */
1569
- customer_id?: string;
1570
-
1571
- display_name?: string;
1572
-
1573
- endpoint_url?: string;
1574
-
1575
- event_filters?: { [key: string]: Array<string> } | null;
1576
-
1577
- event_types?: Array<string>;
1578
-
1579
- is_active?: boolean;
1580
-
1581
- last_delivery_attempt_at?: string | null;
1582
-
1583
- last_successful_delivery_at?: string | null;
1584
-
1585
- retry_count?: number;
1586
-
1587
- signing_secret?: string | null;
1588
-
1589
- timeout_seconds?: number;
1590
-
1591
- updated_at?: string | null;
1592
- }
1593
-
1594
- /**
1595
- * Error information
1596
- */
1597
- export interface Error {
1598
- /**
1599
- * Machine-readable error code (e.g., "RESOURCE_001")
1600
- */
1601
- code?: string;
1602
-
1603
- /**
1604
- * Additional validation error details (field-level errors)
1605
- */
1606
- details?: { [key: string]: Array<string> } | null;
1607
-
1608
- /**
1609
- * URL to documentation about this error
1610
- */
1611
- doc_url?: string | null;
1612
-
1613
- /**
1614
- * Human-readable error message
1615
- */
1616
- message?: string;
1617
- }
1618
-
1619
- /**
1620
- * Request and response metadata
1621
- */
1622
- export interface Meta {
1623
- /**
1624
- * Unique identifier for this request (for tracing and support)
1625
- */
1626
- request_id?: string;
1627
-
1628
- /**
1629
- * Server timestamp when the response was generated
1630
- */
1631
- timestamp?: string;
1632
-
1633
- /**
1634
- * API version used for this request
1635
- */
1636
- version?: string;
1637
- }
1638
- }
1639
-
1640
- export interface WebhookCreateParams {
1641
- /**
1642
- * Body param
1643
- */
1644
- display_name?: string;
1645
-
1646
- /**
1647
- * Body param
1648
- */
1649
- endpoint_url?: string;
1650
-
1651
- /**
1652
- * Body param
1653
- */
1654
- event_filters?: { [key: string]: Array<string> } | null;
1655
-
1656
- /**
1657
- * Body param
1658
- */
1659
- event_types?: Array<string>;
1660
-
1661
- /**
1662
- * Body param
1663
- */
1664
- retry_count?: number;
893
+ /**
894
+ * Body param
895
+ */
896
+ retry_count?: number;
1665
897
 
1666
898
  /**
1667
899
  * Body param: Sandbox flag - when true, the operation is simulated without side
@@ -1749,17 +981,7 @@ export interface WebhookUpdateParams {
1749
981
  'x-profile-id'?: string;
1750
982
  }
1751
983
 
1752
- export interface WebhookListParams {
1753
- /**
1754
- * Query param
1755
- */
1756
- page: number;
1757
-
1758
- /**
1759
- * Query param
1760
- */
1761
- page_size: number;
1762
-
984
+ export interface WebhookListParams extends WebhooksPageParams {
1763
985
  /**
1764
986
  * Query param
1765
987
  */
@@ -1794,17 +1016,7 @@ export interface WebhookListEventTypesParams {
1794
1016
  'x-profile-id'?: string;
1795
1017
  }
1796
1018
 
1797
- export interface WebhookListEventsParams {
1798
- /**
1799
- * Query param
1800
- */
1801
- page: number;
1802
-
1803
- /**
1804
- * Query param
1805
- */
1806
- page_size: number;
1807
-
1019
+ export interface WebhookListEventsParams extends WebhookEventsPageParams {
1808
1020
  /**
1809
1021
  * Query param
1810
1022
  */
@@ -1896,21 +1108,25 @@ export interface WebhookToggleStatusParams {
1896
1108
 
1897
1109
  export declare namespace Webhooks {
1898
1110
  export {
1111
+ type APIMeta as APIMeta,
1112
+ type APIResponseWebhook as APIResponseWebhook,
1113
+ type ErrorDetail as ErrorDetail,
1899
1114
  type InboundMessageEvent as InboundMessageEvent,
1900
1115
  type InboundMessageEventPayload as InboundMessageEventPayload,
1901
1116
  type MessageEvent as MessageEvent,
1902
1117
  type MessageEventPayload as MessageEventPayload,
1118
+ type MutationRequest as MutationRequest,
1119
+ type PaginationMeta as PaginationMeta,
1903
1120
  type TemplateEvent as TemplateEvent,
1904
1121
  type TemplateEventPayload as TemplateEventPayload,
1905
- type WebhookCreateResponse as WebhookCreateResponse,
1906
- type WebhookRetrieveResponse as WebhookRetrieveResponse,
1907
- type WebhookUpdateResponse as WebhookUpdateResponse,
1908
- type WebhookListResponse as WebhookListResponse,
1122
+ type WebhookEventType as WebhookEventType,
1123
+ type WebhookResponse as WebhookResponse,
1909
1124
  type WebhookListEventTypesResponse as WebhookListEventTypesResponse,
1910
1125
  type WebhookListEventsResponse as WebhookListEventsResponse,
1911
1126
  type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
1912
1127
  type WebhookTestResponse as WebhookTestResponse,
1913
- type WebhookToggleStatusResponse as WebhookToggleStatusResponse,
1128
+ type WebhookResponsesWebhooksPage as WebhookResponsesWebhooksPage,
1129
+ type WebhookListEventsResponsesWebhookEventsPage as WebhookListEventsResponsesWebhookEventsPage,
1914
1130
  type WebhookCreateParams as WebhookCreateParams,
1915
1131
  type WebhookRetrieveParams as WebhookRetrieveParams,
1916
1132
  type WebhookUpdateParams as WebhookUpdateParams,