@sentdm/sentdm 0.35.0 → 0.37.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/CHANGELOG.md +18 -0
- package/client.d.mts +14 -14
- package/client.d.mts.map +1 -1
- package/client.d.ts +14 -14
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/contacts.d.mts +85 -589
- package/resources/contacts.d.mts.map +1 -1
- package/resources/contacts.d.ts +85 -589
- package/resources/contacts.d.ts.map +1 -1
- package/resources/contacts.js +4 -4
- package/resources/contacts.js.map +1 -1
- package/resources/contacts.mjs +4 -4
- package/resources/contacts.mjs.map +1 -1
- package/resources/conversations.d.mts +69 -328
- package/resources/conversations.d.mts.map +1 -1
- package/resources/conversations.d.ts +69 -328
- package/resources/conversations.d.ts.map +1 -1
- package/resources/conversations.js +10 -8
- package/resources/conversations.js.map +1 -1
- package/resources/conversations.mjs +10 -8
- package/resources/conversations.mjs.map +1 -1
- package/resources/index.d.mts +7 -7
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +7 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/me.d.mts +81 -129
- package/resources/me.d.mts.map +1 -1
- package/resources/me.d.ts +81 -129
- package/resources/me.d.ts.map +1 -1
- package/resources/me.js +11 -0
- package/resources/me.js.map +1 -1
- package/resources/me.mjs +11 -0
- package/resources/me.mjs.map +1 -1
- package/resources/messages.d.mts +8 -171
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +8 -171
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs.map +1 -1
- package/resources/numbers.d.mts +3 -42
- package/resources/numbers.d.mts.map +1 -1
- package/resources/numbers.d.ts +3 -42
- package/resources/numbers.d.ts.map +1 -1
- package/resources/numbers.js.map +1 -1
- package/resources/numbers.mjs.map +1 -1
- package/resources/profiles/campaigns.d.mts +149 -544
- package/resources/profiles/campaigns.d.mts.map +1 -1
- package/resources/profiles/campaigns.d.ts +149 -544
- package/resources/profiles/campaigns.d.ts.map +1 -1
- package/resources/profiles/index.d.mts +2 -2
- package/resources/profiles/index.d.mts.map +1 -1
- package/resources/profiles/index.d.ts +2 -2
- package/resources/profiles/index.d.ts.map +1 -1
- package/resources/profiles/index.js.map +1 -1
- package/resources/profiles/index.mjs.map +1 -1
- package/resources/profiles/profiles.d.mts +411 -1821
- package/resources/profiles/profiles.d.mts.map +1 -1
- package/resources/profiles/profiles.d.ts +411 -1821
- package/resources/profiles/profiles.d.ts.map +1 -1
- package/resources/profiles/profiles.js.map +1 -1
- package/resources/profiles/profiles.mjs.map +1 -1
- package/resources/templates.d.mts +84 -486
- package/resources/templates.d.mts.map +1 -1
- package/resources/templates.d.ts +84 -486
- package/resources/templates.d.ts.map +1 -1
- package/resources/templates.js +3 -3
- package/resources/templates.js.map +1 -1
- package/resources/templates.mjs +3 -3
- package/resources/templates.mjs.map +1 -1
- package/resources/users.d.mts +47 -437
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +47 -437
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +3 -3
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +3 -3
- package/resources/users.mjs.map +1 -1
- package/resources/webhooks.d.mts +189 -768
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +189 -768
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +7 -6
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +7 -6
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +52 -39
- package/src/resources/contacts.ts +88 -678
- package/src/resources/conversations.ts +77 -393
- package/src/resources/index.ts +26 -20
- package/src/resources/me.ts +94 -148
- package/src/resources/messages.ts +8 -194
- package/src/resources/numbers.ts +3 -47
- package/src/resources/profiles/campaigns.ts +174 -673
- package/src/resources/profiles/index.ts +14 -6
- package/src/resources/profiles/profiles.ts +529 -2216
- package/src/resources/templates.ts +100 -572
- package/src/resources/users.ts +48 -505
- package/src/resources/webhooks.ts +297 -996
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/webhooks.d.ts
CHANGED
|
@@ -15,32 +15,32 @@ export declare class Webhooks extends APIResource {
|
|
|
15
15
|
*
|
|
16
16
|
* @example
|
|
17
17
|
* ```ts
|
|
18
|
-
* const
|
|
18
|
+
* const apiResponseWebhook = await client.webhooks.create();
|
|
19
19
|
* ```
|
|
20
20
|
*/
|
|
21
|
-
create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<
|
|
21
|
+
create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<APIResponseWebhook>;
|
|
22
22
|
/**
|
|
23
23
|
* Retrieves a single webhook by ID for the authenticated customer.
|
|
24
24
|
*
|
|
25
25
|
* @example
|
|
26
26
|
* ```ts
|
|
27
|
-
* const
|
|
27
|
+
* const apiResponseWebhook = await client.webhooks.retrieve(
|
|
28
28
|
* 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
|
|
29
29
|
* );
|
|
30
30
|
* ```
|
|
31
31
|
*/
|
|
32
|
-
retrieve(id: string, params?: WebhookRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<
|
|
32
|
+
retrieve(id: string, params?: WebhookRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseWebhook>;
|
|
33
33
|
/**
|
|
34
34
|
* Updates an existing webhook for the authenticated customer.
|
|
35
35
|
*
|
|
36
36
|
* @example
|
|
37
37
|
* ```ts
|
|
38
|
-
* const
|
|
38
|
+
* const apiResponseWebhook = await client.webhooks.update(
|
|
39
39
|
* 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
|
|
40
40
|
* );
|
|
41
41
|
* ```
|
|
42
42
|
*/
|
|
43
|
-
update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<
|
|
43
|
+
update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<APIResponseWebhook>;
|
|
44
44
|
/**
|
|
45
45
|
* Retrieves a paginated list of webhooks for the authenticated customer.
|
|
46
46
|
*
|
|
@@ -113,12 +113,74 @@ export declare class Webhooks extends APIResource {
|
|
|
113
113
|
*
|
|
114
114
|
* @example
|
|
115
115
|
* ```ts
|
|
116
|
-
* const
|
|
117
|
-
*
|
|
118
|
-
*
|
|
116
|
+
* const apiResponseWebhook =
|
|
117
|
+
* await client.webhooks.toggleStatus(
|
|
118
|
+
* 'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
|
|
119
|
+
* );
|
|
119
120
|
* ```
|
|
120
121
|
*/
|
|
121
|
-
toggleStatus(id: string, params: WebhookToggleStatusParams, options?: RequestOptions): APIPromise<
|
|
122
|
+
toggleStatus(id: string, params: WebhookToggleStatusParams, options?: RequestOptions): APIPromise<APIResponseWebhook>;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Request and response metadata
|
|
126
|
+
*/
|
|
127
|
+
export interface APIMeta {
|
|
128
|
+
/**
|
|
129
|
+
* Unique identifier for this request (for tracing and support)
|
|
130
|
+
*/
|
|
131
|
+
request_id?: string;
|
|
132
|
+
/**
|
|
133
|
+
* Server timestamp when the response was generated
|
|
134
|
+
*/
|
|
135
|
+
timestamp?: string;
|
|
136
|
+
/**
|
|
137
|
+
* API version used for this request
|
|
138
|
+
*/
|
|
139
|
+
version?: string;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Standard API response envelope for all v3 endpoints
|
|
143
|
+
*/
|
|
144
|
+
export interface APIResponseWebhook {
|
|
145
|
+
/**
|
|
146
|
+
* The response data (null if error)
|
|
147
|
+
*/
|
|
148
|
+
data?: WebhookResponse | null;
|
|
149
|
+
/**
|
|
150
|
+
* Error information
|
|
151
|
+
*/
|
|
152
|
+
error?: ErrorDetail | null;
|
|
153
|
+
/**
|
|
154
|
+
* Request and response metadata
|
|
155
|
+
*/
|
|
156
|
+
meta?: APIMeta;
|
|
157
|
+
/**
|
|
158
|
+
* Indicates whether the request was successful
|
|
159
|
+
*/
|
|
160
|
+
success?: boolean;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Error information
|
|
164
|
+
*/
|
|
165
|
+
export interface ErrorDetail {
|
|
166
|
+
/**
|
|
167
|
+
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
168
|
+
*/
|
|
169
|
+
code?: string;
|
|
170
|
+
/**
|
|
171
|
+
* Additional validation error details (field-level errors)
|
|
172
|
+
*/
|
|
173
|
+
details?: {
|
|
174
|
+
[key: string]: Array<string>;
|
|
175
|
+
} | null;
|
|
176
|
+
/**
|
|
177
|
+
* URL to documentation about this error
|
|
178
|
+
*/
|
|
179
|
+
doc_url?: string | null;
|
|
180
|
+
/**
|
|
181
|
+
* Human-readable error message
|
|
182
|
+
*/
|
|
183
|
+
message?: string;
|
|
122
184
|
}
|
|
123
185
|
/**
|
|
124
186
|
* The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
|
|
@@ -153,6 +215,14 @@ export interface InboundMessageEvent {
|
|
|
153
215
|
* numbers.
|
|
154
216
|
*/
|
|
155
217
|
export interface InboundMessageEventPayload {
|
|
218
|
+
/**
|
|
219
|
+
* The contact's number in E.164 format, meaning the number the message came from.
|
|
220
|
+
*/
|
|
221
|
+
inbound_number: string;
|
|
222
|
+
/**
|
|
223
|
+
* When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
|
|
224
|
+
*/
|
|
225
|
+
received_at: string;
|
|
156
226
|
/**
|
|
157
227
|
* The account the message belongs to.
|
|
158
228
|
*/
|
|
@@ -161,10 +231,6 @@ export interface InboundMessageEventPayload {
|
|
|
161
231
|
* The channel the message arrived on, for example sms or whatsapp.
|
|
162
232
|
*/
|
|
163
233
|
channel?: string;
|
|
164
|
-
/**
|
|
165
|
-
* The contact's number in E.164 format, meaning the number the message came from.
|
|
166
|
-
*/
|
|
167
|
-
inbound_number?: string;
|
|
168
234
|
/**
|
|
169
235
|
* The inbound message.
|
|
170
236
|
*/
|
|
@@ -173,10 +239,6 @@ export interface InboundMessageEventPayload {
|
|
|
173
239
|
* Your number in E.164 format, meaning the number the message was addressed to.
|
|
174
240
|
*/
|
|
175
241
|
outbound_number?: string;
|
|
176
|
-
/**
|
|
177
|
-
* When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
|
|
178
|
-
*/
|
|
179
|
-
received_at?: string;
|
|
180
242
|
/**
|
|
181
243
|
* The message body. Sent as null when the inbound message carried no text, for
|
|
182
244
|
* example a media-only message. The field is always present, so read it and check
|
|
@@ -224,6 +286,12 @@ export interface MessageEvent {
|
|
|
224
286
|
* status.
|
|
225
287
|
*/
|
|
226
288
|
export interface MessageEventPayload {
|
|
289
|
+
/**
|
|
290
|
+
* The status the message just reached, for example SENT, DELIVERED, or FAILED.
|
|
291
|
+
* Sent means dispatched and delivered means confirmed, so treat them as distinct
|
|
292
|
+
* outcomes.
|
|
293
|
+
*/
|
|
294
|
+
message_status: string;
|
|
227
295
|
/**
|
|
228
296
|
* The account the message belongs to.
|
|
229
297
|
*/
|
|
@@ -242,12 +310,6 @@ export interface MessageEventPayload {
|
|
|
242
310
|
* lifecycle, so use it to correlate them.
|
|
243
311
|
*/
|
|
244
312
|
message_id?: string;
|
|
245
|
-
/**
|
|
246
|
-
* The status the message just reached, for example SENT, DELIVERED, or FAILED.
|
|
247
|
-
* Sent means dispatched and delivered means confirmed, so treat them as distinct
|
|
248
|
-
* outcomes.
|
|
249
|
-
*/
|
|
250
|
-
message_status?: string;
|
|
251
313
|
/**
|
|
252
314
|
* The recipient's number in E.164 format.
|
|
253
315
|
*/
|
|
@@ -266,6 +328,57 @@ export interface MessageEventPayload {
|
|
|
266
328
|
*/
|
|
267
329
|
updated_at?: string;
|
|
268
330
|
}
|
|
331
|
+
export interface MutationRequest {
|
|
332
|
+
/**
|
|
333
|
+
* Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
334
|
+
* for testing integrations without actual execution
|
|
335
|
+
*/
|
|
336
|
+
sandbox?: boolean;
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* Pagination metadata for list responses
|
|
340
|
+
*/
|
|
341
|
+
export interface PaginationMeta {
|
|
342
|
+
/**
|
|
343
|
+
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
344
|
+
*/
|
|
345
|
+
cursors?: PaginationMeta.Cursors | null;
|
|
346
|
+
/**
|
|
347
|
+
* Whether there are more pages after this one
|
|
348
|
+
*/
|
|
349
|
+
has_more?: boolean;
|
|
350
|
+
/**
|
|
351
|
+
* Current page number (1-indexed)
|
|
352
|
+
*/
|
|
353
|
+
page?: number;
|
|
354
|
+
/**
|
|
355
|
+
* Number of items per page
|
|
356
|
+
*/
|
|
357
|
+
page_size?: number;
|
|
358
|
+
/**
|
|
359
|
+
* Total number of items across all pages
|
|
360
|
+
*/
|
|
361
|
+
total_count?: number;
|
|
362
|
+
/**
|
|
363
|
+
* Total number of pages
|
|
364
|
+
*/
|
|
365
|
+
total_pages?: number;
|
|
366
|
+
}
|
|
367
|
+
export declare namespace PaginationMeta {
|
|
368
|
+
/**
|
|
369
|
+
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
370
|
+
*/
|
|
371
|
+
interface Cursors {
|
|
372
|
+
/**
|
|
373
|
+
* Cursor to fetch the next page.
|
|
374
|
+
*/
|
|
375
|
+
after?: string | null;
|
|
376
|
+
/**
|
|
377
|
+
* Cursor to fetch the previous page.
|
|
378
|
+
*/
|
|
379
|
+
before?: string | null;
|
|
380
|
+
}
|
|
381
|
+
}
|
|
269
382
|
/**
|
|
270
383
|
* The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
|
|
271
384
|
* this shape and varies only in Payload.
|
|
@@ -299,6 +412,15 @@ export interface TemplateEvent {
|
|
|
299
412
|
* changes, so you can react without polling.
|
|
300
413
|
*/
|
|
301
414
|
export interface TemplateEventPayload {
|
|
415
|
+
/**
|
|
416
|
+
* The review status the template just reached, for example APPROVED or REJECTED.
|
|
417
|
+
*/
|
|
418
|
+
status: string;
|
|
419
|
+
/**
|
|
420
|
+
* The template's identifier with Meta, assigned when the template is submitted for
|
|
421
|
+
* review.
|
|
422
|
+
*/
|
|
423
|
+
whatsapp_template_id: string;
|
|
302
424
|
/**
|
|
303
425
|
* The account the template belongs to.
|
|
304
426
|
*/
|
|
@@ -320,10 +442,6 @@ export interface TemplateEventPayload {
|
|
|
320
442
|
* rejection.
|
|
321
443
|
*/
|
|
322
444
|
reason?: string | null;
|
|
323
|
-
/**
|
|
324
|
-
* The review status the template just reached, for example APPROVED or REJECTED.
|
|
325
|
-
*/
|
|
326
|
-
status?: string;
|
|
327
445
|
/**
|
|
328
446
|
* The template in Sent.
|
|
329
447
|
*/
|
|
@@ -332,278 +450,37 @@ export interface TemplateEventPayload {
|
|
|
332
450
|
* The template's display name.
|
|
333
451
|
*/
|
|
334
452
|
template_name?: string;
|
|
335
|
-
/**
|
|
336
|
-
* The template's identifier with Meta, assigned when the template is submitted for
|
|
337
|
-
* review.
|
|
338
|
-
*/
|
|
339
|
-
whatsapp_template_id?: string;
|
|
340
|
-
}
|
|
341
|
-
/**
|
|
342
|
-
* Standard API response envelope for all v3 endpoints
|
|
343
|
-
*/
|
|
344
|
-
export interface WebhookCreateResponse {
|
|
345
|
-
/**
|
|
346
|
-
* The response data (null if error)
|
|
347
|
-
*/
|
|
348
|
-
data?: WebhookCreateResponse.Data | null;
|
|
349
|
-
/**
|
|
350
|
-
* Error information
|
|
351
|
-
*/
|
|
352
|
-
error?: WebhookCreateResponse.Error | null;
|
|
353
|
-
/**
|
|
354
|
-
* Request and response metadata
|
|
355
|
-
*/
|
|
356
|
-
meta?: WebhookCreateResponse.Meta;
|
|
357
|
-
/**
|
|
358
|
-
* Indicates whether the request was successful
|
|
359
|
-
*/
|
|
360
|
-
success?: boolean;
|
|
361
453
|
}
|
|
362
|
-
export
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
created_at?: string;
|
|
370
|
-
/**
|
|
371
|
-
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
372
|
-
* Says whose resource this is, which the resource's own id does not.
|
|
373
|
-
*/
|
|
374
|
-
customer_id?: string;
|
|
375
|
-
display_name?: string;
|
|
376
|
-
endpoint_url?: string;
|
|
377
|
-
event_filters?: {
|
|
378
|
-
[key: string]: Array<string>;
|
|
379
|
-
} | null;
|
|
380
|
-
event_types?: Array<string>;
|
|
381
|
-
is_active?: boolean;
|
|
382
|
-
last_delivery_attempt_at?: string | null;
|
|
383
|
-
last_successful_delivery_at?: string | null;
|
|
384
|
-
retry_count?: number;
|
|
385
|
-
signing_secret?: string | null;
|
|
386
|
-
timeout_seconds?: number;
|
|
387
|
-
updated_at?: string | null;
|
|
388
|
-
}
|
|
389
|
-
/**
|
|
390
|
-
* Error information
|
|
391
|
-
*/
|
|
392
|
-
interface Error {
|
|
393
|
-
/**
|
|
394
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
395
|
-
*/
|
|
396
|
-
code?: string;
|
|
397
|
-
/**
|
|
398
|
-
* Additional validation error details (field-level errors)
|
|
399
|
-
*/
|
|
400
|
-
details?: {
|
|
401
|
-
[key: string]: Array<string>;
|
|
402
|
-
} | null;
|
|
403
|
-
/**
|
|
404
|
-
* URL to documentation about this error
|
|
405
|
-
*/
|
|
406
|
-
doc_url?: string | null;
|
|
407
|
-
/**
|
|
408
|
-
* Human-readable error message
|
|
409
|
-
*/
|
|
410
|
-
message?: string;
|
|
411
|
-
}
|
|
412
|
-
/**
|
|
413
|
-
* Request and response metadata
|
|
414
|
-
*/
|
|
415
|
-
interface Meta {
|
|
416
|
-
/**
|
|
417
|
-
* Unique identifier for this request (for tracing and support)
|
|
418
|
-
*/
|
|
419
|
-
request_id?: string;
|
|
420
|
-
/**
|
|
421
|
-
* Server timestamp when the response was generated
|
|
422
|
-
*/
|
|
423
|
-
timestamp?: string;
|
|
424
|
-
/**
|
|
425
|
-
* API version used for this request
|
|
426
|
-
*/
|
|
427
|
-
version?: string;
|
|
428
|
-
}
|
|
429
|
-
}
|
|
430
|
-
/**
|
|
431
|
-
* Standard API response envelope for all v3 endpoints
|
|
432
|
-
*/
|
|
433
|
-
export interface WebhookRetrieveResponse {
|
|
434
|
-
/**
|
|
435
|
-
* The response data (null if error)
|
|
436
|
-
*/
|
|
437
|
-
data?: WebhookRetrieveResponse.Data | null;
|
|
438
|
-
/**
|
|
439
|
-
* Error information
|
|
440
|
-
*/
|
|
441
|
-
error?: WebhookRetrieveResponse.Error | null;
|
|
442
|
-
/**
|
|
443
|
-
* Request and response metadata
|
|
444
|
-
*/
|
|
445
|
-
meta?: WebhookRetrieveResponse.Meta;
|
|
446
|
-
/**
|
|
447
|
-
* Indicates whether the request was successful
|
|
448
|
-
*/
|
|
449
|
-
success?: boolean;
|
|
450
|
-
}
|
|
451
|
-
export declare namespace WebhookRetrieveResponse {
|
|
452
|
-
/**
|
|
453
|
-
* The response data (null if error)
|
|
454
|
-
*/
|
|
455
|
-
interface Data {
|
|
456
|
-
id?: string;
|
|
457
|
-
consecutive_failures?: number;
|
|
458
|
-
created_at?: string;
|
|
459
|
-
/**
|
|
460
|
-
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
461
|
-
* Says whose resource this is, which the resource's own id does not.
|
|
462
|
-
*/
|
|
463
|
-
customer_id?: string;
|
|
464
|
-
display_name?: string;
|
|
465
|
-
endpoint_url?: string;
|
|
466
|
-
event_filters?: {
|
|
467
|
-
[key: string]: Array<string>;
|
|
468
|
-
} | null;
|
|
469
|
-
event_types?: Array<string>;
|
|
470
|
-
is_active?: boolean;
|
|
471
|
-
last_delivery_attempt_at?: string | null;
|
|
472
|
-
last_successful_delivery_at?: string | null;
|
|
473
|
-
retry_count?: number;
|
|
474
|
-
signing_secret?: string | null;
|
|
475
|
-
timeout_seconds?: number;
|
|
476
|
-
updated_at?: string | null;
|
|
477
|
-
}
|
|
478
|
-
/**
|
|
479
|
-
* Error information
|
|
480
|
-
*/
|
|
481
|
-
interface Error {
|
|
482
|
-
/**
|
|
483
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
484
|
-
*/
|
|
485
|
-
code?: string;
|
|
486
|
-
/**
|
|
487
|
-
* Additional validation error details (field-level errors)
|
|
488
|
-
*/
|
|
489
|
-
details?: {
|
|
490
|
-
[key: string]: Array<string>;
|
|
491
|
-
} | null;
|
|
492
|
-
/**
|
|
493
|
-
* URL to documentation about this error
|
|
494
|
-
*/
|
|
495
|
-
doc_url?: string | null;
|
|
496
|
-
/**
|
|
497
|
-
* Human-readable error message
|
|
498
|
-
*/
|
|
499
|
-
message?: string;
|
|
500
|
-
}
|
|
501
|
-
/**
|
|
502
|
-
* Request and response metadata
|
|
503
|
-
*/
|
|
504
|
-
interface Meta {
|
|
505
|
-
/**
|
|
506
|
-
* Unique identifier for this request (for tracing and support)
|
|
507
|
-
*/
|
|
508
|
-
request_id?: string;
|
|
509
|
-
/**
|
|
510
|
-
* Server timestamp when the response was generated
|
|
511
|
-
*/
|
|
512
|
-
timestamp?: string;
|
|
513
|
-
/**
|
|
514
|
-
* API version used for this request
|
|
515
|
-
*/
|
|
516
|
-
version?: string;
|
|
517
|
-
}
|
|
518
|
-
}
|
|
519
|
-
/**
|
|
520
|
-
* Standard API response envelope for all v3 endpoints
|
|
521
|
-
*/
|
|
522
|
-
export interface WebhookUpdateResponse {
|
|
523
|
-
/**
|
|
524
|
-
* The response data (null if error)
|
|
525
|
-
*/
|
|
526
|
-
data?: WebhookUpdateResponse.Data | null;
|
|
527
|
-
/**
|
|
528
|
-
* Error information
|
|
529
|
-
*/
|
|
530
|
-
error?: WebhookUpdateResponse.Error | null;
|
|
531
|
-
/**
|
|
532
|
-
* Request and response metadata
|
|
533
|
-
*/
|
|
534
|
-
meta?: WebhookUpdateResponse.Meta;
|
|
535
|
-
/**
|
|
536
|
-
* Indicates whether the request was successful
|
|
537
|
-
*/
|
|
538
|
-
success?: boolean;
|
|
454
|
+
export interface WebhookEventType {
|
|
455
|
+
description?: string | null;
|
|
456
|
+
display_name?: string;
|
|
457
|
+
event_type?: string | null;
|
|
458
|
+
is_active?: boolean;
|
|
459
|
+
name?: string;
|
|
460
|
+
sub_types?: Array<WebhookEventType> | null;
|
|
539
461
|
}
|
|
540
|
-
export
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
interface Data {
|
|
545
|
-
id?: string;
|
|
546
|
-
consecutive_failures?: number;
|
|
547
|
-
created_at?: string;
|
|
548
|
-
/**
|
|
549
|
-
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
550
|
-
* Says whose resource this is, which the resource's own id does not.
|
|
551
|
-
*/
|
|
552
|
-
customer_id?: string;
|
|
553
|
-
display_name?: string;
|
|
554
|
-
endpoint_url?: string;
|
|
555
|
-
event_filters?: {
|
|
556
|
-
[key: string]: Array<string>;
|
|
557
|
-
} | null;
|
|
558
|
-
event_types?: Array<string>;
|
|
559
|
-
is_active?: boolean;
|
|
560
|
-
last_delivery_attempt_at?: string | null;
|
|
561
|
-
last_successful_delivery_at?: string | null;
|
|
562
|
-
retry_count?: number;
|
|
563
|
-
signing_secret?: string | null;
|
|
564
|
-
timeout_seconds?: number;
|
|
565
|
-
updated_at?: string | null;
|
|
566
|
-
}
|
|
567
|
-
/**
|
|
568
|
-
* Error information
|
|
569
|
-
*/
|
|
570
|
-
interface Error {
|
|
571
|
-
/**
|
|
572
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
573
|
-
*/
|
|
574
|
-
code?: string;
|
|
575
|
-
/**
|
|
576
|
-
* Additional validation error details (field-level errors)
|
|
577
|
-
*/
|
|
578
|
-
details?: {
|
|
579
|
-
[key: string]: Array<string>;
|
|
580
|
-
} | null;
|
|
581
|
-
/**
|
|
582
|
-
* URL to documentation about this error
|
|
583
|
-
*/
|
|
584
|
-
doc_url?: string | null;
|
|
585
|
-
/**
|
|
586
|
-
* Human-readable error message
|
|
587
|
-
*/
|
|
588
|
-
message?: string;
|
|
589
|
-
}
|
|
462
|
+
export interface WebhookResponse {
|
|
463
|
+
id?: string;
|
|
464
|
+
consecutive_failures?: number;
|
|
465
|
+
created_at?: string;
|
|
590
466
|
/**
|
|
591
|
-
*
|
|
467
|
+
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
468
|
+
* Says whose resource this is, which the resource's own id does not.
|
|
592
469
|
*/
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
470
|
+
customer_id?: string;
|
|
471
|
+
display_name?: string;
|
|
472
|
+
endpoint_url?: string;
|
|
473
|
+
event_filters?: {
|
|
474
|
+
[key: string]: Array<string>;
|
|
475
|
+
} | null;
|
|
476
|
+
event_types?: Array<string>;
|
|
477
|
+
is_active?: boolean;
|
|
478
|
+
last_delivery_attempt_at?: string | null;
|
|
479
|
+
last_successful_delivery_at?: string | null;
|
|
480
|
+
retry_count?: number;
|
|
481
|
+
signing_secret?: string | null;
|
|
482
|
+
timeout_seconds?: number;
|
|
483
|
+
updated_at?: string | null;
|
|
607
484
|
}
|
|
608
485
|
/**
|
|
609
486
|
* Standard API response envelope for all v3 endpoints
|
|
@@ -616,11 +493,11 @@ export interface WebhookListResponse {
|
|
|
616
493
|
/**
|
|
617
494
|
* Error information
|
|
618
495
|
*/
|
|
619
|
-
error?:
|
|
496
|
+
error?: ErrorDetail | null;
|
|
620
497
|
/**
|
|
621
498
|
* Request and response metadata
|
|
622
499
|
*/
|
|
623
|
-
meta?:
|
|
500
|
+
meta?: APIMeta;
|
|
624
501
|
/**
|
|
625
502
|
* Indicates whether the request was successful
|
|
626
503
|
*/
|
|
@@ -634,120 +511,11 @@ export declare namespace WebhookListResponse {
|
|
|
634
511
|
/**
|
|
635
512
|
* Pagination metadata for list responses
|
|
636
513
|
*/
|
|
637
|
-
pagination?:
|
|
514
|
+
pagination?: WebhooksAPI.PaginationMeta;
|
|
638
515
|
/**
|
|
639
516
|
* The webhooks on this page.
|
|
640
517
|
*/
|
|
641
|
-
webhooks?: Array<
|
|
642
|
-
}
|
|
643
|
-
namespace Data {
|
|
644
|
-
/**
|
|
645
|
-
* Pagination metadata for list responses
|
|
646
|
-
*/
|
|
647
|
-
interface Pagination {
|
|
648
|
-
/**
|
|
649
|
-
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
650
|
-
*/
|
|
651
|
-
cursors?: Pagination.Cursors | null;
|
|
652
|
-
/**
|
|
653
|
-
* Whether there are more pages after this one
|
|
654
|
-
*/
|
|
655
|
-
has_more?: boolean;
|
|
656
|
-
/**
|
|
657
|
-
* Current page number (1-indexed)
|
|
658
|
-
*/
|
|
659
|
-
page?: number;
|
|
660
|
-
/**
|
|
661
|
-
* Number of items per page
|
|
662
|
-
*/
|
|
663
|
-
page_size?: number;
|
|
664
|
-
/**
|
|
665
|
-
* Total number of items across all pages
|
|
666
|
-
*/
|
|
667
|
-
total_count?: number;
|
|
668
|
-
/**
|
|
669
|
-
* Total number of pages
|
|
670
|
-
*/
|
|
671
|
-
total_pages?: number;
|
|
672
|
-
}
|
|
673
|
-
namespace Pagination {
|
|
674
|
-
/**
|
|
675
|
-
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
676
|
-
*/
|
|
677
|
-
interface Cursors {
|
|
678
|
-
/**
|
|
679
|
-
* Cursor to fetch the next page.
|
|
680
|
-
*/
|
|
681
|
-
after?: string | null;
|
|
682
|
-
/**
|
|
683
|
-
* Cursor to fetch the previous page.
|
|
684
|
-
*/
|
|
685
|
-
before?: string | null;
|
|
686
|
-
}
|
|
687
|
-
}
|
|
688
|
-
interface Webhook {
|
|
689
|
-
id?: string;
|
|
690
|
-
consecutive_failures?: number;
|
|
691
|
-
created_at?: string;
|
|
692
|
-
/**
|
|
693
|
-
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
694
|
-
* Says whose resource this is, which the resource's own id does not.
|
|
695
|
-
*/
|
|
696
|
-
customer_id?: string;
|
|
697
|
-
display_name?: string;
|
|
698
|
-
endpoint_url?: string;
|
|
699
|
-
event_filters?: {
|
|
700
|
-
[key: string]: Array<string>;
|
|
701
|
-
} | null;
|
|
702
|
-
event_types?: Array<string>;
|
|
703
|
-
is_active?: boolean;
|
|
704
|
-
last_delivery_attempt_at?: string | null;
|
|
705
|
-
last_successful_delivery_at?: string | null;
|
|
706
|
-
retry_count?: number;
|
|
707
|
-
signing_secret?: string | null;
|
|
708
|
-
timeout_seconds?: number;
|
|
709
|
-
updated_at?: string | null;
|
|
710
|
-
}
|
|
711
|
-
}
|
|
712
|
-
/**
|
|
713
|
-
* Error information
|
|
714
|
-
*/
|
|
715
|
-
interface Error {
|
|
716
|
-
/**
|
|
717
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
718
|
-
*/
|
|
719
|
-
code?: string;
|
|
720
|
-
/**
|
|
721
|
-
* Additional validation error details (field-level errors)
|
|
722
|
-
*/
|
|
723
|
-
details?: {
|
|
724
|
-
[key: string]: Array<string>;
|
|
725
|
-
} | null;
|
|
726
|
-
/**
|
|
727
|
-
* URL to documentation about this error
|
|
728
|
-
*/
|
|
729
|
-
doc_url?: string | null;
|
|
730
|
-
/**
|
|
731
|
-
* Human-readable error message
|
|
732
|
-
*/
|
|
733
|
-
message?: string;
|
|
734
|
-
}
|
|
735
|
-
/**
|
|
736
|
-
* Request and response metadata
|
|
737
|
-
*/
|
|
738
|
-
interface Meta {
|
|
739
|
-
/**
|
|
740
|
-
* Unique identifier for this request (for tracing and support)
|
|
741
|
-
*/
|
|
742
|
-
request_id?: string;
|
|
743
|
-
/**
|
|
744
|
-
* Server timestamp when the response was generated
|
|
745
|
-
*/
|
|
746
|
-
timestamp?: string;
|
|
747
|
-
/**
|
|
748
|
-
* API version used for this request
|
|
749
|
-
*/
|
|
750
|
-
version?: string;
|
|
518
|
+
webhooks?: Array<WebhooksAPI.WebhookResponse>;
|
|
751
519
|
}
|
|
752
520
|
}
|
|
753
521
|
/**
|
|
@@ -761,11 +529,11 @@ export interface WebhookListEventTypesResponse {
|
|
|
761
529
|
/**
|
|
762
530
|
* Error information
|
|
763
531
|
*/
|
|
764
|
-
error?:
|
|
532
|
+
error?: ErrorDetail | null;
|
|
765
533
|
/**
|
|
766
534
|
* Request and response metadata
|
|
767
535
|
*/
|
|
768
|
-
meta?:
|
|
536
|
+
meta?: APIMeta;
|
|
769
537
|
/**
|
|
770
538
|
* Indicates whether the request was successful
|
|
771
539
|
*/
|
|
@@ -779,105 +547,11 @@ export declare namespace WebhookListEventTypesResponse {
|
|
|
779
547
|
/**
|
|
780
548
|
* The event_types on this page.
|
|
781
549
|
*/
|
|
782
|
-
event_types?: Array<
|
|
550
|
+
event_types?: Array<WebhooksAPI.WebhookEventType>;
|
|
783
551
|
/**
|
|
784
552
|
* Pagination metadata for list responses
|
|
785
553
|
*/
|
|
786
|
-
pagination?:
|
|
787
|
-
}
|
|
788
|
-
namespace Data {
|
|
789
|
-
interface EventType {
|
|
790
|
-
description?: string | null;
|
|
791
|
-
display_name?: string;
|
|
792
|
-
event_type?: string | null;
|
|
793
|
-
is_active?: boolean;
|
|
794
|
-
name?: string;
|
|
795
|
-
sub_types?: Array<unknown> | null;
|
|
796
|
-
}
|
|
797
|
-
/**
|
|
798
|
-
* Pagination metadata for list responses
|
|
799
|
-
*/
|
|
800
|
-
interface Pagination {
|
|
801
|
-
/**
|
|
802
|
-
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
803
|
-
*/
|
|
804
|
-
cursors?: Pagination.Cursors | null;
|
|
805
|
-
/**
|
|
806
|
-
* Whether there are more pages after this one
|
|
807
|
-
*/
|
|
808
|
-
has_more?: boolean;
|
|
809
|
-
/**
|
|
810
|
-
* Current page number (1-indexed)
|
|
811
|
-
*/
|
|
812
|
-
page?: number;
|
|
813
|
-
/**
|
|
814
|
-
* Number of items per page
|
|
815
|
-
*/
|
|
816
|
-
page_size?: number;
|
|
817
|
-
/**
|
|
818
|
-
* Total number of items across all pages
|
|
819
|
-
*/
|
|
820
|
-
total_count?: number;
|
|
821
|
-
/**
|
|
822
|
-
* Total number of pages
|
|
823
|
-
*/
|
|
824
|
-
total_pages?: number;
|
|
825
|
-
}
|
|
826
|
-
namespace Pagination {
|
|
827
|
-
/**
|
|
828
|
-
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
829
|
-
*/
|
|
830
|
-
interface Cursors {
|
|
831
|
-
/**
|
|
832
|
-
* Cursor to fetch the next page.
|
|
833
|
-
*/
|
|
834
|
-
after?: string | null;
|
|
835
|
-
/**
|
|
836
|
-
* Cursor to fetch the previous page.
|
|
837
|
-
*/
|
|
838
|
-
before?: string | null;
|
|
839
|
-
}
|
|
840
|
-
}
|
|
841
|
-
}
|
|
842
|
-
/**
|
|
843
|
-
* Error information
|
|
844
|
-
*/
|
|
845
|
-
interface Error {
|
|
846
|
-
/**
|
|
847
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
848
|
-
*/
|
|
849
|
-
code?: string;
|
|
850
|
-
/**
|
|
851
|
-
* Additional validation error details (field-level errors)
|
|
852
|
-
*/
|
|
853
|
-
details?: {
|
|
854
|
-
[key: string]: Array<string>;
|
|
855
|
-
} | null;
|
|
856
|
-
/**
|
|
857
|
-
* URL to documentation about this error
|
|
858
|
-
*/
|
|
859
|
-
doc_url?: string | null;
|
|
860
|
-
/**
|
|
861
|
-
* Human-readable error message
|
|
862
|
-
*/
|
|
863
|
-
message?: string;
|
|
864
|
-
}
|
|
865
|
-
/**
|
|
866
|
-
* Request and response metadata
|
|
867
|
-
*/
|
|
868
|
-
interface Meta {
|
|
869
|
-
/**
|
|
870
|
-
* Unique identifier for this request (for tracing and support)
|
|
871
|
-
*/
|
|
872
|
-
request_id?: string;
|
|
873
|
-
/**
|
|
874
|
-
* Server timestamp when the response was generated
|
|
875
|
-
*/
|
|
876
|
-
timestamp?: string;
|
|
877
|
-
/**
|
|
878
|
-
* API version used for this request
|
|
879
|
-
*/
|
|
880
|
-
version?: string;
|
|
554
|
+
pagination?: WebhooksAPI.PaginationMeta;
|
|
881
555
|
}
|
|
882
556
|
}
|
|
883
557
|
/**
|
|
@@ -891,11 +565,11 @@ export interface WebhookListEventsResponse {
|
|
|
891
565
|
/**
|
|
892
566
|
* Error information
|
|
893
567
|
*/
|
|
894
|
-
error?:
|
|
568
|
+
error?: ErrorDetail | null;
|
|
895
569
|
/**
|
|
896
570
|
* Request and response metadata
|
|
897
571
|
*/
|
|
898
|
-
meta?:
|
|
572
|
+
meta?: APIMeta;
|
|
899
573
|
/**
|
|
900
574
|
* Indicates whether the request was successful
|
|
901
575
|
*/
|
|
@@ -913,7 +587,7 @@ export declare namespace WebhookListEventsResponse {
|
|
|
913
587
|
/**
|
|
914
588
|
* Pagination metadata for list responses
|
|
915
589
|
*/
|
|
916
|
-
pagination?:
|
|
590
|
+
pagination?: WebhooksAPI.PaginationMeta;
|
|
917
591
|
}
|
|
918
592
|
namespace Data {
|
|
919
593
|
interface Event {
|
|
@@ -935,90 +609,6 @@ export declare namespace WebhookListEventsResponse {
|
|
|
935
609
|
processing_started_at?: string | null;
|
|
936
610
|
response_body?: string | null;
|
|
937
611
|
}
|
|
938
|
-
/**
|
|
939
|
-
* Pagination metadata for list responses
|
|
940
|
-
*/
|
|
941
|
-
interface Pagination {
|
|
942
|
-
/**
|
|
943
|
-
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
944
|
-
*/
|
|
945
|
-
cursors?: Pagination.Cursors | null;
|
|
946
|
-
/**
|
|
947
|
-
* Whether there are more pages after this one
|
|
948
|
-
*/
|
|
949
|
-
has_more?: boolean;
|
|
950
|
-
/**
|
|
951
|
-
* Current page number (1-indexed)
|
|
952
|
-
*/
|
|
953
|
-
page?: number;
|
|
954
|
-
/**
|
|
955
|
-
* Number of items per page
|
|
956
|
-
*/
|
|
957
|
-
page_size?: number;
|
|
958
|
-
/**
|
|
959
|
-
* Total number of items across all pages
|
|
960
|
-
*/
|
|
961
|
-
total_count?: number;
|
|
962
|
-
/**
|
|
963
|
-
* Total number of pages
|
|
964
|
-
*/
|
|
965
|
-
total_pages?: number;
|
|
966
|
-
}
|
|
967
|
-
namespace Pagination {
|
|
968
|
-
/**
|
|
969
|
-
* @deprecated Cursor-based pagination. Never populated — see Cursors.
|
|
970
|
-
*/
|
|
971
|
-
interface Cursors {
|
|
972
|
-
/**
|
|
973
|
-
* Cursor to fetch the next page.
|
|
974
|
-
*/
|
|
975
|
-
after?: string | null;
|
|
976
|
-
/**
|
|
977
|
-
* Cursor to fetch the previous page.
|
|
978
|
-
*/
|
|
979
|
-
before?: string | null;
|
|
980
|
-
}
|
|
981
|
-
}
|
|
982
|
-
}
|
|
983
|
-
/**
|
|
984
|
-
* Error information
|
|
985
|
-
*/
|
|
986
|
-
interface Error {
|
|
987
|
-
/**
|
|
988
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
989
|
-
*/
|
|
990
|
-
code?: string;
|
|
991
|
-
/**
|
|
992
|
-
* Additional validation error details (field-level errors)
|
|
993
|
-
*/
|
|
994
|
-
details?: {
|
|
995
|
-
[key: string]: Array<string>;
|
|
996
|
-
} | null;
|
|
997
|
-
/**
|
|
998
|
-
* URL to documentation about this error
|
|
999
|
-
*/
|
|
1000
|
-
doc_url?: string | null;
|
|
1001
|
-
/**
|
|
1002
|
-
* Human-readable error message
|
|
1003
|
-
*/
|
|
1004
|
-
message?: string;
|
|
1005
|
-
}
|
|
1006
|
-
/**
|
|
1007
|
-
* Request and response metadata
|
|
1008
|
-
*/
|
|
1009
|
-
interface Meta {
|
|
1010
|
-
/**
|
|
1011
|
-
* Unique identifier for this request (for tracing and support)
|
|
1012
|
-
*/
|
|
1013
|
-
request_id?: string;
|
|
1014
|
-
/**
|
|
1015
|
-
* Server timestamp when the response was generated
|
|
1016
|
-
*/
|
|
1017
|
-
timestamp?: string;
|
|
1018
|
-
/**
|
|
1019
|
-
* API version used for this request
|
|
1020
|
-
*/
|
|
1021
|
-
version?: string;
|
|
1022
612
|
}
|
|
1023
613
|
}
|
|
1024
614
|
/**
|
|
@@ -1032,11 +622,11 @@ export interface WebhookRotateSecretResponse {
|
|
|
1032
622
|
/**
|
|
1033
623
|
* Error information
|
|
1034
624
|
*/
|
|
1035
|
-
error?:
|
|
625
|
+
error?: ErrorDetail | null;
|
|
1036
626
|
/**
|
|
1037
627
|
* Request and response metadata
|
|
1038
628
|
*/
|
|
1039
|
-
meta?:
|
|
629
|
+
meta?: APIMeta;
|
|
1040
630
|
/**
|
|
1041
631
|
* Indicates whether the request was successful
|
|
1042
632
|
*/
|
|
@@ -1049,46 +639,6 @@ export declare namespace WebhookRotateSecretResponse {
|
|
|
1049
639
|
interface Data {
|
|
1050
640
|
signing_secret?: string;
|
|
1051
641
|
}
|
|
1052
|
-
/**
|
|
1053
|
-
* Error information
|
|
1054
|
-
*/
|
|
1055
|
-
interface Error {
|
|
1056
|
-
/**
|
|
1057
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
1058
|
-
*/
|
|
1059
|
-
code?: string;
|
|
1060
|
-
/**
|
|
1061
|
-
* Additional validation error details (field-level errors)
|
|
1062
|
-
*/
|
|
1063
|
-
details?: {
|
|
1064
|
-
[key: string]: Array<string>;
|
|
1065
|
-
} | null;
|
|
1066
|
-
/**
|
|
1067
|
-
* URL to documentation about this error
|
|
1068
|
-
*/
|
|
1069
|
-
doc_url?: string | null;
|
|
1070
|
-
/**
|
|
1071
|
-
* Human-readable error message
|
|
1072
|
-
*/
|
|
1073
|
-
message?: string;
|
|
1074
|
-
}
|
|
1075
|
-
/**
|
|
1076
|
-
* Request and response metadata
|
|
1077
|
-
*/
|
|
1078
|
-
interface Meta {
|
|
1079
|
-
/**
|
|
1080
|
-
* Unique identifier for this request (for tracing and support)
|
|
1081
|
-
*/
|
|
1082
|
-
request_id?: string;
|
|
1083
|
-
/**
|
|
1084
|
-
* Server timestamp when the response was generated
|
|
1085
|
-
*/
|
|
1086
|
-
timestamp?: string;
|
|
1087
|
-
/**
|
|
1088
|
-
* API version used for this request
|
|
1089
|
-
*/
|
|
1090
|
-
version?: string;
|
|
1091
|
-
}
|
|
1092
642
|
}
|
|
1093
643
|
/**
|
|
1094
644
|
* Standard API response envelope for all v3 endpoints
|
|
@@ -1101,11 +651,11 @@ export interface WebhookTestResponse {
|
|
|
1101
651
|
/**
|
|
1102
652
|
* Error information
|
|
1103
653
|
*/
|
|
1104
|
-
error?:
|
|
654
|
+
error?: ErrorDetail | null;
|
|
1105
655
|
/**
|
|
1106
656
|
* Request and response metadata
|
|
1107
657
|
*/
|
|
1108
|
-
meta?:
|
|
658
|
+
meta?: APIMeta;
|
|
1109
659
|
/**
|
|
1110
660
|
* Indicates whether the request was successful
|
|
1111
661
|
*/
|
|
@@ -1119,135 +669,6 @@ export declare namespace WebhookTestResponse {
|
|
|
1119
669
|
message?: string;
|
|
1120
670
|
success?: boolean;
|
|
1121
671
|
}
|
|
1122
|
-
/**
|
|
1123
|
-
* Error information
|
|
1124
|
-
*/
|
|
1125
|
-
interface Error {
|
|
1126
|
-
/**
|
|
1127
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
1128
|
-
*/
|
|
1129
|
-
code?: string;
|
|
1130
|
-
/**
|
|
1131
|
-
* Additional validation error details (field-level errors)
|
|
1132
|
-
*/
|
|
1133
|
-
details?: {
|
|
1134
|
-
[key: string]: Array<string>;
|
|
1135
|
-
} | null;
|
|
1136
|
-
/**
|
|
1137
|
-
* URL to documentation about this error
|
|
1138
|
-
*/
|
|
1139
|
-
doc_url?: string | null;
|
|
1140
|
-
/**
|
|
1141
|
-
* Human-readable error message
|
|
1142
|
-
*/
|
|
1143
|
-
message?: string;
|
|
1144
|
-
}
|
|
1145
|
-
/**
|
|
1146
|
-
* Request and response metadata
|
|
1147
|
-
*/
|
|
1148
|
-
interface Meta {
|
|
1149
|
-
/**
|
|
1150
|
-
* Unique identifier for this request (for tracing and support)
|
|
1151
|
-
*/
|
|
1152
|
-
request_id?: string;
|
|
1153
|
-
/**
|
|
1154
|
-
* Server timestamp when the response was generated
|
|
1155
|
-
*/
|
|
1156
|
-
timestamp?: string;
|
|
1157
|
-
/**
|
|
1158
|
-
* API version used for this request
|
|
1159
|
-
*/
|
|
1160
|
-
version?: string;
|
|
1161
|
-
}
|
|
1162
|
-
}
|
|
1163
|
-
/**
|
|
1164
|
-
* Standard API response envelope for all v3 endpoints
|
|
1165
|
-
*/
|
|
1166
|
-
export interface WebhookToggleStatusResponse {
|
|
1167
|
-
/**
|
|
1168
|
-
* The response data (null if error)
|
|
1169
|
-
*/
|
|
1170
|
-
data?: WebhookToggleStatusResponse.Data | null;
|
|
1171
|
-
/**
|
|
1172
|
-
* Error information
|
|
1173
|
-
*/
|
|
1174
|
-
error?: WebhookToggleStatusResponse.Error | null;
|
|
1175
|
-
/**
|
|
1176
|
-
* Request and response metadata
|
|
1177
|
-
*/
|
|
1178
|
-
meta?: WebhookToggleStatusResponse.Meta;
|
|
1179
|
-
/**
|
|
1180
|
-
* Indicates whether the request was successful
|
|
1181
|
-
*/
|
|
1182
|
-
success?: boolean;
|
|
1183
|
-
}
|
|
1184
|
-
export declare namespace WebhookToggleStatusResponse {
|
|
1185
|
-
/**
|
|
1186
|
-
* The response data (null if error)
|
|
1187
|
-
*/
|
|
1188
|
-
interface Data {
|
|
1189
|
-
id?: string;
|
|
1190
|
-
consecutive_failures?: number;
|
|
1191
|
-
created_at?: string;
|
|
1192
|
-
/**
|
|
1193
|
-
* Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
1194
|
-
* Says whose resource this is, which the resource's own id does not.
|
|
1195
|
-
*/
|
|
1196
|
-
customer_id?: string;
|
|
1197
|
-
display_name?: string;
|
|
1198
|
-
endpoint_url?: string;
|
|
1199
|
-
event_filters?: {
|
|
1200
|
-
[key: string]: Array<string>;
|
|
1201
|
-
} | null;
|
|
1202
|
-
event_types?: Array<string>;
|
|
1203
|
-
is_active?: boolean;
|
|
1204
|
-
last_delivery_attempt_at?: string | null;
|
|
1205
|
-
last_successful_delivery_at?: string | null;
|
|
1206
|
-
retry_count?: number;
|
|
1207
|
-
signing_secret?: string | null;
|
|
1208
|
-
timeout_seconds?: number;
|
|
1209
|
-
updated_at?: string | null;
|
|
1210
|
-
}
|
|
1211
|
-
/**
|
|
1212
|
-
* Error information
|
|
1213
|
-
*/
|
|
1214
|
-
interface Error {
|
|
1215
|
-
/**
|
|
1216
|
-
* Machine-readable error code (e.g., "RESOURCE_001")
|
|
1217
|
-
*/
|
|
1218
|
-
code?: string;
|
|
1219
|
-
/**
|
|
1220
|
-
* Additional validation error details (field-level errors)
|
|
1221
|
-
*/
|
|
1222
|
-
details?: {
|
|
1223
|
-
[key: string]: Array<string>;
|
|
1224
|
-
} | null;
|
|
1225
|
-
/**
|
|
1226
|
-
* URL to documentation about this error
|
|
1227
|
-
*/
|
|
1228
|
-
doc_url?: string | null;
|
|
1229
|
-
/**
|
|
1230
|
-
* Human-readable error message
|
|
1231
|
-
*/
|
|
1232
|
-
message?: string;
|
|
1233
|
-
}
|
|
1234
|
-
/**
|
|
1235
|
-
* Request and response metadata
|
|
1236
|
-
*/
|
|
1237
|
-
interface Meta {
|
|
1238
|
-
/**
|
|
1239
|
-
* Unique identifier for this request (for tracing and support)
|
|
1240
|
-
*/
|
|
1241
|
-
request_id?: string;
|
|
1242
|
-
/**
|
|
1243
|
-
* Server timestamp when the response was generated
|
|
1244
|
-
*/
|
|
1245
|
-
timestamp?: string;
|
|
1246
|
-
/**
|
|
1247
|
-
* API version used for this request
|
|
1248
|
-
*/
|
|
1249
|
-
version?: string;
|
|
1250
|
-
}
|
|
1251
672
|
}
|
|
1252
673
|
export interface WebhookCreateParams {
|
|
1253
674
|
/**
|
|
@@ -1470,6 +891,6 @@ export interface WebhookToggleStatusParams {
|
|
|
1470
891
|
'x-profile-id'?: string;
|
|
1471
892
|
}
|
|
1472
893
|
export declare namespace Webhooks {
|
|
1473
|
-
export { type InboundMessageEvent as InboundMessageEvent, type InboundMessageEventPayload as InboundMessageEventPayload, type MessageEvent as MessageEvent, type MessageEventPayload as MessageEventPayload, type
|
|
894
|
+
export { type APIMeta as APIMeta, type APIResponseWebhook as APIResponseWebhook, type ErrorDetail as ErrorDetail, type InboundMessageEvent as InboundMessageEvent, type InboundMessageEventPayload as InboundMessageEventPayload, type MessageEvent as MessageEvent, type MessageEventPayload as MessageEventPayload, type MutationRequest as MutationRequest, type PaginationMeta as PaginationMeta, type TemplateEvent as TemplateEvent, type TemplateEventPayload as TemplateEventPayload, type WebhookEventType as WebhookEventType, type WebhookResponse as WebhookResponse, type WebhookListResponse as WebhookListResponse, type WebhookListEventTypesResponse as WebhookListEventTypesResponse, type WebhookListEventsResponse as WebhookListEventsResponse, type WebhookRotateSecretResponse as WebhookRotateSecretResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookRetrieveParams as WebhookRetrieveParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, type WebhookDeleteParams as WebhookDeleteParams, type WebhookListEventTypesParams as WebhookListEventTypesParams, type WebhookListEventsParams as WebhookListEventsParams, type WebhookRotateSecretParams as WebhookRotateSecretParams, type WebhookTestParams as WebhookTestParams, type WebhookToggleStatusParams as WebhookToggleStatusParams, };
|
|
1474
895
|
}
|
|
1475
896
|
//# sourceMappingURL=webhooks.d.ts.map
|