@subscribeflow/sdk 1.0.5
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/README.md +379 -0
- package/dist/api-types.d.ts +4865 -0
- package/dist/api-types.d.ts.map +1 -0
- package/dist/api-types.js +6 -0
- package/dist/api-types.js.map +1 -0
- package/dist/index.d.ts +10313 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1029 -0
- package/dist/index.js.map +1 -0
- package/package.json +62 -0
|
@@ -0,0 +1,4865 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
"/health": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Liveness check
|
|
15
|
+
* @description Simple health check to verify the service is running.
|
|
16
|
+
*/
|
|
17
|
+
get: operations["health_health_get"];
|
|
18
|
+
put?: never;
|
|
19
|
+
post?: never;
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/ready": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Readiness check
|
|
35
|
+
* @description Comprehensive health check including database connectivity.
|
|
36
|
+
*/
|
|
37
|
+
get: operations["ready_ready_get"];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/info": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Application info
|
|
55
|
+
* @description Returns application metadata and configuration info.
|
|
56
|
+
*/
|
|
57
|
+
get: operations["info_info_get"];
|
|
58
|
+
put?: never;
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
66
|
+
"/webhooks/resend": {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
72
|
+
};
|
|
73
|
+
get?: never;
|
|
74
|
+
put?: never;
|
|
75
|
+
/**
|
|
76
|
+
* Receive Resend webhooks
|
|
77
|
+
* @description Endpoint for receiving webhooks from Resend.
|
|
78
|
+
*
|
|
79
|
+
* Supported event types:
|
|
80
|
+
* - `contact.created` - New contact created in Resend
|
|
81
|
+
* - `contact.updated` - Contact updated in Resend
|
|
82
|
+
* - `contact.deleted` - Contact deleted in Resend
|
|
83
|
+
* - `email.bounced` - Email bounced
|
|
84
|
+
* - `email.complained` - Spam complaint received
|
|
85
|
+
*
|
|
86
|
+
* The endpoint verifies:
|
|
87
|
+
* 1. HMAC SHA-256 signature (X-Resend-Signature header)
|
|
88
|
+
* 2. Timestamp is within 5 minutes (replay attack prevention)
|
|
89
|
+
* 3. Event ID is unique (idempotency)
|
|
90
|
+
*
|
|
91
|
+
* Note: Duplicate events return 200 OK to prevent unnecessary retries from Resend.
|
|
92
|
+
*/
|
|
93
|
+
post: operations["handle_resend_webhook_webhooks_resend_post"];
|
|
94
|
+
delete?: never;
|
|
95
|
+
options?: never;
|
|
96
|
+
head?: never;
|
|
97
|
+
patch?: never;
|
|
98
|
+
trace?: never;
|
|
99
|
+
};
|
|
100
|
+
"/preference-center": {
|
|
101
|
+
parameters: {
|
|
102
|
+
query?: never;
|
|
103
|
+
header?: never;
|
|
104
|
+
path?: never;
|
|
105
|
+
cookie?: never;
|
|
106
|
+
};
|
|
107
|
+
/**
|
|
108
|
+
* Get Preference Center
|
|
109
|
+
* @description Get the subscriber's current preferences and available tags.
|
|
110
|
+
*/
|
|
111
|
+
get: operations["get_preferences_preference_center_get"];
|
|
112
|
+
put?: never;
|
|
113
|
+
post?: never;
|
|
114
|
+
delete?: never;
|
|
115
|
+
options?: never;
|
|
116
|
+
head?: never;
|
|
117
|
+
patch?: never;
|
|
118
|
+
trace?: never;
|
|
119
|
+
};
|
|
120
|
+
"/preference-center/tags/{tag_id}": {
|
|
121
|
+
parameters: {
|
|
122
|
+
query?: never;
|
|
123
|
+
header?: never;
|
|
124
|
+
path?: never;
|
|
125
|
+
cookie?: never;
|
|
126
|
+
};
|
|
127
|
+
get?: never;
|
|
128
|
+
/**
|
|
129
|
+
* Subscribe to Tag
|
|
130
|
+
* @description Subscribe to a public tag.
|
|
131
|
+
*/
|
|
132
|
+
put: operations["subscribe_to_tag_preference_center_tags__tag_id__put"];
|
|
133
|
+
post?: never;
|
|
134
|
+
/**
|
|
135
|
+
* Unsubscribe from Tag
|
|
136
|
+
* @description Unsubscribe from a tag.
|
|
137
|
+
*/
|
|
138
|
+
delete: operations["unsubscribe_from_tag_preference_center_tags__tag_id__delete"];
|
|
139
|
+
options?: never;
|
|
140
|
+
head?: never;
|
|
141
|
+
patch?: never;
|
|
142
|
+
trace?: never;
|
|
143
|
+
};
|
|
144
|
+
"/preference-center/data-export": {
|
|
145
|
+
parameters: {
|
|
146
|
+
query?: never;
|
|
147
|
+
header?: never;
|
|
148
|
+
path?: never;
|
|
149
|
+
cookie?: never;
|
|
150
|
+
};
|
|
151
|
+
/**
|
|
152
|
+
* Export Data (DSGVO)
|
|
153
|
+
* @description Export all stored data for DSGVO compliance.
|
|
154
|
+
*/
|
|
155
|
+
get: operations["export_data_preference_center_data_export_get"];
|
|
156
|
+
put?: never;
|
|
157
|
+
post?: never;
|
|
158
|
+
delete?: never;
|
|
159
|
+
options?: never;
|
|
160
|
+
head?: never;
|
|
161
|
+
patch?: never;
|
|
162
|
+
trace?: never;
|
|
163
|
+
};
|
|
164
|
+
"/preference-center/account": {
|
|
165
|
+
parameters: {
|
|
166
|
+
query?: never;
|
|
167
|
+
header?: never;
|
|
168
|
+
path?: never;
|
|
169
|
+
cookie?: never;
|
|
170
|
+
};
|
|
171
|
+
get?: never;
|
|
172
|
+
put?: never;
|
|
173
|
+
post?: never;
|
|
174
|
+
/**
|
|
175
|
+
* Delete Account (DSGVO)
|
|
176
|
+
* @description Permanently delete the subscriber account and all associated data.
|
|
177
|
+
*/
|
|
178
|
+
delete: operations["delete_account_preference_center_account_delete"];
|
|
179
|
+
options?: never;
|
|
180
|
+
head?: never;
|
|
181
|
+
patch?: never;
|
|
182
|
+
trace?: never;
|
|
183
|
+
};
|
|
184
|
+
"/api/v1/api-keys/scopes": {
|
|
185
|
+
parameters: {
|
|
186
|
+
query?: never;
|
|
187
|
+
header?: never;
|
|
188
|
+
path?: never;
|
|
189
|
+
cookie?: never;
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* List available scopes
|
|
193
|
+
* @description Get a list of all available permission scopes for API keys.
|
|
194
|
+
*/
|
|
195
|
+
get: operations["list_scopes_api_v1_api_keys_scopes_get"];
|
|
196
|
+
put?: never;
|
|
197
|
+
post?: never;
|
|
198
|
+
delete?: never;
|
|
199
|
+
options?: never;
|
|
200
|
+
head?: never;
|
|
201
|
+
patch?: never;
|
|
202
|
+
trace?: never;
|
|
203
|
+
};
|
|
204
|
+
"/api/v1/api-keys": {
|
|
205
|
+
parameters: {
|
|
206
|
+
query?: never;
|
|
207
|
+
header?: never;
|
|
208
|
+
path?: never;
|
|
209
|
+
cookie?: never;
|
|
210
|
+
};
|
|
211
|
+
/**
|
|
212
|
+
* List API keys
|
|
213
|
+
* @description List all API keys. Does not return the actual key values.
|
|
214
|
+
*/
|
|
215
|
+
get: operations["list_api_keys_api_v1_api_keys_get"];
|
|
216
|
+
put?: never;
|
|
217
|
+
/**
|
|
218
|
+
* Create API key
|
|
219
|
+
* @description Create a new API key. The key is returned only once in the response.
|
|
220
|
+
* Store it securely - it cannot be retrieved again!
|
|
221
|
+
*
|
|
222
|
+
* **Note:** This endpoint should be protected in production.
|
|
223
|
+
*/
|
|
224
|
+
post: operations["create_api_key_api_v1_api_keys_post"];
|
|
225
|
+
delete?: never;
|
|
226
|
+
options?: never;
|
|
227
|
+
head?: never;
|
|
228
|
+
patch?: never;
|
|
229
|
+
trace?: never;
|
|
230
|
+
};
|
|
231
|
+
"/api/v1/api-keys/{key_id}": {
|
|
232
|
+
parameters: {
|
|
233
|
+
query?: never;
|
|
234
|
+
header?: never;
|
|
235
|
+
path?: never;
|
|
236
|
+
cookie?: never;
|
|
237
|
+
};
|
|
238
|
+
/**
|
|
239
|
+
* Get API key
|
|
240
|
+
* @description Get details of a specific API key by ID.
|
|
241
|
+
*/
|
|
242
|
+
get: operations["get_api_key_api_v1_api_keys__key_id__get"];
|
|
243
|
+
put?: never;
|
|
244
|
+
post?: never;
|
|
245
|
+
/**
|
|
246
|
+
* Delete API key
|
|
247
|
+
* @description Permanently delete an API key.
|
|
248
|
+
*/
|
|
249
|
+
delete: operations["delete_api_key_api_v1_api_keys__key_id__delete"];
|
|
250
|
+
options?: never;
|
|
251
|
+
head?: never;
|
|
252
|
+
/**
|
|
253
|
+
* Update API key
|
|
254
|
+
* @description Update an existing API key's name, scopes, or active status.
|
|
255
|
+
*/
|
|
256
|
+
patch: operations["update_api_key_api_v1_api_keys__key_id__patch"];
|
|
257
|
+
trace?: never;
|
|
258
|
+
};
|
|
259
|
+
"/api/v1/api-keys/{key_id}/revoke": {
|
|
260
|
+
parameters: {
|
|
261
|
+
query?: never;
|
|
262
|
+
header?: never;
|
|
263
|
+
path?: never;
|
|
264
|
+
cookie?: never;
|
|
265
|
+
};
|
|
266
|
+
get?: never;
|
|
267
|
+
put?: never;
|
|
268
|
+
/**
|
|
269
|
+
* Revoke API key
|
|
270
|
+
* @description Revoke (deactivate) an API key. It will no longer be valid for authentication.
|
|
271
|
+
*/
|
|
272
|
+
post: operations["revoke_api_key_api_v1_api_keys__key_id__revoke_post"];
|
|
273
|
+
delete?: never;
|
|
274
|
+
options?: never;
|
|
275
|
+
head?: never;
|
|
276
|
+
patch?: never;
|
|
277
|
+
trace?: never;
|
|
278
|
+
};
|
|
279
|
+
"/api/v1/subscribers": {
|
|
280
|
+
parameters: {
|
|
281
|
+
query?: never;
|
|
282
|
+
header?: never;
|
|
283
|
+
path?: never;
|
|
284
|
+
cookie?: never;
|
|
285
|
+
};
|
|
286
|
+
/**
|
|
287
|
+
* List subscribers
|
|
288
|
+
* @description List all subscribers with cursor-based pagination.
|
|
289
|
+
*
|
|
290
|
+
* **Pagination:**
|
|
291
|
+
* - Use `cursor` from the response's `next_cursor` for the next page
|
|
292
|
+
* - `X-Total-Count` header contains total number of subscribers
|
|
293
|
+
* - `Link` header provides RFC 5988 pagination links
|
|
294
|
+
*
|
|
295
|
+
* **Filtering:**
|
|
296
|
+
* - `status`: Filter by subscriber status (active, unsubscribed, bounced, complained)
|
|
297
|
+
*
|
|
298
|
+
* **Example:**
|
|
299
|
+
* ```bash
|
|
300
|
+
* curl -H "Authorization: Bearer sf_live_xxx" \
|
|
301
|
+
* "https://api.subscribeflow.net/api/v1/subscribers?limit=50&status=active"
|
|
302
|
+
* ```
|
|
303
|
+
*/
|
|
304
|
+
get: operations["list_subscribers_api_v1_subscribers_get"];
|
|
305
|
+
put?: never;
|
|
306
|
+
/**
|
|
307
|
+
* Create subscriber
|
|
308
|
+
* @description Create a new subscriber with optional tag subscriptions.
|
|
309
|
+
*
|
|
310
|
+
* **Example Request:**
|
|
311
|
+
* ```json
|
|
312
|
+
* {
|
|
313
|
+
* "email": "user@example.com",
|
|
314
|
+
* "tags": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
|
|
315
|
+
* "metadata": {"source": "website", "campaign": "summer-2026"}
|
|
316
|
+
* }
|
|
317
|
+
* ```
|
|
318
|
+
*
|
|
319
|
+
* **Notes:**
|
|
320
|
+
* - Email must be unique across all subscribers
|
|
321
|
+
* - Tags are optional and can be added later via `/subscribers/{id}/tags`
|
|
322
|
+
* - Metadata is stored as JSON and can contain any custom fields
|
|
323
|
+
*/
|
|
324
|
+
post: operations["create_subscriber_api_v1_subscribers_post"];
|
|
325
|
+
delete?: never;
|
|
326
|
+
options?: never;
|
|
327
|
+
head?: never;
|
|
328
|
+
patch?: never;
|
|
329
|
+
trace?: never;
|
|
330
|
+
};
|
|
331
|
+
"/api/v1/subscribers/{subscriber_id}": {
|
|
332
|
+
parameters: {
|
|
333
|
+
query?: never;
|
|
334
|
+
header?: never;
|
|
335
|
+
path?: never;
|
|
336
|
+
cookie?: never;
|
|
337
|
+
};
|
|
338
|
+
/**
|
|
339
|
+
* Get subscriber
|
|
340
|
+
* @description Get a single subscriber by ID.
|
|
341
|
+
*
|
|
342
|
+
* Returns the full subscriber object including all subscribed tags and metadata.
|
|
343
|
+
*/
|
|
344
|
+
get: operations["get_subscriber_api_v1_subscribers__subscriber_id__get"];
|
|
345
|
+
/**
|
|
346
|
+
* Update subscriber
|
|
347
|
+
* @description Update an existing subscriber.
|
|
348
|
+
*/
|
|
349
|
+
put: operations["update_subscriber_api_v1_subscribers__subscriber_id__put"];
|
|
350
|
+
post?: never;
|
|
351
|
+
/**
|
|
352
|
+
* Delete subscriber
|
|
353
|
+
* @description Delete a subscriber permanently (GDPR/DSGVO compliant).
|
|
354
|
+
*
|
|
355
|
+
* **Warning:** This action is irreversible. All subscriber data including:
|
|
356
|
+
* - Personal information (email)
|
|
357
|
+
* - Tag subscriptions
|
|
358
|
+
* - Subscription history
|
|
359
|
+
* - Metadata
|
|
360
|
+
*
|
|
361
|
+
* will be permanently deleted.
|
|
362
|
+
*
|
|
363
|
+
* For a soft-delete (unsubscribe), use `PUT /subscribers/{id}` with `status: "unsubscribed"`.
|
|
364
|
+
*/
|
|
365
|
+
delete: operations["delete_subscriber_api_v1_subscribers__subscriber_id__delete"];
|
|
366
|
+
options?: never;
|
|
367
|
+
head?: never;
|
|
368
|
+
patch?: never;
|
|
369
|
+
trace?: never;
|
|
370
|
+
};
|
|
371
|
+
"/api/v1/subscribers/{subscriber_id}/tags": {
|
|
372
|
+
parameters: {
|
|
373
|
+
query?: never;
|
|
374
|
+
header?: never;
|
|
375
|
+
path?: never;
|
|
376
|
+
cookie?: never;
|
|
377
|
+
};
|
|
378
|
+
/**
|
|
379
|
+
* Get subscriber tags
|
|
380
|
+
* @description Get all tags for a subscriber.
|
|
381
|
+
*/
|
|
382
|
+
get: operations["get_subscriber_tags_api_v1_subscribers__subscriber_id__tags_get"];
|
|
383
|
+
put?: never;
|
|
384
|
+
/**
|
|
385
|
+
* Add tags to subscriber
|
|
386
|
+
* @description Add one or more tags to a subscriber.
|
|
387
|
+
*/
|
|
388
|
+
post: operations["add_subscriber_tags_api_v1_subscribers__subscriber_id__tags_post"];
|
|
389
|
+
delete?: never;
|
|
390
|
+
options?: never;
|
|
391
|
+
head?: never;
|
|
392
|
+
patch?: never;
|
|
393
|
+
trace?: never;
|
|
394
|
+
};
|
|
395
|
+
"/api/v1/subscribers/{subscriber_id}/tags/{tag_id}": {
|
|
396
|
+
parameters: {
|
|
397
|
+
query?: never;
|
|
398
|
+
header?: never;
|
|
399
|
+
path?: never;
|
|
400
|
+
cookie?: never;
|
|
401
|
+
};
|
|
402
|
+
get?: never;
|
|
403
|
+
put?: never;
|
|
404
|
+
post?: never;
|
|
405
|
+
/**
|
|
406
|
+
* Remove tag from subscriber
|
|
407
|
+
* @description Remove a tag from a subscriber.
|
|
408
|
+
*/
|
|
409
|
+
delete: operations["remove_subscriber_tag_api_v1_subscribers__subscriber_id__tags__tag_id__delete"];
|
|
410
|
+
options?: never;
|
|
411
|
+
head?: never;
|
|
412
|
+
patch?: never;
|
|
413
|
+
trace?: never;
|
|
414
|
+
};
|
|
415
|
+
"/api/v1/tags": {
|
|
416
|
+
parameters: {
|
|
417
|
+
query?: never;
|
|
418
|
+
header?: never;
|
|
419
|
+
path?: never;
|
|
420
|
+
cookie?: never;
|
|
421
|
+
};
|
|
422
|
+
/**
|
|
423
|
+
* List tags
|
|
424
|
+
* @description List all tags with cursor-based pagination and optional filters.
|
|
425
|
+
*/
|
|
426
|
+
get: operations["list_tags_api_v1_tags_get"];
|
|
427
|
+
put?: never;
|
|
428
|
+
/**
|
|
429
|
+
* Create tag
|
|
430
|
+
* @description Create a new tag for categorizing subscribers.
|
|
431
|
+
*/
|
|
432
|
+
post: operations["create_tag_api_v1_tags_post"];
|
|
433
|
+
delete?: never;
|
|
434
|
+
options?: never;
|
|
435
|
+
head?: never;
|
|
436
|
+
patch?: never;
|
|
437
|
+
trace?: never;
|
|
438
|
+
};
|
|
439
|
+
"/api/v1/tags/{tag_id}": {
|
|
440
|
+
parameters: {
|
|
441
|
+
query?: never;
|
|
442
|
+
header?: never;
|
|
443
|
+
path?: never;
|
|
444
|
+
cookie?: never;
|
|
445
|
+
};
|
|
446
|
+
/**
|
|
447
|
+
* Get tag
|
|
448
|
+
* @description Get a single tag by ID.
|
|
449
|
+
*/
|
|
450
|
+
get: operations["get_tag_api_v1_tags__tag_id__get"];
|
|
451
|
+
/**
|
|
452
|
+
* Update tag
|
|
453
|
+
* @description Update an existing tag.
|
|
454
|
+
*/
|
|
455
|
+
put: operations["update_tag_api_v1_tags__tag_id__put"];
|
|
456
|
+
post?: never;
|
|
457
|
+
/**
|
|
458
|
+
* Archive tag
|
|
459
|
+
* @description Archive a tag (soft delete). Existing subscriber associations are preserved.
|
|
460
|
+
*/
|
|
461
|
+
delete: operations["archive_tag_api_v1_tags__tag_id__delete"];
|
|
462
|
+
options?: never;
|
|
463
|
+
head?: never;
|
|
464
|
+
patch?: never;
|
|
465
|
+
trace?: never;
|
|
466
|
+
};
|
|
467
|
+
"/api/v1/webhooks": {
|
|
468
|
+
parameters: {
|
|
469
|
+
query?: never;
|
|
470
|
+
header?: never;
|
|
471
|
+
path?: never;
|
|
472
|
+
cookie?: never;
|
|
473
|
+
};
|
|
474
|
+
/**
|
|
475
|
+
* List webhook endpoints
|
|
476
|
+
* @description List all webhook endpoints with pagination.
|
|
477
|
+
*/
|
|
478
|
+
get: operations["list_webhook_endpoints_api_v1_webhooks_get"];
|
|
479
|
+
put?: never;
|
|
480
|
+
/**
|
|
481
|
+
* Create webhook endpoint
|
|
482
|
+
* @description Create a new webhook endpoint to receive events.
|
|
483
|
+
*
|
|
484
|
+
* The signing secret is only returned once on creation. Store it securely.
|
|
485
|
+
*
|
|
486
|
+
* **Available event types:**
|
|
487
|
+
* - `subscriber.created` - New subscriber created
|
|
488
|
+
* - `subscriber.updated` - Subscriber updated
|
|
489
|
+
* - `subscriber.deleted` - Subscriber deleted
|
|
490
|
+
* - `tag.subscribed` - Subscriber subscribed to a tag
|
|
491
|
+
* - `tag.unsubscribed` - Subscriber unsubscribed from a tag
|
|
492
|
+
*/
|
|
493
|
+
post: operations["create_webhook_endpoint_api_v1_webhooks_post"];
|
|
494
|
+
delete?: never;
|
|
495
|
+
options?: never;
|
|
496
|
+
head?: never;
|
|
497
|
+
patch?: never;
|
|
498
|
+
trace?: never;
|
|
499
|
+
};
|
|
500
|
+
"/api/v1/webhooks/{endpoint_id}": {
|
|
501
|
+
parameters: {
|
|
502
|
+
query?: never;
|
|
503
|
+
header?: never;
|
|
504
|
+
path?: never;
|
|
505
|
+
cookie?: never;
|
|
506
|
+
};
|
|
507
|
+
/**
|
|
508
|
+
* Get webhook endpoint
|
|
509
|
+
* @description Get details of a specific webhook endpoint.
|
|
510
|
+
*/
|
|
511
|
+
get: operations["get_webhook_endpoint_api_v1_webhooks__endpoint_id__get"];
|
|
512
|
+
put?: never;
|
|
513
|
+
post?: never;
|
|
514
|
+
/**
|
|
515
|
+
* Delete webhook endpoint
|
|
516
|
+
* @description Delete a webhook endpoint and all its delivery history.
|
|
517
|
+
*/
|
|
518
|
+
delete: operations["delete_webhook_endpoint_api_v1_webhooks__endpoint_id__delete"];
|
|
519
|
+
options?: never;
|
|
520
|
+
head?: never;
|
|
521
|
+
/**
|
|
522
|
+
* Update webhook endpoint
|
|
523
|
+
* @description Update a webhook endpoint's configuration.
|
|
524
|
+
*/
|
|
525
|
+
patch: operations["update_webhook_endpoint_api_v1_webhooks__endpoint_id__patch"];
|
|
526
|
+
trace?: never;
|
|
527
|
+
};
|
|
528
|
+
"/api/v1/webhooks/{endpoint_id}/regenerate-secret": {
|
|
529
|
+
parameters: {
|
|
530
|
+
query?: never;
|
|
531
|
+
header?: never;
|
|
532
|
+
path?: never;
|
|
533
|
+
cookie?: never;
|
|
534
|
+
};
|
|
535
|
+
get?: never;
|
|
536
|
+
put?: never;
|
|
537
|
+
/**
|
|
538
|
+
* Regenerate signing secret
|
|
539
|
+
* @description Regenerate the signing secret for a webhook endpoint.
|
|
540
|
+
*
|
|
541
|
+
* The new secret is only returned once. Store it securely.
|
|
542
|
+
* The old secret will immediately become invalid.
|
|
543
|
+
*/
|
|
544
|
+
post: operations["regenerate_webhook_secret_api_v1_webhooks__endpoint_id__regenerate_secret_post"];
|
|
545
|
+
delete?: never;
|
|
546
|
+
options?: never;
|
|
547
|
+
head?: never;
|
|
548
|
+
patch?: never;
|
|
549
|
+
trace?: never;
|
|
550
|
+
};
|
|
551
|
+
"/api/v1/webhooks/{endpoint_id}/test": {
|
|
552
|
+
parameters: {
|
|
553
|
+
query?: never;
|
|
554
|
+
header?: never;
|
|
555
|
+
path?: never;
|
|
556
|
+
cookie?: never;
|
|
557
|
+
};
|
|
558
|
+
get?: never;
|
|
559
|
+
put?: never;
|
|
560
|
+
/**
|
|
561
|
+
* Test webhook endpoint
|
|
562
|
+
* @description Send a test event to a webhook endpoint.
|
|
563
|
+
*
|
|
564
|
+
* This immediately delivers a test event and returns the result.
|
|
565
|
+
* Useful for verifying endpoint configuration and signature verification.
|
|
566
|
+
*/
|
|
567
|
+
post: operations["test_webhook_endpoint_api_v1_webhooks__endpoint_id__test_post"];
|
|
568
|
+
delete?: never;
|
|
569
|
+
options?: never;
|
|
570
|
+
head?: never;
|
|
571
|
+
patch?: never;
|
|
572
|
+
trace?: never;
|
|
573
|
+
};
|
|
574
|
+
"/api/v1/webhooks/{endpoint_id}/deliveries": {
|
|
575
|
+
parameters: {
|
|
576
|
+
query?: never;
|
|
577
|
+
header?: never;
|
|
578
|
+
path?: never;
|
|
579
|
+
cookie?: never;
|
|
580
|
+
};
|
|
581
|
+
/**
|
|
582
|
+
* List endpoint deliveries
|
|
583
|
+
* @description List delivery history for a specific webhook endpoint.
|
|
584
|
+
*/
|
|
585
|
+
get: operations["list_endpoint_deliveries_api_v1_webhooks__endpoint_id__deliveries_get"];
|
|
586
|
+
put?: never;
|
|
587
|
+
post?: never;
|
|
588
|
+
delete?: never;
|
|
589
|
+
options?: never;
|
|
590
|
+
head?: never;
|
|
591
|
+
patch?: never;
|
|
592
|
+
trace?: never;
|
|
593
|
+
};
|
|
594
|
+
"/api/v1/webhooks/{endpoint_id}/deliveries/{delivery_id}": {
|
|
595
|
+
parameters: {
|
|
596
|
+
query?: never;
|
|
597
|
+
header?: never;
|
|
598
|
+
path?: never;
|
|
599
|
+
cookie?: never;
|
|
600
|
+
};
|
|
601
|
+
/**
|
|
602
|
+
* Get delivery details
|
|
603
|
+
* @description Get full details of a specific webhook delivery including payload.
|
|
604
|
+
*/
|
|
605
|
+
get: operations["get_delivery_details_api_v1_webhooks__endpoint_id__deliveries__delivery_id__get"];
|
|
606
|
+
put?: never;
|
|
607
|
+
post?: never;
|
|
608
|
+
delete?: never;
|
|
609
|
+
options?: never;
|
|
610
|
+
head?: never;
|
|
611
|
+
patch?: never;
|
|
612
|
+
trace?: never;
|
|
613
|
+
};
|
|
614
|
+
"/api/v1/webhooks/{endpoint_id}/deliveries/{delivery_id}/retry": {
|
|
615
|
+
parameters: {
|
|
616
|
+
query?: never;
|
|
617
|
+
header?: never;
|
|
618
|
+
path?: never;
|
|
619
|
+
cookie?: never;
|
|
620
|
+
};
|
|
621
|
+
get?: never;
|
|
622
|
+
put?: never;
|
|
623
|
+
/**
|
|
624
|
+
* Retry delivery
|
|
625
|
+
* @description Manually retry a failed webhook delivery.
|
|
626
|
+
*/
|
|
627
|
+
post: operations["retry_delivery_api_v1_webhooks__endpoint_id__deliveries__delivery_id__retry_post"];
|
|
628
|
+
delete?: never;
|
|
629
|
+
options?: never;
|
|
630
|
+
head?: never;
|
|
631
|
+
patch?: never;
|
|
632
|
+
trace?: never;
|
|
633
|
+
};
|
|
634
|
+
"/api/v1/webhooks/{endpoint_id}/stats": {
|
|
635
|
+
parameters: {
|
|
636
|
+
query?: never;
|
|
637
|
+
header?: never;
|
|
638
|
+
path?: never;
|
|
639
|
+
cookie?: never;
|
|
640
|
+
};
|
|
641
|
+
/**
|
|
642
|
+
* Get endpoint statistics
|
|
643
|
+
* @description Get delivery statistics for a webhook endpoint.
|
|
644
|
+
*/
|
|
645
|
+
get: operations["get_endpoint_stats_api_v1_webhooks__endpoint_id__stats_get"];
|
|
646
|
+
put?: never;
|
|
647
|
+
post?: never;
|
|
648
|
+
delete?: never;
|
|
649
|
+
options?: never;
|
|
650
|
+
head?: never;
|
|
651
|
+
patch?: never;
|
|
652
|
+
trace?: never;
|
|
653
|
+
};
|
|
654
|
+
"/api/v1/webhooks/deliveries/all": {
|
|
655
|
+
parameters: {
|
|
656
|
+
query?: never;
|
|
657
|
+
header?: never;
|
|
658
|
+
path?: never;
|
|
659
|
+
cookie?: never;
|
|
660
|
+
};
|
|
661
|
+
/**
|
|
662
|
+
* List all deliveries
|
|
663
|
+
* @description List all webhook deliveries across all endpoints.
|
|
664
|
+
*/
|
|
665
|
+
get: operations["list_all_deliveries_api_v1_webhooks_deliveries_all_get"];
|
|
666
|
+
put?: never;
|
|
667
|
+
post?: never;
|
|
668
|
+
delete?: never;
|
|
669
|
+
options?: never;
|
|
670
|
+
head?: never;
|
|
671
|
+
patch?: never;
|
|
672
|
+
trace?: never;
|
|
673
|
+
};
|
|
674
|
+
"/api/v1/webhooks/stats/all": {
|
|
675
|
+
parameters: {
|
|
676
|
+
query?: never;
|
|
677
|
+
header?: never;
|
|
678
|
+
path?: never;
|
|
679
|
+
cookie?: never;
|
|
680
|
+
};
|
|
681
|
+
/**
|
|
682
|
+
* Get global statistics
|
|
683
|
+
* @description Get delivery statistics across all webhook endpoints.
|
|
684
|
+
*/
|
|
685
|
+
get: operations["get_global_stats_api_v1_webhooks_stats_all_get"];
|
|
686
|
+
put?: never;
|
|
687
|
+
post?: never;
|
|
688
|
+
delete?: never;
|
|
689
|
+
options?: never;
|
|
690
|
+
head?: never;
|
|
691
|
+
patch?: never;
|
|
692
|
+
trace?: never;
|
|
693
|
+
};
|
|
694
|
+
"/api/v1/webhooks/event-types": {
|
|
695
|
+
parameters: {
|
|
696
|
+
query?: never;
|
|
697
|
+
header?: never;
|
|
698
|
+
path?: never;
|
|
699
|
+
cookie?: never;
|
|
700
|
+
};
|
|
701
|
+
/**
|
|
702
|
+
* List event types
|
|
703
|
+
* @description List all available webhook event types.
|
|
704
|
+
*/
|
|
705
|
+
get: operations["list_event_types_api_v1_webhooks_event_types_get"];
|
|
706
|
+
put?: never;
|
|
707
|
+
post?: never;
|
|
708
|
+
delete?: never;
|
|
709
|
+
options?: never;
|
|
710
|
+
head?: never;
|
|
711
|
+
patch?: never;
|
|
712
|
+
trace?: never;
|
|
713
|
+
};
|
|
714
|
+
}
|
|
715
|
+
export type webhooks = Record<string, never>;
|
|
716
|
+
export interface components {
|
|
717
|
+
schemas: {
|
|
718
|
+
/**
|
|
719
|
+
* APIKeyCreate
|
|
720
|
+
* @description Schema for creating a new API key.
|
|
721
|
+
*/
|
|
722
|
+
APIKeyCreate: {
|
|
723
|
+
/**
|
|
724
|
+
* Name
|
|
725
|
+
* @description Friendly name for the API key
|
|
726
|
+
* @example Production API Key
|
|
727
|
+
*/
|
|
728
|
+
name?: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* Scopes
|
|
731
|
+
* @description List of permission scopes
|
|
732
|
+
* @example [
|
|
733
|
+
* "subscribers:read",
|
|
734
|
+
* "subscribers:write",
|
|
735
|
+
* "tags:read"
|
|
736
|
+
* ]
|
|
737
|
+
*/
|
|
738
|
+
scopes?: string[];
|
|
739
|
+
/**
|
|
740
|
+
* Expires At
|
|
741
|
+
* @description Optional expiration datetime (UTC)
|
|
742
|
+
*/
|
|
743
|
+
expires_at?: string | null;
|
|
744
|
+
/**
|
|
745
|
+
* Environment
|
|
746
|
+
* @description Key environment: live (production) or test
|
|
747
|
+
* @default live
|
|
748
|
+
* @enum {string}
|
|
749
|
+
*/
|
|
750
|
+
environment: "live" | "test";
|
|
751
|
+
};
|
|
752
|
+
/**
|
|
753
|
+
* APIKeyCreatedResponse
|
|
754
|
+
* @description Schema for newly created API key response.
|
|
755
|
+
*
|
|
756
|
+
* This is the ONLY time the plain text key is returned.
|
|
757
|
+
* The key cannot be retrieved again after creation.
|
|
758
|
+
*/
|
|
759
|
+
APIKeyCreatedResponse: {
|
|
760
|
+
/**
|
|
761
|
+
* Id
|
|
762
|
+
* Format: uuid
|
|
763
|
+
*/
|
|
764
|
+
id: string;
|
|
765
|
+
/** Name */
|
|
766
|
+
name: string | null;
|
|
767
|
+
/** Scopes */
|
|
768
|
+
scopes: string[];
|
|
769
|
+
/** Is Active */
|
|
770
|
+
is_active: boolean;
|
|
771
|
+
/** Expires At */
|
|
772
|
+
expires_at: string | null;
|
|
773
|
+
/**
|
|
774
|
+
* Created At
|
|
775
|
+
* Format: date-time
|
|
776
|
+
*/
|
|
777
|
+
created_at: string;
|
|
778
|
+
/**
|
|
779
|
+
* Key
|
|
780
|
+
* @description The API key. Store this securely - it cannot be retrieved again!
|
|
781
|
+
* @example sf_live_abc123def456...
|
|
782
|
+
*/
|
|
783
|
+
key: string;
|
|
784
|
+
};
|
|
785
|
+
/**
|
|
786
|
+
* APIKeyResponse
|
|
787
|
+
* @description Schema for API key response (without the actual key).
|
|
788
|
+
*/
|
|
789
|
+
APIKeyResponse: {
|
|
790
|
+
/**
|
|
791
|
+
* Id
|
|
792
|
+
* Format: uuid
|
|
793
|
+
*/
|
|
794
|
+
id: string;
|
|
795
|
+
/** Name */
|
|
796
|
+
name: string | null;
|
|
797
|
+
/** Scopes */
|
|
798
|
+
scopes: string[];
|
|
799
|
+
/** Is Active */
|
|
800
|
+
is_active: boolean;
|
|
801
|
+
/** Last Used At */
|
|
802
|
+
last_used_at: string | null;
|
|
803
|
+
/** Expires At */
|
|
804
|
+
expires_at: string | null;
|
|
805
|
+
/**
|
|
806
|
+
* Created At
|
|
807
|
+
* Format: date-time
|
|
808
|
+
*/
|
|
809
|
+
created_at: string;
|
|
810
|
+
};
|
|
811
|
+
/**
|
|
812
|
+
* APIKeyUpdate
|
|
813
|
+
* @description Schema for updating an existing API key.
|
|
814
|
+
*/
|
|
815
|
+
APIKeyUpdate: {
|
|
816
|
+
/**
|
|
817
|
+
* Name
|
|
818
|
+
* @description New friendly name for the API key
|
|
819
|
+
*/
|
|
820
|
+
name?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* Scopes
|
|
823
|
+
* @description New list of permission scopes
|
|
824
|
+
*/
|
|
825
|
+
scopes?: string[] | null;
|
|
826
|
+
/**
|
|
827
|
+
* Is Active
|
|
828
|
+
* @description Whether the key is active
|
|
829
|
+
*/
|
|
830
|
+
is_active?: boolean | null;
|
|
831
|
+
};
|
|
832
|
+
/**
|
|
833
|
+
* AccountDeleteResponse
|
|
834
|
+
* @description Response schema for account deletion.
|
|
835
|
+
*/
|
|
836
|
+
AccountDeleteResponse: {
|
|
837
|
+
/**
|
|
838
|
+
* Success
|
|
839
|
+
* @default true
|
|
840
|
+
*/
|
|
841
|
+
success: boolean;
|
|
842
|
+
/**
|
|
843
|
+
* Message
|
|
844
|
+
* @default Account and all associated data have been permanently deleted
|
|
845
|
+
*/
|
|
846
|
+
message: string;
|
|
847
|
+
/**
|
|
848
|
+
* Deleted At
|
|
849
|
+
* Format: date-time
|
|
850
|
+
*/
|
|
851
|
+
deleted_at: string;
|
|
852
|
+
};
|
|
853
|
+
/**
|
|
854
|
+
* AvailableScopesResponse
|
|
855
|
+
* @description Schema for listing available scopes.
|
|
856
|
+
*/
|
|
857
|
+
AvailableScopesResponse: {
|
|
858
|
+
/**
|
|
859
|
+
* Scopes
|
|
860
|
+
* @description List of all available permission scopes
|
|
861
|
+
*/
|
|
862
|
+
scopes: string[];
|
|
863
|
+
};
|
|
864
|
+
/**
|
|
865
|
+
* ComponentHealth
|
|
866
|
+
* @description Health status of a single component.
|
|
867
|
+
*/
|
|
868
|
+
ComponentHealth: {
|
|
869
|
+
status: components["schemas"]["HealthStatus"];
|
|
870
|
+
/** Message */
|
|
871
|
+
message?: string | null;
|
|
872
|
+
};
|
|
873
|
+
/**
|
|
874
|
+
* DataExportResponse
|
|
875
|
+
* @description Response schema for DSGVO data export.
|
|
876
|
+
*/
|
|
877
|
+
DataExportResponse: {
|
|
878
|
+
subscriber: components["schemas"]["SubscriberPublicInfo"];
|
|
879
|
+
/** Subscribed Tags */
|
|
880
|
+
subscribed_tags: components["schemas"]["TagInfo"][];
|
|
881
|
+
/**
|
|
882
|
+
* Subscription History
|
|
883
|
+
* @description History of tag subscriptions and unsubscriptions
|
|
884
|
+
*/
|
|
885
|
+
subscription_history?: {
|
|
886
|
+
[key: string]: unknown;
|
|
887
|
+
}[];
|
|
888
|
+
/**
|
|
889
|
+
* Metadata
|
|
890
|
+
* @description Custom metadata stored for this subscriber
|
|
891
|
+
*/
|
|
892
|
+
metadata?: {
|
|
893
|
+
[key: string]: unknown;
|
|
894
|
+
};
|
|
895
|
+
/**
|
|
896
|
+
* Audit Log
|
|
897
|
+
* @description Audit log of changes to this subscriber
|
|
898
|
+
*/
|
|
899
|
+
audit_log?: {
|
|
900
|
+
[key: string]: unknown;
|
|
901
|
+
}[];
|
|
902
|
+
/**
|
|
903
|
+
* Exported At
|
|
904
|
+
* Format: date-time
|
|
905
|
+
*/
|
|
906
|
+
exported_at: string;
|
|
907
|
+
};
|
|
908
|
+
/**
|
|
909
|
+
* HealthResponse
|
|
910
|
+
* @description Health check response model.
|
|
911
|
+
*/
|
|
912
|
+
HealthResponse: {
|
|
913
|
+
status: components["schemas"]["HealthStatus"];
|
|
914
|
+
/** Version */
|
|
915
|
+
version: string;
|
|
916
|
+
/** Environment */
|
|
917
|
+
environment: string;
|
|
918
|
+
/** Components */
|
|
919
|
+
components?: {
|
|
920
|
+
[key: string]: components["schemas"]["ComponentHealth"];
|
|
921
|
+
} | null;
|
|
922
|
+
};
|
|
923
|
+
/**
|
|
924
|
+
* HealthStatus
|
|
925
|
+
* @description Health check status values.
|
|
926
|
+
* @enum {string}
|
|
927
|
+
*/
|
|
928
|
+
HealthStatus: "healthy" | "unhealthy" | "degraded";
|
|
929
|
+
/**
|
|
930
|
+
* LivenessResponse
|
|
931
|
+
* @description Simple liveness response.
|
|
932
|
+
*/
|
|
933
|
+
LivenessResponse: {
|
|
934
|
+
status: components["schemas"]["HealthStatus"];
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* PaginatedWebhookDeliveryResponse
|
|
938
|
+
* @description Paginated list of webhook deliveries.
|
|
939
|
+
*/
|
|
940
|
+
PaginatedWebhookDeliveryResponse: {
|
|
941
|
+
/** Data */
|
|
942
|
+
data: components["schemas"]["WebhookDeliveryResponse"][];
|
|
943
|
+
/** Total */
|
|
944
|
+
total: number;
|
|
945
|
+
/** Next Cursor */
|
|
946
|
+
next_cursor: string | null;
|
|
947
|
+
};
|
|
948
|
+
/**
|
|
949
|
+
* PaginatedWebhookEndpointResponse
|
|
950
|
+
* @description Paginated list of webhook endpoints.
|
|
951
|
+
*/
|
|
952
|
+
PaginatedWebhookEndpointResponse: {
|
|
953
|
+
/** Data */
|
|
954
|
+
data: components["schemas"]["WebhookEndpointResponse"][];
|
|
955
|
+
/** Total */
|
|
956
|
+
total: number;
|
|
957
|
+
/** Next Cursor */
|
|
958
|
+
next_cursor: string | null;
|
|
959
|
+
};
|
|
960
|
+
/**
|
|
961
|
+
* PreferenceCenterResponse
|
|
962
|
+
* @description Response schema for preference center overview.
|
|
963
|
+
*/
|
|
964
|
+
PreferenceCenterResponse: {
|
|
965
|
+
subscriber: components["schemas"]["SubscriberPublicInfo"];
|
|
966
|
+
/**
|
|
967
|
+
* Subscribed Tags
|
|
968
|
+
* @description Tags the subscriber is currently subscribed to
|
|
969
|
+
*/
|
|
970
|
+
subscribed_tags?: components["schemas"]["TagInfo"][];
|
|
971
|
+
/**
|
|
972
|
+
* Available Tags
|
|
973
|
+
* @description Public tags available for subscription (not yet subscribed)
|
|
974
|
+
*/
|
|
975
|
+
available_tags?: components["schemas"]["TagInfo"][];
|
|
976
|
+
/**
|
|
977
|
+
* Data Stored
|
|
978
|
+
* @description DSGVO transparency: all data stored about this subscriber
|
|
979
|
+
*/
|
|
980
|
+
data_stored?: {
|
|
981
|
+
[key: string]: unknown;
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
/**
|
|
985
|
+
* SubscriberCreate
|
|
986
|
+
* @description Schema for creating a new subscriber.
|
|
987
|
+
*/
|
|
988
|
+
SubscriberCreate: {
|
|
989
|
+
/**
|
|
990
|
+
* Email
|
|
991
|
+
* Format: email
|
|
992
|
+
* @description Email address of the subscriber
|
|
993
|
+
* @example user@example.com
|
|
994
|
+
*/
|
|
995
|
+
email: string;
|
|
996
|
+
/**
|
|
997
|
+
* Tags
|
|
998
|
+
* @description List of tag IDs to subscribe to
|
|
999
|
+
*/
|
|
1000
|
+
tags?: string[];
|
|
1001
|
+
/**
|
|
1002
|
+
* Metadata
|
|
1003
|
+
* @description Custom metadata for the subscriber
|
|
1004
|
+
* @example {
|
|
1005
|
+
* "campaign": "launch",
|
|
1006
|
+
* "source": "website"
|
|
1007
|
+
* }
|
|
1008
|
+
*/
|
|
1009
|
+
metadata?: {
|
|
1010
|
+
[key: string]: unknown;
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
/**
|
|
1014
|
+
* SubscriberListResponse
|
|
1015
|
+
* @description Schema for paginated subscriber list response.
|
|
1016
|
+
*/
|
|
1017
|
+
SubscriberListResponse: {
|
|
1018
|
+
/** Items */
|
|
1019
|
+
items: components["schemas"]["SubscriberResponse"][];
|
|
1020
|
+
/** Total */
|
|
1021
|
+
total: number;
|
|
1022
|
+
/**
|
|
1023
|
+
* Cursor
|
|
1024
|
+
* @description Cursor for next page (null if no more items)
|
|
1025
|
+
*/
|
|
1026
|
+
cursor?: string | null;
|
|
1027
|
+
/**
|
|
1028
|
+
* Has More
|
|
1029
|
+
* @description Whether there are more items
|
|
1030
|
+
* @default false
|
|
1031
|
+
*/
|
|
1032
|
+
has_more: boolean;
|
|
1033
|
+
};
|
|
1034
|
+
/**
|
|
1035
|
+
* SubscriberPublicInfo
|
|
1036
|
+
* @description Public subscriber information for preference center.
|
|
1037
|
+
*/
|
|
1038
|
+
SubscriberPublicInfo: {
|
|
1039
|
+
/**
|
|
1040
|
+
* Id
|
|
1041
|
+
* Format: uuid
|
|
1042
|
+
*/
|
|
1043
|
+
id: string;
|
|
1044
|
+
/** Email */
|
|
1045
|
+
email: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* Created At
|
|
1048
|
+
* Format: date-time
|
|
1049
|
+
*/
|
|
1050
|
+
created_at: string;
|
|
1051
|
+
};
|
|
1052
|
+
/**
|
|
1053
|
+
* SubscriberResponse
|
|
1054
|
+
* @description Schema for subscriber response.
|
|
1055
|
+
*/
|
|
1056
|
+
SubscriberResponse: {
|
|
1057
|
+
/**
|
|
1058
|
+
* Id
|
|
1059
|
+
* Format: uuid
|
|
1060
|
+
*/
|
|
1061
|
+
id: string;
|
|
1062
|
+
/** Email */
|
|
1063
|
+
email: string;
|
|
1064
|
+
status: components["schemas"]["SubscriberStatus"];
|
|
1065
|
+
/** Metadata */
|
|
1066
|
+
metadata_?: {
|
|
1067
|
+
[key: string]: unknown;
|
|
1068
|
+
};
|
|
1069
|
+
/** Tags */
|
|
1070
|
+
tags?: components["schemas"]["TagBrief"][];
|
|
1071
|
+
/**
|
|
1072
|
+
* Created At
|
|
1073
|
+
* Format: date-time
|
|
1074
|
+
*/
|
|
1075
|
+
created_at: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* Updated At
|
|
1078
|
+
* Format: date-time
|
|
1079
|
+
*/
|
|
1080
|
+
updated_at: string;
|
|
1081
|
+
};
|
|
1082
|
+
/**
|
|
1083
|
+
* SubscriberStatus
|
|
1084
|
+
* @description Status of a subscriber.
|
|
1085
|
+
* @enum {string}
|
|
1086
|
+
*/
|
|
1087
|
+
SubscriberStatus: "active" | "unsubscribed";
|
|
1088
|
+
/**
|
|
1089
|
+
* SubscriberTagsAdd
|
|
1090
|
+
* @description Schema for adding tags to a subscriber.
|
|
1091
|
+
*/
|
|
1092
|
+
SubscriberTagsAdd: {
|
|
1093
|
+
/**
|
|
1094
|
+
* Tag Ids
|
|
1095
|
+
* @description List of tag IDs to add
|
|
1096
|
+
*/
|
|
1097
|
+
tag_ids: string[];
|
|
1098
|
+
};
|
|
1099
|
+
/**
|
|
1100
|
+
* SubscriberTagsResponse
|
|
1101
|
+
* @description Schema for subscriber tags response.
|
|
1102
|
+
*/
|
|
1103
|
+
SubscriberTagsResponse: {
|
|
1104
|
+
/**
|
|
1105
|
+
* Subscriber Id
|
|
1106
|
+
* Format: uuid
|
|
1107
|
+
*/
|
|
1108
|
+
subscriber_id: string;
|
|
1109
|
+
/** Tags */
|
|
1110
|
+
tags: components["schemas"]["TagBrief"][];
|
|
1111
|
+
/** Total */
|
|
1112
|
+
total: number;
|
|
1113
|
+
};
|
|
1114
|
+
/**
|
|
1115
|
+
* SubscriberUpdate
|
|
1116
|
+
* @description Schema for updating an existing subscriber.
|
|
1117
|
+
*/
|
|
1118
|
+
SubscriberUpdate: {
|
|
1119
|
+
/**
|
|
1120
|
+
* Email
|
|
1121
|
+
* @description New email address
|
|
1122
|
+
*/
|
|
1123
|
+
email?: string | null;
|
|
1124
|
+
/** @description Subscriber status */
|
|
1125
|
+
status?: components["schemas"]["SubscriberStatus"] | null;
|
|
1126
|
+
/**
|
|
1127
|
+
* Metadata
|
|
1128
|
+
* @description New metadata (replaces existing)
|
|
1129
|
+
*/
|
|
1130
|
+
metadata?: {
|
|
1131
|
+
[key: string]: unknown;
|
|
1132
|
+
} | null;
|
|
1133
|
+
};
|
|
1134
|
+
/**
|
|
1135
|
+
* TagBrief
|
|
1136
|
+
* @description Brief tag information for subscriber responses.
|
|
1137
|
+
*/
|
|
1138
|
+
TagBrief: {
|
|
1139
|
+
/**
|
|
1140
|
+
* Id
|
|
1141
|
+
* Format: uuid
|
|
1142
|
+
*/
|
|
1143
|
+
id: string;
|
|
1144
|
+
/** Name */
|
|
1145
|
+
name: string;
|
|
1146
|
+
/** Category */
|
|
1147
|
+
category?: string | null;
|
|
1148
|
+
};
|
|
1149
|
+
/**
|
|
1150
|
+
* TagCreate
|
|
1151
|
+
* @description Schema for creating a new tag.
|
|
1152
|
+
*/
|
|
1153
|
+
TagCreate: {
|
|
1154
|
+
/**
|
|
1155
|
+
* Name
|
|
1156
|
+
* @description Unique name of the tag
|
|
1157
|
+
* @example newsletter
|
|
1158
|
+
* @example product-updates
|
|
1159
|
+
*/
|
|
1160
|
+
name: string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Description
|
|
1163
|
+
* @description Optional description of the tag
|
|
1164
|
+
* @example Weekly newsletter with company updates
|
|
1165
|
+
*/
|
|
1166
|
+
description?: string | null;
|
|
1167
|
+
/**
|
|
1168
|
+
* Category
|
|
1169
|
+
* @description Category for grouping tags in Preference Center
|
|
1170
|
+
* @example Marketing
|
|
1171
|
+
* @example Product Updates
|
|
1172
|
+
* @example Security
|
|
1173
|
+
*/
|
|
1174
|
+
category?: string | null;
|
|
1175
|
+
/**
|
|
1176
|
+
* Is Public
|
|
1177
|
+
* @description Whether the tag is visible in the Preference Center
|
|
1178
|
+
* @default true
|
|
1179
|
+
*/
|
|
1180
|
+
is_public: boolean;
|
|
1181
|
+
};
|
|
1182
|
+
/**
|
|
1183
|
+
* TagInfo
|
|
1184
|
+
* @description Tag information for preference center display.
|
|
1185
|
+
*/
|
|
1186
|
+
TagInfo: {
|
|
1187
|
+
/**
|
|
1188
|
+
* Id
|
|
1189
|
+
* Format: uuid
|
|
1190
|
+
*/
|
|
1191
|
+
id: string;
|
|
1192
|
+
/** Name */
|
|
1193
|
+
name: string;
|
|
1194
|
+
/** Description */
|
|
1195
|
+
description?: string | null;
|
|
1196
|
+
/** Category */
|
|
1197
|
+
category?: string | null;
|
|
1198
|
+
/**
|
|
1199
|
+
* Is Subscribed
|
|
1200
|
+
* @default false
|
|
1201
|
+
*/
|
|
1202
|
+
is_subscribed: boolean;
|
|
1203
|
+
};
|
|
1204
|
+
/**
|
|
1205
|
+
* TagListResponse
|
|
1206
|
+
* @description Schema for paginated tag list response.
|
|
1207
|
+
*/
|
|
1208
|
+
TagListResponse: {
|
|
1209
|
+
/** Items */
|
|
1210
|
+
items: components["schemas"]["TagResponse"][];
|
|
1211
|
+
/** Total */
|
|
1212
|
+
total: number;
|
|
1213
|
+
/**
|
|
1214
|
+
* Cursor
|
|
1215
|
+
* @description Cursor for next page (null if no more items)
|
|
1216
|
+
*/
|
|
1217
|
+
cursor?: string | null;
|
|
1218
|
+
/**
|
|
1219
|
+
* Has More
|
|
1220
|
+
* @description Whether there are more items
|
|
1221
|
+
* @default false
|
|
1222
|
+
*/
|
|
1223
|
+
has_more: boolean;
|
|
1224
|
+
};
|
|
1225
|
+
/**
|
|
1226
|
+
* TagResponse
|
|
1227
|
+
* @description Schema for tag response.
|
|
1228
|
+
*/
|
|
1229
|
+
TagResponse: {
|
|
1230
|
+
/**
|
|
1231
|
+
* Id
|
|
1232
|
+
* Format: uuid
|
|
1233
|
+
*/
|
|
1234
|
+
id: string;
|
|
1235
|
+
/** Name */
|
|
1236
|
+
name: string;
|
|
1237
|
+
/** Description */
|
|
1238
|
+
description: string | null;
|
|
1239
|
+
/** Category */
|
|
1240
|
+
category: string | null;
|
|
1241
|
+
/** Resend Topic Id */
|
|
1242
|
+
resend_topic_id: string | null;
|
|
1243
|
+
/** Is Public */
|
|
1244
|
+
is_public: boolean;
|
|
1245
|
+
/**
|
|
1246
|
+
* Subscriber Count
|
|
1247
|
+
* @description Number of active subscribers with this tag
|
|
1248
|
+
*/
|
|
1249
|
+
subscriber_count: number;
|
|
1250
|
+
/**
|
|
1251
|
+
* Created At
|
|
1252
|
+
* Format: date-time
|
|
1253
|
+
*/
|
|
1254
|
+
created_at: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* Updated At
|
|
1257
|
+
* Format: date-time
|
|
1258
|
+
*/
|
|
1259
|
+
updated_at: string;
|
|
1260
|
+
};
|
|
1261
|
+
/**
|
|
1262
|
+
* TagSortField
|
|
1263
|
+
* @description Fields available for sorting tags.
|
|
1264
|
+
* @enum {string}
|
|
1265
|
+
*/
|
|
1266
|
+
TagSortField: "name" | "created_at" | "subscriber_count";
|
|
1267
|
+
/**
|
|
1268
|
+
* TagSubscriptionResponse
|
|
1269
|
+
* @description Response schema for tag subscription/unsubscription.
|
|
1270
|
+
*/
|
|
1271
|
+
TagSubscriptionResponse: {
|
|
1272
|
+
/**
|
|
1273
|
+
* Success
|
|
1274
|
+
* @default true
|
|
1275
|
+
*/
|
|
1276
|
+
success: boolean;
|
|
1277
|
+
/**
|
|
1278
|
+
* Tag Id
|
|
1279
|
+
* Format: uuid
|
|
1280
|
+
*/
|
|
1281
|
+
tag_id: string;
|
|
1282
|
+
/** Is Subscribed */
|
|
1283
|
+
is_subscribed: boolean;
|
|
1284
|
+
/** Message */
|
|
1285
|
+
message: string;
|
|
1286
|
+
};
|
|
1287
|
+
/**
|
|
1288
|
+
* TagUpdate
|
|
1289
|
+
* @description Schema for updating an existing tag.
|
|
1290
|
+
*/
|
|
1291
|
+
TagUpdate: {
|
|
1292
|
+
/**
|
|
1293
|
+
* Name
|
|
1294
|
+
* @description New name for the tag
|
|
1295
|
+
*/
|
|
1296
|
+
name?: string | null;
|
|
1297
|
+
/**
|
|
1298
|
+
* Description
|
|
1299
|
+
* @description New description
|
|
1300
|
+
*/
|
|
1301
|
+
description?: string | null;
|
|
1302
|
+
/**
|
|
1303
|
+
* Category
|
|
1304
|
+
* @description New category
|
|
1305
|
+
*/
|
|
1306
|
+
category?: string | null;
|
|
1307
|
+
/**
|
|
1308
|
+
* Is Public
|
|
1309
|
+
* @description New visibility setting
|
|
1310
|
+
*/
|
|
1311
|
+
is_public?: boolean | null;
|
|
1312
|
+
};
|
|
1313
|
+
/**
|
|
1314
|
+
* WebhookDeliveryDetailResponse
|
|
1315
|
+
* @description Schema for webhook delivery with payload.
|
|
1316
|
+
*/
|
|
1317
|
+
WebhookDeliveryDetailResponse: {
|
|
1318
|
+
/**
|
|
1319
|
+
* Id
|
|
1320
|
+
* Format: uuid
|
|
1321
|
+
*/
|
|
1322
|
+
id: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* Endpoint Id
|
|
1325
|
+
* Format: uuid
|
|
1326
|
+
*/
|
|
1327
|
+
endpoint_id: string;
|
|
1328
|
+
/** Event Id */
|
|
1329
|
+
event_id: string;
|
|
1330
|
+
/** Event Type */
|
|
1331
|
+
event_type: string;
|
|
1332
|
+
status: components["schemas"]["WebhookDeliveryStatus"];
|
|
1333
|
+
/** Attempt Count */
|
|
1334
|
+
attempt_count: number;
|
|
1335
|
+
/** Response Status Code */
|
|
1336
|
+
response_status_code: number | null;
|
|
1337
|
+
/** Response Time Ms */
|
|
1338
|
+
response_time_ms: number | null;
|
|
1339
|
+
/** Error Message */
|
|
1340
|
+
error_message: string | null;
|
|
1341
|
+
/**
|
|
1342
|
+
* Created At
|
|
1343
|
+
* Format: date-time
|
|
1344
|
+
*/
|
|
1345
|
+
created_at: string;
|
|
1346
|
+
/** Delivered At */
|
|
1347
|
+
delivered_at: string | null;
|
|
1348
|
+
/** Next Retry At */
|
|
1349
|
+
next_retry_at: string | null;
|
|
1350
|
+
/** Payload */
|
|
1351
|
+
payload: {
|
|
1352
|
+
[key: string]: unknown;
|
|
1353
|
+
};
|
|
1354
|
+
/** Response Body */
|
|
1355
|
+
response_body: string | null;
|
|
1356
|
+
};
|
|
1357
|
+
/**
|
|
1358
|
+
* WebhookDeliveryResponse
|
|
1359
|
+
* @description Schema for webhook delivery responses.
|
|
1360
|
+
*/
|
|
1361
|
+
WebhookDeliveryResponse: {
|
|
1362
|
+
/**
|
|
1363
|
+
* Id
|
|
1364
|
+
* Format: uuid
|
|
1365
|
+
*/
|
|
1366
|
+
id: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* Endpoint Id
|
|
1369
|
+
* Format: uuid
|
|
1370
|
+
*/
|
|
1371
|
+
endpoint_id: string;
|
|
1372
|
+
/** Event Id */
|
|
1373
|
+
event_id: string;
|
|
1374
|
+
/** Event Type */
|
|
1375
|
+
event_type: string;
|
|
1376
|
+
status: components["schemas"]["WebhookDeliveryStatus"];
|
|
1377
|
+
/** Attempt Count */
|
|
1378
|
+
attempt_count: number;
|
|
1379
|
+
/** Response Status Code */
|
|
1380
|
+
response_status_code: number | null;
|
|
1381
|
+
/** Response Time Ms */
|
|
1382
|
+
response_time_ms: number | null;
|
|
1383
|
+
/** Error Message */
|
|
1384
|
+
error_message: string | null;
|
|
1385
|
+
/**
|
|
1386
|
+
* Created At
|
|
1387
|
+
* Format: date-time
|
|
1388
|
+
*/
|
|
1389
|
+
created_at: string;
|
|
1390
|
+
/** Delivered At */
|
|
1391
|
+
delivered_at: string | null;
|
|
1392
|
+
/** Next Retry At */
|
|
1393
|
+
next_retry_at: string | null;
|
|
1394
|
+
};
|
|
1395
|
+
/**
|
|
1396
|
+
* WebhookDeliveryStatsResponse
|
|
1397
|
+
* @description Schema for webhook delivery statistics.
|
|
1398
|
+
*/
|
|
1399
|
+
WebhookDeliveryStatsResponse: {
|
|
1400
|
+
/** Total Deliveries */
|
|
1401
|
+
total_deliveries: number;
|
|
1402
|
+
/** Successful Deliveries */
|
|
1403
|
+
successful_deliveries: number;
|
|
1404
|
+
/** Failed Deliveries */
|
|
1405
|
+
failed_deliveries: number;
|
|
1406
|
+
/** Pending Deliveries */
|
|
1407
|
+
pending_deliveries: number;
|
|
1408
|
+
/**
|
|
1409
|
+
* Success Rate
|
|
1410
|
+
* @description Success rate as percentage
|
|
1411
|
+
*/
|
|
1412
|
+
success_rate: number;
|
|
1413
|
+
/** Avg Response Time Ms */
|
|
1414
|
+
avg_response_time_ms: number | null;
|
|
1415
|
+
};
|
|
1416
|
+
/**
|
|
1417
|
+
* WebhookDeliveryStatus
|
|
1418
|
+
* @description Status of a webhook delivery attempt.
|
|
1419
|
+
* @enum {string}
|
|
1420
|
+
*/
|
|
1421
|
+
WebhookDeliveryStatus: "pending" | "delivered" | "failed" | "retrying";
|
|
1422
|
+
/**
|
|
1423
|
+
* WebhookEndpointCreate
|
|
1424
|
+
* @description Schema for creating a webhook endpoint.
|
|
1425
|
+
*/
|
|
1426
|
+
WebhookEndpointCreate: {
|
|
1427
|
+
/**
|
|
1428
|
+
* Url
|
|
1429
|
+
* Format: uri
|
|
1430
|
+
* @description URL to receive webhook events
|
|
1431
|
+
* @example https://api.example.com/webhooks/subscribeflow
|
|
1432
|
+
*/
|
|
1433
|
+
url: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* Description
|
|
1436
|
+
* @description Optional description of this webhook endpoint
|
|
1437
|
+
*/
|
|
1438
|
+
description?: string | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* Events
|
|
1441
|
+
* @description List of event types to subscribe to
|
|
1442
|
+
* @example [
|
|
1443
|
+
* "subscriber.created",
|
|
1444
|
+
* "subscriber.updated"
|
|
1445
|
+
* ]
|
|
1446
|
+
*/
|
|
1447
|
+
events: components["schemas"]["WebhookEventType"][];
|
|
1448
|
+
};
|
|
1449
|
+
/**
|
|
1450
|
+
* WebhookEndpointResponse
|
|
1451
|
+
* @description Schema for webhook endpoint responses.
|
|
1452
|
+
*/
|
|
1453
|
+
WebhookEndpointResponse: {
|
|
1454
|
+
/**
|
|
1455
|
+
* Id
|
|
1456
|
+
* Format: uuid
|
|
1457
|
+
*/
|
|
1458
|
+
id: string;
|
|
1459
|
+
/** Url */
|
|
1460
|
+
url: string;
|
|
1461
|
+
/** Description */
|
|
1462
|
+
description: string | null;
|
|
1463
|
+
/** Events */
|
|
1464
|
+
events: string[];
|
|
1465
|
+
/** Is Active */
|
|
1466
|
+
is_active: boolean;
|
|
1467
|
+
/** Last Triggered At */
|
|
1468
|
+
last_triggered_at: string | null;
|
|
1469
|
+
/** Failure Count */
|
|
1470
|
+
failure_count: number;
|
|
1471
|
+
/**
|
|
1472
|
+
* Created At
|
|
1473
|
+
* Format: date-time
|
|
1474
|
+
*/
|
|
1475
|
+
created_at: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* Updated At
|
|
1478
|
+
* Format: date-time
|
|
1479
|
+
*/
|
|
1480
|
+
updated_at: string;
|
|
1481
|
+
};
|
|
1482
|
+
/**
|
|
1483
|
+
* WebhookEndpointUpdate
|
|
1484
|
+
* @description Schema for updating a webhook endpoint.
|
|
1485
|
+
*/
|
|
1486
|
+
WebhookEndpointUpdate: {
|
|
1487
|
+
/**
|
|
1488
|
+
* Url
|
|
1489
|
+
* @description URL to receive webhook events
|
|
1490
|
+
*/
|
|
1491
|
+
url?: string | null;
|
|
1492
|
+
/**
|
|
1493
|
+
* Description
|
|
1494
|
+
* @description Optional description of this webhook endpoint
|
|
1495
|
+
*/
|
|
1496
|
+
description?: string | null;
|
|
1497
|
+
/**
|
|
1498
|
+
* Events
|
|
1499
|
+
* @description List of event types to subscribe to
|
|
1500
|
+
*/
|
|
1501
|
+
events?: components["schemas"]["WebhookEventType"][] | null;
|
|
1502
|
+
/**
|
|
1503
|
+
* Is Active
|
|
1504
|
+
* @description Whether this endpoint is active
|
|
1505
|
+
*/
|
|
1506
|
+
is_active?: boolean | null;
|
|
1507
|
+
};
|
|
1508
|
+
/**
|
|
1509
|
+
* WebhookEndpointWithSecret
|
|
1510
|
+
* @description Schema for webhook endpoint with secret (only shown on create).
|
|
1511
|
+
*/
|
|
1512
|
+
WebhookEndpointWithSecret: {
|
|
1513
|
+
/**
|
|
1514
|
+
* Id
|
|
1515
|
+
* Format: uuid
|
|
1516
|
+
*/
|
|
1517
|
+
id: string;
|
|
1518
|
+
/** Url */
|
|
1519
|
+
url: string;
|
|
1520
|
+
/** Description */
|
|
1521
|
+
description: string | null;
|
|
1522
|
+
/** Events */
|
|
1523
|
+
events: string[];
|
|
1524
|
+
/** Is Active */
|
|
1525
|
+
is_active: boolean;
|
|
1526
|
+
/** Last Triggered At */
|
|
1527
|
+
last_triggered_at: string | null;
|
|
1528
|
+
/** Failure Count */
|
|
1529
|
+
failure_count: number;
|
|
1530
|
+
/**
|
|
1531
|
+
* Created At
|
|
1532
|
+
* Format: date-time
|
|
1533
|
+
*/
|
|
1534
|
+
created_at: string;
|
|
1535
|
+
/**
|
|
1536
|
+
* Updated At
|
|
1537
|
+
* Format: date-time
|
|
1538
|
+
*/
|
|
1539
|
+
updated_at: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* Secret
|
|
1542
|
+
* @description Webhook signing secret (only shown once)
|
|
1543
|
+
*/
|
|
1544
|
+
secret: string;
|
|
1545
|
+
};
|
|
1546
|
+
/**
|
|
1547
|
+
* WebhookEventType
|
|
1548
|
+
* @description Types of events that can trigger outgoing webhooks.
|
|
1549
|
+
* @enum {string}
|
|
1550
|
+
*/
|
|
1551
|
+
WebhookEventType: "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "tag.subscribed" | "tag.unsubscribed";
|
|
1552
|
+
/**
|
|
1553
|
+
* WebhookResponse
|
|
1554
|
+
* @description Response schema for webhook endpoint.
|
|
1555
|
+
*/
|
|
1556
|
+
WebhookResponse: {
|
|
1557
|
+
/**
|
|
1558
|
+
* Status
|
|
1559
|
+
* @default ok
|
|
1560
|
+
*/
|
|
1561
|
+
status: string;
|
|
1562
|
+
/** Event Id */
|
|
1563
|
+
event_id?: string | null;
|
|
1564
|
+
};
|
|
1565
|
+
/**
|
|
1566
|
+
* WebhookTestRequest
|
|
1567
|
+
* @description Schema for testing a webhook endpoint.
|
|
1568
|
+
*/
|
|
1569
|
+
WebhookTestRequest: {
|
|
1570
|
+
/**
|
|
1571
|
+
* @description Event type to send as test
|
|
1572
|
+
* @default subscriber.created
|
|
1573
|
+
*/
|
|
1574
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1575
|
+
};
|
|
1576
|
+
/**
|
|
1577
|
+
* WebhookTestResponse
|
|
1578
|
+
* @description Schema for webhook test response.
|
|
1579
|
+
*/
|
|
1580
|
+
WebhookTestResponse: {
|
|
1581
|
+
/** Success */
|
|
1582
|
+
success: boolean;
|
|
1583
|
+
/** Status Code */
|
|
1584
|
+
status_code: number | null;
|
|
1585
|
+
/** Response Time Ms */
|
|
1586
|
+
response_time_ms: number | null;
|
|
1587
|
+
/** Error */
|
|
1588
|
+
error?: string | null;
|
|
1589
|
+
};
|
|
1590
|
+
/** @description RFC 7807 Problem Details for HTTP APIs */
|
|
1591
|
+
ProblemDetail: {
|
|
1592
|
+
/**
|
|
1593
|
+
* Format: uri
|
|
1594
|
+
* @description A URI reference that identifies the problem type
|
|
1595
|
+
* @example https://subscribeflow.net/errors/not_found
|
|
1596
|
+
*/
|
|
1597
|
+
type: string;
|
|
1598
|
+
/**
|
|
1599
|
+
* @description A short, human-readable summary of the problem type
|
|
1600
|
+
* @example Resource Not Found
|
|
1601
|
+
*/
|
|
1602
|
+
title: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* @description The HTTP status code
|
|
1605
|
+
* @example 404
|
|
1606
|
+
*/
|
|
1607
|
+
status: number;
|
|
1608
|
+
/**
|
|
1609
|
+
* @description A human-readable explanation specific to this occurrence
|
|
1610
|
+
* @example Subscriber with ID 'abc123' not found
|
|
1611
|
+
*/
|
|
1612
|
+
detail: string;
|
|
1613
|
+
/**
|
|
1614
|
+
* Format: uri-reference
|
|
1615
|
+
* @description A URI reference that identifies the specific occurrence
|
|
1616
|
+
* @example /api/v1/subscribers/abc123
|
|
1617
|
+
*/
|
|
1618
|
+
instance?: string;
|
|
1619
|
+
};
|
|
1620
|
+
/** @description Validation error with detailed field-level errors */
|
|
1621
|
+
ValidationProblemDetail: components["schemas"]["ProblemDetail"] & {
|
|
1622
|
+
/** @description List of validation errors */
|
|
1623
|
+
errors?: {
|
|
1624
|
+
/**
|
|
1625
|
+
* @description Location of the error (field path)
|
|
1626
|
+
* @example [
|
|
1627
|
+
* "body",
|
|
1628
|
+
* "email"
|
|
1629
|
+
* ]
|
|
1630
|
+
*/
|
|
1631
|
+
loc?: string[];
|
|
1632
|
+
/**
|
|
1633
|
+
* @description Error message
|
|
1634
|
+
* @example value is not a valid email address
|
|
1635
|
+
*/
|
|
1636
|
+
msg?: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* @description Error type
|
|
1639
|
+
* @example value_error.email
|
|
1640
|
+
*/
|
|
1641
|
+
type?: string;
|
|
1642
|
+
}[];
|
|
1643
|
+
};
|
|
1644
|
+
};
|
|
1645
|
+
responses: never;
|
|
1646
|
+
parameters: never;
|
|
1647
|
+
requestBodies: never;
|
|
1648
|
+
headers: never;
|
|
1649
|
+
pathItems: never;
|
|
1650
|
+
}
|
|
1651
|
+
export type $defs = Record<string, never>;
|
|
1652
|
+
export interface operations {
|
|
1653
|
+
health_health_get: {
|
|
1654
|
+
parameters: {
|
|
1655
|
+
query?: never;
|
|
1656
|
+
header?: never;
|
|
1657
|
+
path?: never;
|
|
1658
|
+
cookie?: never;
|
|
1659
|
+
};
|
|
1660
|
+
requestBody?: never;
|
|
1661
|
+
responses: {
|
|
1662
|
+
/** @description Successful Response */
|
|
1663
|
+
200: {
|
|
1664
|
+
headers: {
|
|
1665
|
+
[name: string]: unknown;
|
|
1666
|
+
};
|
|
1667
|
+
content: {
|
|
1668
|
+
"application/json": components["schemas"]["LivenessResponse"];
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
/** @description Bad Request */
|
|
1672
|
+
400: {
|
|
1673
|
+
headers: {
|
|
1674
|
+
[name: string]: unknown;
|
|
1675
|
+
};
|
|
1676
|
+
content?: never;
|
|
1677
|
+
};
|
|
1678
|
+
/** @description Authentication Required */
|
|
1679
|
+
401: {
|
|
1680
|
+
headers: {
|
|
1681
|
+
[name: string]: unknown;
|
|
1682
|
+
};
|
|
1683
|
+
content?: never;
|
|
1684
|
+
};
|
|
1685
|
+
/** @description Access Denied */
|
|
1686
|
+
403: {
|
|
1687
|
+
headers: {
|
|
1688
|
+
[name: string]: unknown;
|
|
1689
|
+
};
|
|
1690
|
+
content?: never;
|
|
1691
|
+
};
|
|
1692
|
+
/** @description Resource Not Found */
|
|
1693
|
+
404: {
|
|
1694
|
+
headers: {
|
|
1695
|
+
[name: string]: unknown;
|
|
1696
|
+
};
|
|
1697
|
+
content?: never;
|
|
1698
|
+
};
|
|
1699
|
+
/** @description Resource Conflict */
|
|
1700
|
+
409: {
|
|
1701
|
+
headers: {
|
|
1702
|
+
[name: string]: unknown;
|
|
1703
|
+
};
|
|
1704
|
+
content?: never;
|
|
1705
|
+
};
|
|
1706
|
+
/** @description Validation Error */
|
|
1707
|
+
422: {
|
|
1708
|
+
headers: {
|
|
1709
|
+
[name: string]: unknown;
|
|
1710
|
+
};
|
|
1711
|
+
content?: never;
|
|
1712
|
+
};
|
|
1713
|
+
/** @description Internal Server Error */
|
|
1714
|
+
500: {
|
|
1715
|
+
headers: {
|
|
1716
|
+
[name: string]: unknown;
|
|
1717
|
+
};
|
|
1718
|
+
content?: never;
|
|
1719
|
+
};
|
|
1720
|
+
};
|
|
1721
|
+
};
|
|
1722
|
+
ready_ready_get: {
|
|
1723
|
+
parameters: {
|
|
1724
|
+
query?: never;
|
|
1725
|
+
header?: never;
|
|
1726
|
+
path?: never;
|
|
1727
|
+
cookie?: never;
|
|
1728
|
+
};
|
|
1729
|
+
requestBody?: never;
|
|
1730
|
+
responses: {
|
|
1731
|
+
/** @description Service is ready to accept traffic */
|
|
1732
|
+
200: {
|
|
1733
|
+
headers: {
|
|
1734
|
+
[name: string]: unknown;
|
|
1735
|
+
};
|
|
1736
|
+
content: {
|
|
1737
|
+
"application/json": components["schemas"]["HealthResponse"];
|
|
1738
|
+
};
|
|
1739
|
+
};
|
|
1740
|
+
/** @description Bad Request */
|
|
1741
|
+
400: {
|
|
1742
|
+
headers: {
|
|
1743
|
+
[name: string]: unknown;
|
|
1744
|
+
};
|
|
1745
|
+
content?: never;
|
|
1746
|
+
};
|
|
1747
|
+
/** @description Authentication Required */
|
|
1748
|
+
401: {
|
|
1749
|
+
headers: {
|
|
1750
|
+
[name: string]: unknown;
|
|
1751
|
+
};
|
|
1752
|
+
content?: never;
|
|
1753
|
+
};
|
|
1754
|
+
/** @description Access Denied */
|
|
1755
|
+
403: {
|
|
1756
|
+
headers: {
|
|
1757
|
+
[name: string]: unknown;
|
|
1758
|
+
};
|
|
1759
|
+
content?: never;
|
|
1760
|
+
};
|
|
1761
|
+
/** @description Resource Not Found */
|
|
1762
|
+
404: {
|
|
1763
|
+
headers: {
|
|
1764
|
+
[name: string]: unknown;
|
|
1765
|
+
};
|
|
1766
|
+
content?: never;
|
|
1767
|
+
};
|
|
1768
|
+
/** @description Resource Conflict */
|
|
1769
|
+
409: {
|
|
1770
|
+
headers: {
|
|
1771
|
+
[name: string]: unknown;
|
|
1772
|
+
};
|
|
1773
|
+
content?: never;
|
|
1774
|
+
};
|
|
1775
|
+
/** @description Validation Error */
|
|
1776
|
+
422: {
|
|
1777
|
+
headers: {
|
|
1778
|
+
[name: string]: unknown;
|
|
1779
|
+
};
|
|
1780
|
+
content?: never;
|
|
1781
|
+
};
|
|
1782
|
+
/** @description Internal Server Error */
|
|
1783
|
+
500: {
|
|
1784
|
+
headers: {
|
|
1785
|
+
[name: string]: unknown;
|
|
1786
|
+
};
|
|
1787
|
+
content?: never;
|
|
1788
|
+
};
|
|
1789
|
+
/** @description Service is not ready */
|
|
1790
|
+
503: {
|
|
1791
|
+
headers: {
|
|
1792
|
+
[name: string]: unknown;
|
|
1793
|
+
};
|
|
1794
|
+
content?: never;
|
|
1795
|
+
};
|
|
1796
|
+
};
|
|
1797
|
+
};
|
|
1798
|
+
info_info_get: {
|
|
1799
|
+
parameters: {
|
|
1800
|
+
query?: never;
|
|
1801
|
+
header?: never;
|
|
1802
|
+
path?: never;
|
|
1803
|
+
cookie?: never;
|
|
1804
|
+
};
|
|
1805
|
+
requestBody?: never;
|
|
1806
|
+
responses: {
|
|
1807
|
+
/** @description Successful Response */
|
|
1808
|
+
200: {
|
|
1809
|
+
headers: {
|
|
1810
|
+
[name: string]: unknown;
|
|
1811
|
+
};
|
|
1812
|
+
content: {
|
|
1813
|
+
"application/json": {
|
|
1814
|
+
[key: string]: unknown;
|
|
1815
|
+
};
|
|
1816
|
+
};
|
|
1817
|
+
};
|
|
1818
|
+
/** @description Bad Request */
|
|
1819
|
+
400: {
|
|
1820
|
+
headers: {
|
|
1821
|
+
[name: string]: unknown;
|
|
1822
|
+
};
|
|
1823
|
+
content?: never;
|
|
1824
|
+
};
|
|
1825
|
+
/** @description Authentication Required */
|
|
1826
|
+
401: {
|
|
1827
|
+
headers: {
|
|
1828
|
+
[name: string]: unknown;
|
|
1829
|
+
};
|
|
1830
|
+
content?: never;
|
|
1831
|
+
};
|
|
1832
|
+
/** @description Access Denied */
|
|
1833
|
+
403: {
|
|
1834
|
+
headers: {
|
|
1835
|
+
[name: string]: unknown;
|
|
1836
|
+
};
|
|
1837
|
+
content?: never;
|
|
1838
|
+
};
|
|
1839
|
+
/** @description Resource Not Found */
|
|
1840
|
+
404: {
|
|
1841
|
+
headers: {
|
|
1842
|
+
[name: string]: unknown;
|
|
1843
|
+
};
|
|
1844
|
+
content?: never;
|
|
1845
|
+
};
|
|
1846
|
+
/** @description Resource Conflict */
|
|
1847
|
+
409: {
|
|
1848
|
+
headers: {
|
|
1849
|
+
[name: string]: unknown;
|
|
1850
|
+
};
|
|
1851
|
+
content?: never;
|
|
1852
|
+
};
|
|
1853
|
+
/** @description Validation Error */
|
|
1854
|
+
422: {
|
|
1855
|
+
headers: {
|
|
1856
|
+
[name: string]: unknown;
|
|
1857
|
+
};
|
|
1858
|
+
content?: never;
|
|
1859
|
+
};
|
|
1860
|
+
/** @description Internal Server Error */
|
|
1861
|
+
500: {
|
|
1862
|
+
headers: {
|
|
1863
|
+
[name: string]: unknown;
|
|
1864
|
+
};
|
|
1865
|
+
content?: never;
|
|
1866
|
+
};
|
|
1867
|
+
};
|
|
1868
|
+
};
|
|
1869
|
+
handle_resend_webhook_webhooks_resend_post: {
|
|
1870
|
+
parameters: {
|
|
1871
|
+
query?: never;
|
|
1872
|
+
header?: {
|
|
1873
|
+
"x-resend-signature"?: string;
|
|
1874
|
+
"x-resend-event-id"?: string;
|
|
1875
|
+
};
|
|
1876
|
+
path?: never;
|
|
1877
|
+
cookie?: never;
|
|
1878
|
+
};
|
|
1879
|
+
requestBody?: never;
|
|
1880
|
+
responses: {
|
|
1881
|
+
/** @description Webhook processed successfully (including duplicates) */
|
|
1882
|
+
200: {
|
|
1883
|
+
headers: {
|
|
1884
|
+
[name: string]: unknown;
|
|
1885
|
+
};
|
|
1886
|
+
content: {
|
|
1887
|
+
"application/json": components["schemas"]["WebhookResponse"];
|
|
1888
|
+
};
|
|
1889
|
+
};
|
|
1890
|
+
/** @description Invalid webhook payload or timestamp */
|
|
1891
|
+
400: {
|
|
1892
|
+
headers: {
|
|
1893
|
+
[name: string]: unknown;
|
|
1894
|
+
};
|
|
1895
|
+
content?: never;
|
|
1896
|
+
};
|
|
1897
|
+
/** @description Invalid webhook signature */
|
|
1898
|
+
401: {
|
|
1899
|
+
headers: {
|
|
1900
|
+
[name: string]: unknown;
|
|
1901
|
+
};
|
|
1902
|
+
content?: never;
|
|
1903
|
+
};
|
|
1904
|
+
/** @description Access Denied */
|
|
1905
|
+
403: {
|
|
1906
|
+
headers: {
|
|
1907
|
+
[name: string]: unknown;
|
|
1908
|
+
};
|
|
1909
|
+
content?: never;
|
|
1910
|
+
};
|
|
1911
|
+
/** @description Resource Not Found */
|
|
1912
|
+
404: {
|
|
1913
|
+
headers: {
|
|
1914
|
+
[name: string]: unknown;
|
|
1915
|
+
};
|
|
1916
|
+
content?: never;
|
|
1917
|
+
};
|
|
1918
|
+
/** @description Resource Conflict */
|
|
1919
|
+
409: {
|
|
1920
|
+
headers: {
|
|
1921
|
+
[name: string]: unknown;
|
|
1922
|
+
};
|
|
1923
|
+
content?: never;
|
|
1924
|
+
};
|
|
1925
|
+
/** @description Validation Error */
|
|
1926
|
+
422: {
|
|
1927
|
+
headers: {
|
|
1928
|
+
[name: string]: unknown;
|
|
1929
|
+
};
|
|
1930
|
+
content?: never;
|
|
1931
|
+
};
|
|
1932
|
+
/** @description Internal server error */
|
|
1933
|
+
500: {
|
|
1934
|
+
headers: {
|
|
1935
|
+
[name: string]: unknown;
|
|
1936
|
+
};
|
|
1937
|
+
content?: never;
|
|
1938
|
+
};
|
|
1939
|
+
};
|
|
1940
|
+
};
|
|
1941
|
+
get_preferences_preference_center_get: {
|
|
1942
|
+
parameters: {
|
|
1943
|
+
query?: {
|
|
1944
|
+
/** @description Preference center access token */
|
|
1945
|
+
token?: string | null;
|
|
1946
|
+
};
|
|
1947
|
+
header?: never;
|
|
1948
|
+
path?: never;
|
|
1949
|
+
cookie?: never;
|
|
1950
|
+
};
|
|
1951
|
+
requestBody?: never;
|
|
1952
|
+
responses: {
|
|
1953
|
+
/** @description Successful Response */
|
|
1954
|
+
200: {
|
|
1955
|
+
headers: {
|
|
1956
|
+
[name: string]: unknown;
|
|
1957
|
+
};
|
|
1958
|
+
content: {
|
|
1959
|
+
"application/json": components["schemas"]["PreferenceCenterResponse"];
|
|
1960
|
+
};
|
|
1961
|
+
};
|
|
1962
|
+
/** @description Bad Request */
|
|
1963
|
+
400: {
|
|
1964
|
+
headers: {
|
|
1965
|
+
[name: string]: unknown;
|
|
1966
|
+
};
|
|
1967
|
+
content?: never;
|
|
1968
|
+
};
|
|
1969
|
+
/** @description Authentication Required */
|
|
1970
|
+
401: {
|
|
1971
|
+
headers: {
|
|
1972
|
+
[name: string]: unknown;
|
|
1973
|
+
};
|
|
1974
|
+
content?: never;
|
|
1975
|
+
};
|
|
1976
|
+
/** @description Access Denied */
|
|
1977
|
+
403: {
|
|
1978
|
+
headers: {
|
|
1979
|
+
[name: string]: unknown;
|
|
1980
|
+
};
|
|
1981
|
+
content?: never;
|
|
1982
|
+
};
|
|
1983
|
+
/** @description Resource Not Found */
|
|
1984
|
+
404: {
|
|
1985
|
+
headers: {
|
|
1986
|
+
[name: string]: unknown;
|
|
1987
|
+
};
|
|
1988
|
+
content?: never;
|
|
1989
|
+
};
|
|
1990
|
+
/** @description Resource Conflict */
|
|
1991
|
+
409: {
|
|
1992
|
+
headers: {
|
|
1993
|
+
[name: string]: unknown;
|
|
1994
|
+
};
|
|
1995
|
+
content?: never;
|
|
1996
|
+
};
|
|
1997
|
+
/** @description Validation Error */
|
|
1998
|
+
422: {
|
|
1999
|
+
headers: {
|
|
2000
|
+
[name: string]: unknown;
|
|
2001
|
+
};
|
|
2002
|
+
content?: never;
|
|
2003
|
+
};
|
|
2004
|
+
/** @description Internal Server Error */
|
|
2005
|
+
500: {
|
|
2006
|
+
headers: {
|
|
2007
|
+
[name: string]: unknown;
|
|
2008
|
+
};
|
|
2009
|
+
content?: never;
|
|
2010
|
+
};
|
|
2011
|
+
};
|
|
2012
|
+
};
|
|
2013
|
+
subscribe_to_tag_preference_center_tags__tag_id__put: {
|
|
2014
|
+
parameters: {
|
|
2015
|
+
query?: {
|
|
2016
|
+
/** @description Preference center access token */
|
|
2017
|
+
token?: string | null;
|
|
2018
|
+
};
|
|
2019
|
+
header?: never;
|
|
2020
|
+
path: {
|
|
2021
|
+
tag_id: string;
|
|
2022
|
+
};
|
|
2023
|
+
cookie?: never;
|
|
2024
|
+
};
|
|
2025
|
+
requestBody?: never;
|
|
2026
|
+
responses: {
|
|
2027
|
+
/** @description Successful Response */
|
|
2028
|
+
200: {
|
|
2029
|
+
headers: {
|
|
2030
|
+
[name: string]: unknown;
|
|
2031
|
+
};
|
|
2032
|
+
content: {
|
|
2033
|
+
"application/json": components["schemas"]["TagSubscriptionResponse"];
|
|
2034
|
+
};
|
|
2035
|
+
};
|
|
2036
|
+
/** @description Bad Request */
|
|
2037
|
+
400: {
|
|
2038
|
+
headers: {
|
|
2039
|
+
[name: string]: unknown;
|
|
2040
|
+
};
|
|
2041
|
+
content?: never;
|
|
2042
|
+
};
|
|
2043
|
+
/** @description Authentication Required */
|
|
2044
|
+
401: {
|
|
2045
|
+
headers: {
|
|
2046
|
+
[name: string]: unknown;
|
|
2047
|
+
};
|
|
2048
|
+
content?: never;
|
|
2049
|
+
};
|
|
2050
|
+
/** @description Access Denied */
|
|
2051
|
+
403: {
|
|
2052
|
+
headers: {
|
|
2053
|
+
[name: string]: unknown;
|
|
2054
|
+
};
|
|
2055
|
+
content?: never;
|
|
2056
|
+
};
|
|
2057
|
+
/** @description Resource Not Found */
|
|
2058
|
+
404: {
|
|
2059
|
+
headers: {
|
|
2060
|
+
[name: string]: unknown;
|
|
2061
|
+
};
|
|
2062
|
+
content?: never;
|
|
2063
|
+
};
|
|
2064
|
+
/** @description Resource Conflict */
|
|
2065
|
+
409: {
|
|
2066
|
+
headers: {
|
|
2067
|
+
[name: string]: unknown;
|
|
2068
|
+
};
|
|
2069
|
+
content?: never;
|
|
2070
|
+
};
|
|
2071
|
+
/** @description Validation Error */
|
|
2072
|
+
422: {
|
|
2073
|
+
headers: {
|
|
2074
|
+
[name: string]: unknown;
|
|
2075
|
+
};
|
|
2076
|
+
content?: never;
|
|
2077
|
+
};
|
|
2078
|
+
/** @description Internal Server Error */
|
|
2079
|
+
500: {
|
|
2080
|
+
headers: {
|
|
2081
|
+
[name: string]: unknown;
|
|
2082
|
+
};
|
|
2083
|
+
content?: never;
|
|
2084
|
+
};
|
|
2085
|
+
};
|
|
2086
|
+
};
|
|
2087
|
+
unsubscribe_from_tag_preference_center_tags__tag_id__delete: {
|
|
2088
|
+
parameters: {
|
|
2089
|
+
query?: {
|
|
2090
|
+
/** @description Preference center access token */
|
|
2091
|
+
token?: string | null;
|
|
2092
|
+
};
|
|
2093
|
+
header?: never;
|
|
2094
|
+
path: {
|
|
2095
|
+
tag_id: string;
|
|
2096
|
+
};
|
|
2097
|
+
cookie?: never;
|
|
2098
|
+
};
|
|
2099
|
+
requestBody?: never;
|
|
2100
|
+
responses: {
|
|
2101
|
+
/** @description Successful Response */
|
|
2102
|
+
200: {
|
|
2103
|
+
headers: {
|
|
2104
|
+
[name: string]: unknown;
|
|
2105
|
+
};
|
|
2106
|
+
content: {
|
|
2107
|
+
"application/json": components["schemas"]["TagSubscriptionResponse"];
|
|
2108
|
+
};
|
|
2109
|
+
};
|
|
2110
|
+
/** @description Bad Request */
|
|
2111
|
+
400: {
|
|
2112
|
+
headers: {
|
|
2113
|
+
[name: string]: unknown;
|
|
2114
|
+
};
|
|
2115
|
+
content?: never;
|
|
2116
|
+
};
|
|
2117
|
+
/** @description Authentication Required */
|
|
2118
|
+
401: {
|
|
2119
|
+
headers: {
|
|
2120
|
+
[name: string]: unknown;
|
|
2121
|
+
};
|
|
2122
|
+
content?: never;
|
|
2123
|
+
};
|
|
2124
|
+
/** @description Access Denied */
|
|
2125
|
+
403: {
|
|
2126
|
+
headers: {
|
|
2127
|
+
[name: string]: unknown;
|
|
2128
|
+
};
|
|
2129
|
+
content?: never;
|
|
2130
|
+
};
|
|
2131
|
+
/** @description Resource Not Found */
|
|
2132
|
+
404: {
|
|
2133
|
+
headers: {
|
|
2134
|
+
[name: string]: unknown;
|
|
2135
|
+
};
|
|
2136
|
+
content?: never;
|
|
2137
|
+
};
|
|
2138
|
+
/** @description Resource Conflict */
|
|
2139
|
+
409: {
|
|
2140
|
+
headers: {
|
|
2141
|
+
[name: string]: unknown;
|
|
2142
|
+
};
|
|
2143
|
+
content?: never;
|
|
2144
|
+
};
|
|
2145
|
+
/** @description Validation Error */
|
|
2146
|
+
422: {
|
|
2147
|
+
headers: {
|
|
2148
|
+
[name: string]: unknown;
|
|
2149
|
+
};
|
|
2150
|
+
content?: never;
|
|
2151
|
+
};
|
|
2152
|
+
/** @description Internal Server Error */
|
|
2153
|
+
500: {
|
|
2154
|
+
headers: {
|
|
2155
|
+
[name: string]: unknown;
|
|
2156
|
+
};
|
|
2157
|
+
content?: never;
|
|
2158
|
+
};
|
|
2159
|
+
};
|
|
2160
|
+
};
|
|
2161
|
+
export_data_preference_center_data_export_get: {
|
|
2162
|
+
parameters: {
|
|
2163
|
+
query?: {
|
|
2164
|
+
/** @description Preference center access token */
|
|
2165
|
+
token?: string | null;
|
|
2166
|
+
};
|
|
2167
|
+
header?: never;
|
|
2168
|
+
path?: never;
|
|
2169
|
+
cookie?: never;
|
|
2170
|
+
};
|
|
2171
|
+
requestBody?: never;
|
|
2172
|
+
responses: {
|
|
2173
|
+
/** @description Successful Response */
|
|
2174
|
+
200: {
|
|
2175
|
+
headers: {
|
|
2176
|
+
[name: string]: unknown;
|
|
2177
|
+
};
|
|
2178
|
+
content: {
|
|
2179
|
+
"application/json": components["schemas"]["DataExportResponse"];
|
|
2180
|
+
};
|
|
2181
|
+
};
|
|
2182
|
+
/** @description Bad Request */
|
|
2183
|
+
400: {
|
|
2184
|
+
headers: {
|
|
2185
|
+
[name: string]: unknown;
|
|
2186
|
+
};
|
|
2187
|
+
content?: never;
|
|
2188
|
+
};
|
|
2189
|
+
/** @description Authentication Required */
|
|
2190
|
+
401: {
|
|
2191
|
+
headers: {
|
|
2192
|
+
[name: string]: unknown;
|
|
2193
|
+
};
|
|
2194
|
+
content?: never;
|
|
2195
|
+
};
|
|
2196
|
+
/** @description Access Denied */
|
|
2197
|
+
403: {
|
|
2198
|
+
headers: {
|
|
2199
|
+
[name: string]: unknown;
|
|
2200
|
+
};
|
|
2201
|
+
content?: never;
|
|
2202
|
+
};
|
|
2203
|
+
/** @description Resource Not Found */
|
|
2204
|
+
404: {
|
|
2205
|
+
headers: {
|
|
2206
|
+
[name: string]: unknown;
|
|
2207
|
+
};
|
|
2208
|
+
content?: never;
|
|
2209
|
+
};
|
|
2210
|
+
/** @description Resource Conflict */
|
|
2211
|
+
409: {
|
|
2212
|
+
headers: {
|
|
2213
|
+
[name: string]: unknown;
|
|
2214
|
+
};
|
|
2215
|
+
content?: never;
|
|
2216
|
+
};
|
|
2217
|
+
/** @description Validation Error */
|
|
2218
|
+
422: {
|
|
2219
|
+
headers: {
|
|
2220
|
+
[name: string]: unknown;
|
|
2221
|
+
};
|
|
2222
|
+
content?: never;
|
|
2223
|
+
};
|
|
2224
|
+
/** @description Internal Server Error */
|
|
2225
|
+
500: {
|
|
2226
|
+
headers: {
|
|
2227
|
+
[name: string]: unknown;
|
|
2228
|
+
};
|
|
2229
|
+
content?: never;
|
|
2230
|
+
};
|
|
2231
|
+
};
|
|
2232
|
+
};
|
|
2233
|
+
delete_account_preference_center_account_delete: {
|
|
2234
|
+
parameters: {
|
|
2235
|
+
query?: {
|
|
2236
|
+
/** @description Preference center access token */
|
|
2237
|
+
token?: string | null;
|
|
2238
|
+
};
|
|
2239
|
+
header?: never;
|
|
2240
|
+
path?: never;
|
|
2241
|
+
cookie?: never;
|
|
2242
|
+
};
|
|
2243
|
+
requestBody?: never;
|
|
2244
|
+
responses: {
|
|
2245
|
+
/** @description Successful Response */
|
|
2246
|
+
200: {
|
|
2247
|
+
headers: {
|
|
2248
|
+
[name: string]: unknown;
|
|
2249
|
+
};
|
|
2250
|
+
content: {
|
|
2251
|
+
"application/json": components["schemas"]["AccountDeleteResponse"];
|
|
2252
|
+
};
|
|
2253
|
+
};
|
|
2254
|
+
/** @description Bad Request */
|
|
2255
|
+
400: {
|
|
2256
|
+
headers: {
|
|
2257
|
+
[name: string]: unknown;
|
|
2258
|
+
};
|
|
2259
|
+
content?: never;
|
|
2260
|
+
};
|
|
2261
|
+
/** @description Authentication Required */
|
|
2262
|
+
401: {
|
|
2263
|
+
headers: {
|
|
2264
|
+
[name: string]: unknown;
|
|
2265
|
+
};
|
|
2266
|
+
content?: never;
|
|
2267
|
+
};
|
|
2268
|
+
/** @description Access Denied */
|
|
2269
|
+
403: {
|
|
2270
|
+
headers: {
|
|
2271
|
+
[name: string]: unknown;
|
|
2272
|
+
};
|
|
2273
|
+
content?: never;
|
|
2274
|
+
};
|
|
2275
|
+
/** @description Resource Not Found */
|
|
2276
|
+
404: {
|
|
2277
|
+
headers: {
|
|
2278
|
+
[name: string]: unknown;
|
|
2279
|
+
};
|
|
2280
|
+
content?: never;
|
|
2281
|
+
};
|
|
2282
|
+
/** @description Resource Conflict */
|
|
2283
|
+
409: {
|
|
2284
|
+
headers: {
|
|
2285
|
+
[name: string]: unknown;
|
|
2286
|
+
};
|
|
2287
|
+
content?: never;
|
|
2288
|
+
};
|
|
2289
|
+
/** @description Validation Error */
|
|
2290
|
+
422: {
|
|
2291
|
+
headers: {
|
|
2292
|
+
[name: string]: unknown;
|
|
2293
|
+
};
|
|
2294
|
+
content?: never;
|
|
2295
|
+
};
|
|
2296
|
+
/** @description Internal Server Error */
|
|
2297
|
+
500: {
|
|
2298
|
+
headers: {
|
|
2299
|
+
[name: string]: unknown;
|
|
2300
|
+
};
|
|
2301
|
+
content?: never;
|
|
2302
|
+
};
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
list_scopes_api_v1_api_keys_scopes_get: {
|
|
2306
|
+
parameters: {
|
|
2307
|
+
query?: never;
|
|
2308
|
+
header?: never;
|
|
2309
|
+
path?: never;
|
|
2310
|
+
cookie?: never;
|
|
2311
|
+
};
|
|
2312
|
+
requestBody?: never;
|
|
2313
|
+
responses: {
|
|
2314
|
+
/** @description Successful Response */
|
|
2315
|
+
200: {
|
|
2316
|
+
headers: {
|
|
2317
|
+
[name: string]: unknown;
|
|
2318
|
+
};
|
|
2319
|
+
content: {
|
|
2320
|
+
"application/json": components["schemas"]["AvailableScopesResponse"];
|
|
2321
|
+
};
|
|
2322
|
+
};
|
|
2323
|
+
/** @description Bad Request */
|
|
2324
|
+
400: {
|
|
2325
|
+
headers: {
|
|
2326
|
+
[name: string]: unknown;
|
|
2327
|
+
};
|
|
2328
|
+
content?: never;
|
|
2329
|
+
};
|
|
2330
|
+
/** @description Authentication Required */
|
|
2331
|
+
401: {
|
|
2332
|
+
headers: {
|
|
2333
|
+
[name: string]: unknown;
|
|
2334
|
+
};
|
|
2335
|
+
content?: never;
|
|
2336
|
+
};
|
|
2337
|
+
/** @description Access Denied */
|
|
2338
|
+
403: {
|
|
2339
|
+
headers: {
|
|
2340
|
+
[name: string]: unknown;
|
|
2341
|
+
};
|
|
2342
|
+
content?: never;
|
|
2343
|
+
};
|
|
2344
|
+
/** @description Resource Not Found */
|
|
2345
|
+
404: {
|
|
2346
|
+
headers: {
|
|
2347
|
+
[name: string]: unknown;
|
|
2348
|
+
};
|
|
2349
|
+
content?: never;
|
|
2350
|
+
};
|
|
2351
|
+
/** @description Resource Conflict */
|
|
2352
|
+
409: {
|
|
2353
|
+
headers: {
|
|
2354
|
+
[name: string]: unknown;
|
|
2355
|
+
};
|
|
2356
|
+
content?: never;
|
|
2357
|
+
};
|
|
2358
|
+
/** @description Validation Error */
|
|
2359
|
+
422: {
|
|
2360
|
+
headers: {
|
|
2361
|
+
[name: string]: unknown;
|
|
2362
|
+
};
|
|
2363
|
+
content?: never;
|
|
2364
|
+
};
|
|
2365
|
+
/** @description Internal Server Error */
|
|
2366
|
+
500: {
|
|
2367
|
+
headers: {
|
|
2368
|
+
[name: string]: unknown;
|
|
2369
|
+
};
|
|
2370
|
+
content?: never;
|
|
2371
|
+
};
|
|
2372
|
+
};
|
|
2373
|
+
};
|
|
2374
|
+
list_api_keys_api_v1_api_keys_get: {
|
|
2375
|
+
parameters: {
|
|
2376
|
+
query?: {
|
|
2377
|
+
include_inactive?: boolean;
|
|
2378
|
+
};
|
|
2379
|
+
header?: never;
|
|
2380
|
+
path?: never;
|
|
2381
|
+
cookie?: never;
|
|
2382
|
+
};
|
|
2383
|
+
requestBody?: never;
|
|
2384
|
+
responses: {
|
|
2385
|
+
/** @description Successful Response */
|
|
2386
|
+
200: {
|
|
2387
|
+
headers: {
|
|
2388
|
+
[name: string]: unknown;
|
|
2389
|
+
};
|
|
2390
|
+
content: {
|
|
2391
|
+
"application/json": components["schemas"]["APIKeyResponse"][];
|
|
2392
|
+
};
|
|
2393
|
+
};
|
|
2394
|
+
/** @description Bad Request */
|
|
2395
|
+
400: {
|
|
2396
|
+
headers: {
|
|
2397
|
+
[name: string]: unknown;
|
|
2398
|
+
};
|
|
2399
|
+
content?: never;
|
|
2400
|
+
};
|
|
2401
|
+
/** @description Authentication Required */
|
|
2402
|
+
401: {
|
|
2403
|
+
headers: {
|
|
2404
|
+
[name: string]: unknown;
|
|
2405
|
+
};
|
|
2406
|
+
content?: never;
|
|
2407
|
+
};
|
|
2408
|
+
/** @description Access Denied */
|
|
2409
|
+
403: {
|
|
2410
|
+
headers: {
|
|
2411
|
+
[name: string]: unknown;
|
|
2412
|
+
};
|
|
2413
|
+
content?: never;
|
|
2414
|
+
};
|
|
2415
|
+
/** @description Resource Not Found */
|
|
2416
|
+
404: {
|
|
2417
|
+
headers: {
|
|
2418
|
+
[name: string]: unknown;
|
|
2419
|
+
};
|
|
2420
|
+
content?: never;
|
|
2421
|
+
};
|
|
2422
|
+
/** @description Resource Conflict */
|
|
2423
|
+
409: {
|
|
2424
|
+
headers: {
|
|
2425
|
+
[name: string]: unknown;
|
|
2426
|
+
};
|
|
2427
|
+
content?: never;
|
|
2428
|
+
};
|
|
2429
|
+
/** @description Validation Error */
|
|
2430
|
+
422: {
|
|
2431
|
+
headers: {
|
|
2432
|
+
[name: string]: unknown;
|
|
2433
|
+
};
|
|
2434
|
+
content?: never;
|
|
2435
|
+
};
|
|
2436
|
+
/** @description Internal Server Error */
|
|
2437
|
+
500: {
|
|
2438
|
+
headers: {
|
|
2439
|
+
[name: string]: unknown;
|
|
2440
|
+
};
|
|
2441
|
+
content?: never;
|
|
2442
|
+
};
|
|
2443
|
+
};
|
|
2444
|
+
};
|
|
2445
|
+
create_api_key_api_v1_api_keys_post: {
|
|
2446
|
+
parameters: {
|
|
2447
|
+
query?: never;
|
|
2448
|
+
header?: never;
|
|
2449
|
+
path?: never;
|
|
2450
|
+
cookie?: never;
|
|
2451
|
+
};
|
|
2452
|
+
requestBody: {
|
|
2453
|
+
content: {
|
|
2454
|
+
"application/json": components["schemas"]["APIKeyCreate"];
|
|
2455
|
+
};
|
|
2456
|
+
};
|
|
2457
|
+
responses: {
|
|
2458
|
+
/** @description Successful Response */
|
|
2459
|
+
201: {
|
|
2460
|
+
headers: {
|
|
2461
|
+
[name: string]: unknown;
|
|
2462
|
+
};
|
|
2463
|
+
content: {
|
|
2464
|
+
"application/json": components["schemas"]["APIKeyCreatedResponse"];
|
|
2465
|
+
};
|
|
2466
|
+
};
|
|
2467
|
+
/** @description Bad Request */
|
|
2468
|
+
400: {
|
|
2469
|
+
headers: {
|
|
2470
|
+
[name: string]: unknown;
|
|
2471
|
+
};
|
|
2472
|
+
content?: never;
|
|
2473
|
+
};
|
|
2474
|
+
/** @description Authentication Required */
|
|
2475
|
+
401: {
|
|
2476
|
+
headers: {
|
|
2477
|
+
[name: string]: unknown;
|
|
2478
|
+
};
|
|
2479
|
+
content?: never;
|
|
2480
|
+
};
|
|
2481
|
+
/** @description Access Denied */
|
|
2482
|
+
403: {
|
|
2483
|
+
headers: {
|
|
2484
|
+
[name: string]: unknown;
|
|
2485
|
+
};
|
|
2486
|
+
content?: never;
|
|
2487
|
+
};
|
|
2488
|
+
/** @description Resource Not Found */
|
|
2489
|
+
404: {
|
|
2490
|
+
headers: {
|
|
2491
|
+
[name: string]: unknown;
|
|
2492
|
+
};
|
|
2493
|
+
content?: never;
|
|
2494
|
+
};
|
|
2495
|
+
/** @description Resource Conflict */
|
|
2496
|
+
409: {
|
|
2497
|
+
headers: {
|
|
2498
|
+
[name: string]: unknown;
|
|
2499
|
+
};
|
|
2500
|
+
content?: never;
|
|
2501
|
+
};
|
|
2502
|
+
/** @description Validation Error */
|
|
2503
|
+
422: {
|
|
2504
|
+
headers: {
|
|
2505
|
+
[name: string]: unknown;
|
|
2506
|
+
};
|
|
2507
|
+
content?: never;
|
|
2508
|
+
};
|
|
2509
|
+
/** @description Internal Server Error */
|
|
2510
|
+
500: {
|
|
2511
|
+
headers: {
|
|
2512
|
+
[name: string]: unknown;
|
|
2513
|
+
};
|
|
2514
|
+
content?: never;
|
|
2515
|
+
};
|
|
2516
|
+
};
|
|
2517
|
+
};
|
|
2518
|
+
get_api_key_api_v1_api_keys__key_id__get: {
|
|
2519
|
+
parameters: {
|
|
2520
|
+
query?: never;
|
|
2521
|
+
header?: never;
|
|
2522
|
+
path: {
|
|
2523
|
+
key_id: string;
|
|
2524
|
+
};
|
|
2525
|
+
cookie?: never;
|
|
2526
|
+
};
|
|
2527
|
+
requestBody?: never;
|
|
2528
|
+
responses: {
|
|
2529
|
+
/** @description Successful Response */
|
|
2530
|
+
200: {
|
|
2531
|
+
headers: {
|
|
2532
|
+
[name: string]: unknown;
|
|
2533
|
+
};
|
|
2534
|
+
content: {
|
|
2535
|
+
"application/json": components["schemas"]["APIKeyResponse"];
|
|
2536
|
+
};
|
|
2537
|
+
};
|
|
2538
|
+
/** @description Bad Request */
|
|
2539
|
+
400: {
|
|
2540
|
+
headers: {
|
|
2541
|
+
[name: string]: unknown;
|
|
2542
|
+
};
|
|
2543
|
+
content?: never;
|
|
2544
|
+
};
|
|
2545
|
+
/** @description Authentication Required */
|
|
2546
|
+
401: {
|
|
2547
|
+
headers: {
|
|
2548
|
+
[name: string]: unknown;
|
|
2549
|
+
};
|
|
2550
|
+
content?: never;
|
|
2551
|
+
};
|
|
2552
|
+
/** @description Access Denied */
|
|
2553
|
+
403: {
|
|
2554
|
+
headers: {
|
|
2555
|
+
[name: string]: unknown;
|
|
2556
|
+
};
|
|
2557
|
+
content?: never;
|
|
2558
|
+
};
|
|
2559
|
+
/** @description Resource Not Found */
|
|
2560
|
+
404: {
|
|
2561
|
+
headers: {
|
|
2562
|
+
[name: string]: unknown;
|
|
2563
|
+
};
|
|
2564
|
+
content?: never;
|
|
2565
|
+
};
|
|
2566
|
+
/** @description Resource Conflict */
|
|
2567
|
+
409: {
|
|
2568
|
+
headers: {
|
|
2569
|
+
[name: string]: unknown;
|
|
2570
|
+
};
|
|
2571
|
+
content?: never;
|
|
2572
|
+
};
|
|
2573
|
+
/** @description Validation Error */
|
|
2574
|
+
422: {
|
|
2575
|
+
headers: {
|
|
2576
|
+
[name: string]: unknown;
|
|
2577
|
+
};
|
|
2578
|
+
content?: never;
|
|
2579
|
+
};
|
|
2580
|
+
/** @description Internal Server Error */
|
|
2581
|
+
500: {
|
|
2582
|
+
headers: {
|
|
2583
|
+
[name: string]: unknown;
|
|
2584
|
+
};
|
|
2585
|
+
content?: never;
|
|
2586
|
+
};
|
|
2587
|
+
};
|
|
2588
|
+
};
|
|
2589
|
+
delete_api_key_api_v1_api_keys__key_id__delete: {
|
|
2590
|
+
parameters: {
|
|
2591
|
+
query?: never;
|
|
2592
|
+
header?: never;
|
|
2593
|
+
path: {
|
|
2594
|
+
key_id: string;
|
|
2595
|
+
};
|
|
2596
|
+
cookie?: never;
|
|
2597
|
+
};
|
|
2598
|
+
requestBody?: never;
|
|
2599
|
+
responses: {
|
|
2600
|
+
/** @description Successful Response */
|
|
2601
|
+
204: {
|
|
2602
|
+
headers: {
|
|
2603
|
+
[name: string]: unknown;
|
|
2604
|
+
};
|
|
2605
|
+
content?: never;
|
|
2606
|
+
};
|
|
2607
|
+
/** @description Bad Request */
|
|
2608
|
+
400: {
|
|
2609
|
+
headers: {
|
|
2610
|
+
[name: string]: unknown;
|
|
2611
|
+
};
|
|
2612
|
+
content?: never;
|
|
2613
|
+
};
|
|
2614
|
+
/** @description Authentication Required */
|
|
2615
|
+
401: {
|
|
2616
|
+
headers: {
|
|
2617
|
+
[name: string]: unknown;
|
|
2618
|
+
};
|
|
2619
|
+
content?: never;
|
|
2620
|
+
};
|
|
2621
|
+
/** @description Access Denied */
|
|
2622
|
+
403: {
|
|
2623
|
+
headers: {
|
|
2624
|
+
[name: string]: unknown;
|
|
2625
|
+
};
|
|
2626
|
+
content?: never;
|
|
2627
|
+
};
|
|
2628
|
+
/** @description Resource Not Found */
|
|
2629
|
+
404: {
|
|
2630
|
+
headers: {
|
|
2631
|
+
[name: string]: unknown;
|
|
2632
|
+
};
|
|
2633
|
+
content?: never;
|
|
2634
|
+
};
|
|
2635
|
+
/** @description Resource Conflict */
|
|
2636
|
+
409: {
|
|
2637
|
+
headers: {
|
|
2638
|
+
[name: string]: unknown;
|
|
2639
|
+
};
|
|
2640
|
+
content?: never;
|
|
2641
|
+
};
|
|
2642
|
+
/** @description Validation Error */
|
|
2643
|
+
422: {
|
|
2644
|
+
headers: {
|
|
2645
|
+
[name: string]: unknown;
|
|
2646
|
+
};
|
|
2647
|
+
content?: never;
|
|
2648
|
+
};
|
|
2649
|
+
/** @description Internal Server Error */
|
|
2650
|
+
500: {
|
|
2651
|
+
headers: {
|
|
2652
|
+
[name: string]: unknown;
|
|
2653
|
+
};
|
|
2654
|
+
content?: never;
|
|
2655
|
+
};
|
|
2656
|
+
};
|
|
2657
|
+
};
|
|
2658
|
+
update_api_key_api_v1_api_keys__key_id__patch: {
|
|
2659
|
+
parameters: {
|
|
2660
|
+
query?: never;
|
|
2661
|
+
header?: never;
|
|
2662
|
+
path: {
|
|
2663
|
+
key_id: string;
|
|
2664
|
+
};
|
|
2665
|
+
cookie?: never;
|
|
2666
|
+
};
|
|
2667
|
+
requestBody: {
|
|
2668
|
+
content: {
|
|
2669
|
+
"application/json": components["schemas"]["APIKeyUpdate"];
|
|
2670
|
+
};
|
|
2671
|
+
};
|
|
2672
|
+
responses: {
|
|
2673
|
+
/** @description Successful Response */
|
|
2674
|
+
200: {
|
|
2675
|
+
headers: {
|
|
2676
|
+
[name: string]: unknown;
|
|
2677
|
+
};
|
|
2678
|
+
content: {
|
|
2679
|
+
"application/json": components["schemas"]["APIKeyResponse"];
|
|
2680
|
+
};
|
|
2681
|
+
};
|
|
2682
|
+
/** @description Bad Request */
|
|
2683
|
+
400: {
|
|
2684
|
+
headers: {
|
|
2685
|
+
[name: string]: unknown;
|
|
2686
|
+
};
|
|
2687
|
+
content?: never;
|
|
2688
|
+
};
|
|
2689
|
+
/** @description Authentication Required */
|
|
2690
|
+
401: {
|
|
2691
|
+
headers: {
|
|
2692
|
+
[name: string]: unknown;
|
|
2693
|
+
};
|
|
2694
|
+
content?: never;
|
|
2695
|
+
};
|
|
2696
|
+
/** @description Access Denied */
|
|
2697
|
+
403: {
|
|
2698
|
+
headers: {
|
|
2699
|
+
[name: string]: unknown;
|
|
2700
|
+
};
|
|
2701
|
+
content?: never;
|
|
2702
|
+
};
|
|
2703
|
+
/** @description Resource Not Found */
|
|
2704
|
+
404: {
|
|
2705
|
+
headers: {
|
|
2706
|
+
[name: string]: unknown;
|
|
2707
|
+
};
|
|
2708
|
+
content?: never;
|
|
2709
|
+
};
|
|
2710
|
+
/** @description Resource Conflict */
|
|
2711
|
+
409: {
|
|
2712
|
+
headers: {
|
|
2713
|
+
[name: string]: unknown;
|
|
2714
|
+
};
|
|
2715
|
+
content?: never;
|
|
2716
|
+
};
|
|
2717
|
+
/** @description Validation Error */
|
|
2718
|
+
422: {
|
|
2719
|
+
headers: {
|
|
2720
|
+
[name: string]: unknown;
|
|
2721
|
+
};
|
|
2722
|
+
content?: never;
|
|
2723
|
+
};
|
|
2724
|
+
/** @description Internal Server Error */
|
|
2725
|
+
500: {
|
|
2726
|
+
headers: {
|
|
2727
|
+
[name: string]: unknown;
|
|
2728
|
+
};
|
|
2729
|
+
content?: never;
|
|
2730
|
+
};
|
|
2731
|
+
};
|
|
2732
|
+
};
|
|
2733
|
+
revoke_api_key_api_v1_api_keys__key_id__revoke_post: {
|
|
2734
|
+
parameters: {
|
|
2735
|
+
query?: never;
|
|
2736
|
+
header?: never;
|
|
2737
|
+
path: {
|
|
2738
|
+
key_id: string;
|
|
2739
|
+
};
|
|
2740
|
+
cookie?: never;
|
|
2741
|
+
};
|
|
2742
|
+
requestBody?: never;
|
|
2743
|
+
responses: {
|
|
2744
|
+
/** @description Successful Response */
|
|
2745
|
+
200: {
|
|
2746
|
+
headers: {
|
|
2747
|
+
[name: string]: unknown;
|
|
2748
|
+
};
|
|
2749
|
+
content: {
|
|
2750
|
+
"application/json": components["schemas"]["APIKeyResponse"];
|
|
2751
|
+
};
|
|
2752
|
+
};
|
|
2753
|
+
/** @description Bad Request */
|
|
2754
|
+
400: {
|
|
2755
|
+
headers: {
|
|
2756
|
+
[name: string]: unknown;
|
|
2757
|
+
};
|
|
2758
|
+
content?: never;
|
|
2759
|
+
};
|
|
2760
|
+
/** @description Authentication Required */
|
|
2761
|
+
401: {
|
|
2762
|
+
headers: {
|
|
2763
|
+
[name: string]: unknown;
|
|
2764
|
+
};
|
|
2765
|
+
content?: never;
|
|
2766
|
+
};
|
|
2767
|
+
/** @description Access Denied */
|
|
2768
|
+
403: {
|
|
2769
|
+
headers: {
|
|
2770
|
+
[name: string]: unknown;
|
|
2771
|
+
};
|
|
2772
|
+
content?: never;
|
|
2773
|
+
};
|
|
2774
|
+
/** @description Resource Not Found */
|
|
2775
|
+
404: {
|
|
2776
|
+
headers: {
|
|
2777
|
+
[name: string]: unknown;
|
|
2778
|
+
};
|
|
2779
|
+
content?: never;
|
|
2780
|
+
};
|
|
2781
|
+
/** @description Resource Conflict */
|
|
2782
|
+
409: {
|
|
2783
|
+
headers: {
|
|
2784
|
+
[name: string]: unknown;
|
|
2785
|
+
};
|
|
2786
|
+
content?: never;
|
|
2787
|
+
};
|
|
2788
|
+
/** @description Validation Error */
|
|
2789
|
+
422: {
|
|
2790
|
+
headers: {
|
|
2791
|
+
[name: string]: unknown;
|
|
2792
|
+
};
|
|
2793
|
+
content?: never;
|
|
2794
|
+
};
|
|
2795
|
+
/** @description Internal Server Error */
|
|
2796
|
+
500: {
|
|
2797
|
+
headers: {
|
|
2798
|
+
[name: string]: unknown;
|
|
2799
|
+
};
|
|
2800
|
+
content?: never;
|
|
2801
|
+
};
|
|
2802
|
+
};
|
|
2803
|
+
};
|
|
2804
|
+
list_subscribers_api_v1_subscribers_get: {
|
|
2805
|
+
parameters: {
|
|
2806
|
+
query?: {
|
|
2807
|
+
/** @description Pagination cursor */
|
|
2808
|
+
cursor?: string | null;
|
|
2809
|
+
/** @description Items per page */
|
|
2810
|
+
limit?: number;
|
|
2811
|
+
/** @description Filter by status */
|
|
2812
|
+
status?: components["schemas"]["SubscriberStatus"] | null;
|
|
2813
|
+
};
|
|
2814
|
+
header?: {
|
|
2815
|
+
authorization?: string | null;
|
|
2816
|
+
"X-API-Key"?: string | null;
|
|
2817
|
+
};
|
|
2818
|
+
path?: never;
|
|
2819
|
+
cookie?: never;
|
|
2820
|
+
};
|
|
2821
|
+
requestBody?: never;
|
|
2822
|
+
responses: {
|
|
2823
|
+
/** @description Successful Response */
|
|
2824
|
+
200: {
|
|
2825
|
+
headers: {
|
|
2826
|
+
[name: string]: unknown;
|
|
2827
|
+
};
|
|
2828
|
+
content: {
|
|
2829
|
+
"application/json": components["schemas"]["SubscriberListResponse"];
|
|
2830
|
+
};
|
|
2831
|
+
};
|
|
2832
|
+
/** @description Bad Request */
|
|
2833
|
+
400: {
|
|
2834
|
+
headers: {
|
|
2835
|
+
[name: string]: unknown;
|
|
2836
|
+
};
|
|
2837
|
+
content?: never;
|
|
2838
|
+
};
|
|
2839
|
+
/** @description Authentication Required */
|
|
2840
|
+
401: {
|
|
2841
|
+
headers: {
|
|
2842
|
+
[name: string]: unknown;
|
|
2843
|
+
};
|
|
2844
|
+
content?: never;
|
|
2845
|
+
};
|
|
2846
|
+
/** @description Access Denied */
|
|
2847
|
+
403: {
|
|
2848
|
+
headers: {
|
|
2849
|
+
[name: string]: unknown;
|
|
2850
|
+
};
|
|
2851
|
+
content?: never;
|
|
2852
|
+
};
|
|
2853
|
+
/** @description Resource Not Found */
|
|
2854
|
+
404: {
|
|
2855
|
+
headers: {
|
|
2856
|
+
[name: string]: unknown;
|
|
2857
|
+
};
|
|
2858
|
+
content?: never;
|
|
2859
|
+
};
|
|
2860
|
+
/** @description Resource Conflict */
|
|
2861
|
+
409: {
|
|
2862
|
+
headers: {
|
|
2863
|
+
[name: string]: unknown;
|
|
2864
|
+
};
|
|
2865
|
+
content?: never;
|
|
2866
|
+
};
|
|
2867
|
+
/** @description Validation Error */
|
|
2868
|
+
422: {
|
|
2869
|
+
headers: {
|
|
2870
|
+
[name: string]: unknown;
|
|
2871
|
+
};
|
|
2872
|
+
content?: never;
|
|
2873
|
+
};
|
|
2874
|
+
/** @description Internal Server Error */
|
|
2875
|
+
500: {
|
|
2876
|
+
headers: {
|
|
2877
|
+
[name: string]: unknown;
|
|
2878
|
+
};
|
|
2879
|
+
content?: never;
|
|
2880
|
+
};
|
|
2881
|
+
};
|
|
2882
|
+
};
|
|
2883
|
+
create_subscriber_api_v1_subscribers_post: {
|
|
2884
|
+
parameters: {
|
|
2885
|
+
query?: never;
|
|
2886
|
+
header?: {
|
|
2887
|
+
authorization?: string | null;
|
|
2888
|
+
"X-API-Key"?: string | null;
|
|
2889
|
+
};
|
|
2890
|
+
path?: never;
|
|
2891
|
+
cookie?: never;
|
|
2892
|
+
};
|
|
2893
|
+
requestBody: {
|
|
2894
|
+
content: {
|
|
2895
|
+
"application/json": components["schemas"]["SubscriberCreate"];
|
|
2896
|
+
};
|
|
2897
|
+
};
|
|
2898
|
+
responses: {
|
|
2899
|
+
/** @description Subscriber created successfully */
|
|
2900
|
+
201: {
|
|
2901
|
+
headers: {
|
|
2902
|
+
[name: string]: unknown;
|
|
2903
|
+
};
|
|
2904
|
+
content: {
|
|
2905
|
+
"application/json": components["schemas"]["SubscriberResponse"];
|
|
2906
|
+
};
|
|
2907
|
+
};
|
|
2908
|
+
/** @description Invalid request body */
|
|
2909
|
+
400: {
|
|
2910
|
+
headers: {
|
|
2911
|
+
[name: string]: unknown;
|
|
2912
|
+
};
|
|
2913
|
+
content?: never;
|
|
2914
|
+
};
|
|
2915
|
+
/** @description Authentication Required */
|
|
2916
|
+
401: {
|
|
2917
|
+
headers: {
|
|
2918
|
+
[name: string]: unknown;
|
|
2919
|
+
};
|
|
2920
|
+
content?: never;
|
|
2921
|
+
};
|
|
2922
|
+
/** @description Access Denied */
|
|
2923
|
+
403: {
|
|
2924
|
+
headers: {
|
|
2925
|
+
[name: string]: unknown;
|
|
2926
|
+
};
|
|
2927
|
+
content?: never;
|
|
2928
|
+
};
|
|
2929
|
+
/** @description Resource Not Found */
|
|
2930
|
+
404: {
|
|
2931
|
+
headers: {
|
|
2932
|
+
[name: string]: unknown;
|
|
2933
|
+
};
|
|
2934
|
+
content?: never;
|
|
2935
|
+
};
|
|
2936
|
+
/** @description Email already exists */
|
|
2937
|
+
409: {
|
|
2938
|
+
headers: {
|
|
2939
|
+
[name: string]: unknown;
|
|
2940
|
+
};
|
|
2941
|
+
content?: never;
|
|
2942
|
+
};
|
|
2943
|
+
/** @description Validation Error */
|
|
2944
|
+
422: {
|
|
2945
|
+
headers: {
|
|
2946
|
+
[name: string]: unknown;
|
|
2947
|
+
};
|
|
2948
|
+
content?: never;
|
|
2949
|
+
};
|
|
2950
|
+
/** @description Internal Server Error */
|
|
2951
|
+
500: {
|
|
2952
|
+
headers: {
|
|
2953
|
+
[name: string]: unknown;
|
|
2954
|
+
};
|
|
2955
|
+
content?: never;
|
|
2956
|
+
};
|
|
2957
|
+
};
|
|
2958
|
+
};
|
|
2959
|
+
get_subscriber_api_v1_subscribers__subscriber_id__get: {
|
|
2960
|
+
parameters: {
|
|
2961
|
+
query?: never;
|
|
2962
|
+
header?: {
|
|
2963
|
+
authorization?: string | null;
|
|
2964
|
+
"X-API-Key"?: string | null;
|
|
2965
|
+
};
|
|
2966
|
+
path: {
|
|
2967
|
+
subscriber_id: string;
|
|
2968
|
+
};
|
|
2969
|
+
cookie?: never;
|
|
2970
|
+
};
|
|
2971
|
+
requestBody?: never;
|
|
2972
|
+
responses: {
|
|
2973
|
+
/** @description Subscriber found */
|
|
2974
|
+
200: {
|
|
2975
|
+
headers: {
|
|
2976
|
+
[name: string]: unknown;
|
|
2977
|
+
};
|
|
2978
|
+
content: {
|
|
2979
|
+
"application/json": components["schemas"]["SubscriberResponse"];
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
/** @description Bad Request */
|
|
2983
|
+
400: {
|
|
2984
|
+
headers: {
|
|
2985
|
+
[name: string]: unknown;
|
|
2986
|
+
};
|
|
2987
|
+
content?: never;
|
|
2988
|
+
};
|
|
2989
|
+
/** @description Authentication Required */
|
|
2990
|
+
401: {
|
|
2991
|
+
headers: {
|
|
2992
|
+
[name: string]: unknown;
|
|
2993
|
+
};
|
|
2994
|
+
content?: never;
|
|
2995
|
+
};
|
|
2996
|
+
/** @description Access Denied */
|
|
2997
|
+
403: {
|
|
2998
|
+
headers: {
|
|
2999
|
+
[name: string]: unknown;
|
|
3000
|
+
};
|
|
3001
|
+
content?: never;
|
|
3002
|
+
};
|
|
3003
|
+
/** @description Subscriber not found */
|
|
3004
|
+
404: {
|
|
3005
|
+
headers: {
|
|
3006
|
+
[name: string]: unknown;
|
|
3007
|
+
};
|
|
3008
|
+
content?: never;
|
|
3009
|
+
};
|
|
3010
|
+
/** @description Resource Conflict */
|
|
3011
|
+
409: {
|
|
3012
|
+
headers: {
|
|
3013
|
+
[name: string]: unknown;
|
|
3014
|
+
};
|
|
3015
|
+
content?: never;
|
|
3016
|
+
};
|
|
3017
|
+
/** @description Validation Error */
|
|
3018
|
+
422: {
|
|
3019
|
+
headers: {
|
|
3020
|
+
[name: string]: unknown;
|
|
3021
|
+
};
|
|
3022
|
+
content?: never;
|
|
3023
|
+
};
|
|
3024
|
+
/** @description Internal Server Error */
|
|
3025
|
+
500: {
|
|
3026
|
+
headers: {
|
|
3027
|
+
[name: string]: unknown;
|
|
3028
|
+
};
|
|
3029
|
+
content?: never;
|
|
3030
|
+
};
|
|
3031
|
+
};
|
|
3032
|
+
};
|
|
3033
|
+
update_subscriber_api_v1_subscribers__subscriber_id__put: {
|
|
3034
|
+
parameters: {
|
|
3035
|
+
query?: never;
|
|
3036
|
+
header?: {
|
|
3037
|
+
authorization?: string | null;
|
|
3038
|
+
"X-API-Key"?: string | null;
|
|
3039
|
+
};
|
|
3040
|
+
path: {
|
|
3041
|
+
subscriber_id: string;
|
|
3042
|
+
};
|
|
3043
|
+
cookie?: never;
|
|
3044
|
+
};
|
|
3045
|
+
requestBody: {
|
|
3046
|
+
content: {
|
|
3047
|
+
"application/json": components["schemas"]["SubscriberUpdate"];
|
|
3048
|
+
};
|
|
3049
|
+
};
|
|
3050
|
+
responses: {
|
|
3051
|
+
/** @description Successful Response */
|
|
3052
|
+
200: {
|
|
3053
|
+
headers: {
|
|
3054
|
+
[name: string]: unknown;
|
|
3055
|
+
};
|
|
3056
|
+
content: {
|
|
3057
|
+
"application/json": components["schemas"]["SubscriberResponse"];
|
|
3058
|
+
};
|
|
3059
|
+
};
|
|
3060
|
+
/** @description Bad Request */
|
|
3061
|
+
400: {
|
|
3062
|
+
headers: {
|
|
3063
|
+
[name: string]: unknown;
|
|
3064
|
+
};
|
|
3065
|
+
content?: never;
|
|
3066
|
+
};
|
|
3067
|
+
/** @description Authentication Required */
|
|
3068
|
+
401: {
|
|
3069
|
+
headers: {
|
|
3070
|
+
[name: string]: unknown;
|
|
3071
|
+
};
|
|
3072
|
+
content?: never;
|
|
3073
|
+
};
|
|
3074
|
+
/** @description Access Denied */
|
|
3075
|
+
403: {
|
|
3076
|
+
headers: {
|
|
3077
|
+
[name: string]: unknown;
|
|
3078
|
+
};
|
|
3079
|
+
content?: never;
|
|
3080
|
+
};
|
|
3081
|
+
/** @description Resource Not Found */
|
|
3082
|
+
404: {
|
|
3083
|
+
headers: {
|
|
3084
|
+
[name: string]: unknown;
|
|
3085
|
+
};
|
|
3086
|
+
content?: never;
|
|
3087
|
+
};
|
|
3088
|
+
/** @description Resource Conflict */
|
|
3089
|
+
409: {
|
|
3090
|
+
headers: {
|
|
3091
|
+
[name: string]: unknown;
|
|
3092
|
+
};
|
|
3093
|
+
content?: never;
|
|
3094
|
+
};
|
|
3095
|
+
/** @description Validation Error */
|
|
3096
|
+
422: {
|
|
3097
|
+
headers: {
|
|
3098
|
+
[name: string]: unknown;
|
|
3099
|
+
};
|
|
3100
|
+
content?: never;
|
|
3101
|
+
};
|
|
3102
|
+
/** @description Internal Server Error */
|
|
3103
|
+
500: {
|
|
3104
|
+
headers: {
|
|
3105
|
+
[name: string]: unknown;
|
|
3106
|
+
};
|
|
3107
|
+
content?: never;
|
|
3108
|
+
};
|
|
3109
|
+
};
|
|
3110
|
+
};
|
|
3111
|
+
delete_subscriber_api_v1_subscribers__subscriber_id__delete: {
|
|
3112
|
+
parameters: {
|
|
3113
|
+
query?: never;
|
|
3114
|
+
header?: {
|
|
3115
|
+
authorization?: string | null;
|
|
3116
|
+
"X-API-Key"?: string | null;
|
|
3117
|
+
};
|
|
3118
|
+
path: {
|
|
3119
|
+
subscriber_id: string;
|
|
3120
|
+
};
|
|
3121
|
+
cookie?: never;
|
|
3122
|
+
};
|
|
3123
|
+
requestBody?: never;
|
|
3124
|
+
responses: {
|
|
3125
|
+
/** @description Subscriber deleted */
|
|
3126
|
+
204: {
|
|
3127
|
+
headers: {
|
|
3128
|
+
[name: string]: unknown;
|
|
3129
|
+
};
|
|
3130
|
+
content?: never;
|
|
3131
|
+
};
|
|
3132
|
+
/** @description Bad Request */
|
|
3133
|
+
400: {
|
|
3134
|
+
headers: {
|
|
3135
|
+
[name: string]: unknown;
|
|
3136
|
+
};
|
|
3137
|
+
content?: never;
|
|
3138
|
+
};
|
|
3139
|
+
/** @description Authentication Required */
|
|
3140
|
+
401: {
|
|
3141
|
+
headers: {
|
|
3142
|
+
[name: string]: unknown;
|
|
3143
|
+
};
|
|
3144
|
+
content?: never;
|
|
3145
|
+
};
|
|
3146
|
+
/** @description Access Denied */
|
|
3147
|
+
403: {
|
|
3148
|
+
headers: {
|
|
3149
|
+
[name: string]: unknown;
|
|
3150
|
+
};
|
|
3151
|
+
content?: never;
|
|
3152
|
+
};
|
|
3153
|
+
/** @description Subscriber not found */
|
|
3154
|
+
404: {
|
|
3155
|
+
headers: {
|
|
3156
|
+
[name: string]: unknown;
|
|
3157
|
+
};
|
|
3158
|
+
content?: never;
|
|
3159
|
+
};
|
|
3160
|
+
/** @description Resource Conflict */
|
|
3161
|
+
409: {
|
|
3162
|
+
headers: {
|
|
3163
|
+
[name: string]: unknown;
|
|
3164
|
+
};
|
|
3165
|
+
content?: never;
|
|
3166
|
+
};
|
|
3167
|
+
/** @description Validation Error */
|
|
3168
|
+
422: {
|
|
3169
|
+
headers: {
|
|
3170
|
+
[name: string]: unknown;
|
|
3171
|
+
};
|
|
3172
|
+
content?: never;
|
|
3173
|
+
};
|
|
3174
|
+
/** @description Internal Server Error */
|
|
3175
|
+
500: {
|
|
3176
|
+
headers: {
|
|
3177
|
+
[name: string]: unknown;
|
|
3178
|
+
};
|
|
3179
|
+
content?: never;
|
|
3180
|
+
};
|
|
3181
|
+
};
|
|
3182
|
+
};
|
|
3183
|
+
get_subscriber_tags_api_v1_subscribers__subscriber_id__tags_get: {
|
|
3184
|
+
parameters: {
|
|
3185
|
+
query?: never;
|
|
3186
|
+
header?: {
|
|
3187
|
+
authorization?: string | null;
|
|
3188
|
+
"X-API-Key"?: string | null;
|
|
3189
|
+
};
|
|
3190
|
+
path: {
|
|
3191
|
+
subscriber_id: string;
|
|
3192
|
+
};
|
|
3193
|
+
cookie?: never;
|
|
3194
|
+
};
|
|
3195
|
+
requestBody?: never;
|
|
3196
|
+
responses: {
|
|
3197
|
+
/** @description Successful Response */
|
|
3198
|
+
200: {
|
|
3199
|
+
headers: {
|
|
3200
|
+
[name: string]: unknown;
|
|
3201
|
+
};
|
|
3202
|
+
content: {
|
|
3203
|
+
"application/json": components["schemas"]["SubscriberTagsResponse"];
|
|
3204
|
+
};
|
|
3205
|
+
};
|
|
3206
|
+
/** @description Bad Request */
|
|
3207
|
+
400: {
|
|
3208
|
+
headers: {
|
|
3209
|
+
[name: string]: unknown;
|
|
3210
|
+
};
|
|
3211
|
+
content?: never;
|
|
3212
|
+
};
|
|
3213
|
+
/** @description Authentication Required */
|
|
3214
|
+
401: {
|
|
3215
|
+
headers: {
|
|
3216
|
+
[name: string]: unknown;
|
|
3217
|
+
};
|
|
3218
|
+
content?: never;
|
|
3219
|
+
};
|
|
3220
|
+
/** @description Access Denied */
|
|
3221
|
+
403: {
|
|
3222
|
+
headers: {
|
|
3223
|
+
[name: string]: unknown;
|
|
3224
|
+
};
|
|
3225
|
+
content?: never;
|
|
3226
|
+
};
|
|
3227
|
+
/** @description Resource Not Found */
|
|
3228
|
+
404: {
|
|
3229
|
+
headers: {
|
|
3230
|
+
[name: string]: unknown;
|
|
3231
|
+
};
|
|
3232
|
+
content?: never;
|
|
3233
|
+
};
|
|
3234
|
+
/** @description Resource Conflict */
|
|
3235
|
+
409: {
|
|
3236
|
+
headers: {
|
|
3237
|
+
[name: string]: unknown;
|
|
3238
|
+
};
|
|
3239
|
+
content?: never;
|
|
3240
|
+
};
|
|
3241
|
+
/** @description Validation Error */
|
|
3242
|
+
422: {
|
|
3243
|
+
headers: {
|
|
3244
|
+
[name: string]: unknown;
|
|
3245
|
+
};
|
|
3246
|
+
content?: never;
|
|
3247
|
+
};
|
|
3248
|
+
/** @description Internal Server Error */
|
|
3249
|
+
500: {
|
|
3250
|
+
headers: {
|
|
3251
|
+
[name: string]: unknown;
|
|
3252
|
+
};
|
|
3253
|
+
content?: never;
|
|
3254
|
+
};
|
|
3255
|
+
};
|
|
3256
|
+
};
|
|
3257
|
+
add_subscriber_tags_api_v1_subscribers__subscriber_id__tags_post: {
|
|
3258
|
+
parameters: {
|
|
3259
|
+
query?: never;
|
|
3260
|
+
header?: {
|
|
3261
|
+
authorization?: string | null;
|
|
3262
|
+
"X-API-Key"?: string | null;
|
|
3263
|
+
};
|
|
3264
|
+
path: {
|
|
3265
|
+
subscriber_id: string;
|
|
3266
|
+
};
|
|
3267
|
+
cookie?: never;
|
|
3268
|
+
};
|
|
3269
|
+
requestBody: {
|
|
3270
|
+
content: {
|
|
3271
|
+
"application/json": components["schemas"]["SubscriberTagsAdd"];
|
|
3272
|
+
};
|
|
3273
|
+
};
|
|
3274
|
+
responses: {
|
|
3275
|
+
/** @description Successful Response */
|
|
3276
|
+
201: {
|
|
3277
|
+
headers: {
|
|
3278
|
+
[name: string]: unknown;
|
|
3279
|
+
};
|
|
3280
|
+
content: {
|
|
3281
|
+
"application/json": components["schemas"]["SubscriberTagsResponse"];
|
|
3282
|
+
};
|
|
3283
|
+
};
|
|
3284
|
+
/** @description Bad Request */
|
|
3285
|
+
400: {
|
|
3286
|
+
headers: {
|
|
3287
|
+
[name: string]: unknown;
|
|
3288
|
+
};
|
|
3289
|
+
content?: never;
|
|
3290
|
+
};
|
|
3291
|
+
/** @description Authentication Required */
|
|
3292
|
+
401: {
|
|
3293
|
+
headers: {
|
|
3294
|
+
[name: string]: unknown;
|
|
3295
|
+
};
|
|
3296
|
+
content?: never;
|
|
3297
|
+
};
|
|
3298
|
+
/** @description Access Denied */
|
|
3299
|
+
403: {
|
|
3300
|
+
headers: {
|
|
3301
|
+
[name: string]: unknown;
|
|
3302
|
+
};
|
|
3303
|
+
content?: never;
|
|
3304
|
+
};
|
|
3305
|
+
/** @description Resource Not Found */
|
|
3306
|
+
404: {
|
|
3307
|
+
headers: {
|
|
3308
|
+
[name: string]: unknown;
|
|
3309
|
+
};
|
|
3310
|
+
content?: never;
|
|
3311
|
+
};
|
|
3312
|
+
/** @description Resource Conflict */
|
|
3313
|
+
409: {
|
|
3314
|
+
headers: {
|
|
3315
|
+
[name: string]: unknown;
|
|
3316
|
+
};
|
|
3317
|
+
content?: never;
|
|
3318
|
+
};
|
|
3319
|
+
/** @description Validation Error */
|
|
3320
|
+
422: {
|
|
3321
|
+
headers: {
|
|
3322
|
+
[name: string]: unknown;
|
|
3323
|
+
};
|
|
3324
|
+
content?: never;
|
|
3325
|
+
};
|
|
3326
|
+
/** @description Internal Server Error */
|
|
3327
|
+
500: {
|
|
3328
|
+
headers: {
|
|
3329
|
+
[name: string]: unknown;
|
|
3330
|
+
};
|
|
3331
|
+
content?: never;
|
|
3332
|
+
};
|
|
3333
|
+
};
|
|
3334
|
+
};
|
|
3335
|
+
remove_subscriber_tag_api_v1_subscribers__subscriber_id__tags__tag_id__delete: {
|
|
3336
|
+
parameters: {
|
|
3337
|
+
query?: never;
|
|
3338
|
+
header?: {
|
|
3339
|
+
authorization?: string | null;
|
|
3340
|
+
"X-API-Key"?: string | null;
|
|
3341
|
+
};
|
|
3342
|
+
path: {
|
|
3343
|
+
subscriber_id: string;
|
|
3344
|
+
tag_id: string;
|
|
3345
|
+
};
|
|
3346
|
+
cookie?: never;
|
|
3347
|
+
};
|
|
3348
|
+
requestBody?: never;
|
|
3349
|
+
responses: {
|
|
3350
|
+
/** @description Successful Response */
|
|
3351
|
+
204: {
|
|
3352
|
+
headers: {
|
|
3353
|
+
[name: string]: unknown;
|
|
3354
|
+
};
|
|
3355
|
+
content?: never;
|
|
3356
|
+
};
|
|
3357
|
+
/** @description Bad Request */
|
|
3358
|
+
400: {
|
|
3359
|
+
headers: {
|
|
3360
|
+
[name: string]: unknown;
|
|
3361
|
+
};
|
|
3362
|
+
content?: never;
|
|
3363
|
+
};
|
|
3364
|
+
/** @description Authentication Required */
|
|
3365
|
+
401: {
|
|
3366
|
+
headers: {
|
|
3367
|
+
[name: string]: unknown;
|
|
3368
|
+
};
|
|
3369
|
+
content?: never;
|
|
3370
|
+
};
|
|
3371
|
+
/** @description Access Denied */
|
|
3372
|
+
403: {
|
|
3373
|
+
headers: {
|
|
3374
|
+
[name: string]: unknown;
|
|
3375
|
+
};
|
|
3376
|
+
content?: never;
|
|
3377
|
+
};
|
|
3378
|
+
/** @description Resource Not Found */
|
|
3379
|
+
404: {
|
|
3380
|
+
headers: {
|
|
3381
|
+
[name: string]: unknown;
|
|
3382
|
+
};
|
|
3383
|
+
content?: never;
|
|
3384
|
+
};
|
|
3385
|
+
/** @description Resource Conflict */
|
|
3386
|
+
409: {
|
|
3387
|
+
headers: {
|
|
3388
|
+
[name: string]: unknown;
|
|
3389
|
+
};
|
|
3390
|
+
content?: never;
|
|
3391
|
+
};
|
|
3392
|
+
/** @description Validation Error */
|
|
3393
|
+
422: {
|
|
3394
|
+
headers: {
|
|
3395
|
+
[name: string]: unknown;
|
|
3396
|
+
};
|
|
3397
|
+
content?: never;
|
|
3398
|
+
};
|
|
3399
|
+
/** @description Internal Server Error */
|
|
3400
|
+
500: {
|
|
3401
|
+
headers: {
|
|
3402
|
+
[name: string]: unknown;
|
|
3403
|
+
};
|
|
3404
|
+
content?: never;
|
|
3405
|
+
};
|
|
3406
|
+
};
|
|
3407
|
+
};
|
|
3408
|
+
list_tags_api_v1_tags_get: {
|
|
3409
|
+
parameters: {
|
|
3410
|
+
query?: {
|
|
3411
|
+
/** @description Pagination cursor */
|
|
3412
|
+
cursor?: string | null;
|
|
3413
|
+
/** @description Items per page */
|
|
3414
|
+
limit?: number;
|
|
3415
|
+
/** @description Filter by category */
|
|
3416
|
+
category?: string | null;
|
|
3417
|
+
/** @description Filter by visibility */
|
|
3418
|
+
is_public?: boolean | null;
|
|
3419
|
+
/** @description Field to sort by */
|
|
3420
|
+
sort_by?: components["schemas"]["TagSortField"];
|
|
3421
|
+
/** @description Sort descending */
|
|
3422
|
+
sort_desc?: boolean;
|
|
3423
|
+
};
|
|
3424
|
+
header?: {
|
|
3425
|
+
authorization?: string | null;
|
|
3426
|
+
"X-API-Key"?: string | null;
|
|
3427
|
+
};
|
|
3428
|
+
path?: never;
|
|
3429
|
+
cookie?: never;
|
|
3430
|
+
};
|
|
3431
|
+
requestBody?: never;
|
|
3432
|
+
responses: {
|
|
3433
|
+
/** @description Successful Response */
|
|
3434
|
+
200: {
|
|
3435
|
+
headers: {
|
|
3436
|
+
[name: string]: unknown;
|
|
3437
|
+
};
|
|
3438
|
+
content: {
|
|
3439
|
+
"application/json": components["schemas"]["TagListResponse"];
|
|
3440
|
+
};
|
|
3441
|
+
};
|
|
3442
|
+
/** @description Bad Request */
|
|
3443
|
+
400: {
|
|
3444
|
+
headers: {
|
|
3445
|
+
[name: string]: unknown;
|
|
3446
|
+
};
|
|
3447
|
+
content?: never;
|
|
3448
|
+
};
|
|
3449
|
+
/** @description Authentication Required */
|
|
3450
|
+
401: {
|
|
3451
|
+
headers: {
|
|
3452
|
+
[name: string]: unknown;
|
|
3453
|
+
};
|
|
3454
|
+
content?: never;
|
|
3455
|
+
};
|
|
3456
|
+
/** @description Access Denied */
|
|
3457
|
+
403: {
|
|
3458
|
+
headers: {
|
|
3459
|
+
[name: string]: unknown;
|
|
3460
|
+
};
|
|
3461
|
+
content?: never;
|
|
3462
|
+
};
|
|
3463
|
+
/** @description Resource Not Found */
|
|
3464
|
+
404: {
|
|
3465
|
+
headers: {
|
|
3466
|
+
[name: string]: unknown;
|
|
3467
|
+
};
|
|
3468
|
+
content?: never;
|
|
3469
|
+
};
|
|
3470
|
+
/** @description Resource Conflict */
|
|
3471
|
+
409: {
|
|
3472
|
+
headers: {
|
|
3473
|
+
[name: string]: unknown;
|
|
3474
|
+
};
|
|
3475
|
+
content?: never;
|
|
3476
|
+
};
|
|
3477
|
+
/** @description Validation Error */
|
|
3478
|
+
422: {
|
|
3479
|
+
headers: {
|
|
3480
|
+
[name: string]: unknown;
|
|
3481
|
+
};
|
|
3482
|
+
content?: never;
|
|
3483
|
+
};
|
|
3484
|
+
/** @description Internal Server Error */
|
|
3485
|
+
500: {
|
|
3486
|
+
headers: {
|
|
3487
|
+
[name: string]: unknown;
|
|
3488
|
+
};
|
|
3489
|
+
content?: never;
|
|
3490
|
+
};
|
|
3491
|
+
};
|
|
3492
|
+
};
|
|
3493
|
+
create_tag_api_v1_tags_post: {
|
|
3494
|
+
parameters: {
|
|
3495
|
+
query?: never;
|
|
3496
|
+
header?: {
|
|
3497
|
+
authorization?: string | null;
|
|
3498
|
+
"X-API-Key"?: string | null;
|
|
3499
|
+
};
|
|
3500
|
+
path?: never;
|
|
3501
|
+
cookie?: never;
|
|
3502
|
+
};
|
|
3503
|
+
requestBody: {
|
|
3504
|
+
content: {
|
|
3505
|
+
"application/json": components["schemas"]["TagCreate"];
|
|
3506
|
+
};
|
|
3507
|
+
};
|
|
3508
|
+
responses: {
|
|
3509
|
+
/** @description Successful Response */
|
|
3510
|
+
201: {
|
|
3511
|
+
headers: {
|
|
3512
|
+
[name: string]: unknown;
|
|
3513
|
+
};
|
|
3514
|
+
content: {
|
|
3515
|
+
"application/json": components["schemas"]["TagResponse"];
|
|
3516
|
+
};
|
|
3517
|
+
};
|
|
3518
|
+
/** @description Bad Request */
|
|
3519
|
+
400: {
|
|
3520
|
+
headers: {
|
|
3521
|
+
[name: string]: unknown;
|
|
3522
|
+
};
|
|
3523
|
+
content?: never;
|
|
3524
|
+
};
|
|
3525
|
+
/** @description Authentication Required */
|
|
3526
|
+
401: {
|
|
3527
|
+
headers: {
|
|
3528
|
+
[name: string]: unknown;
|
|
3529
|
+
};
|
|
3530
|
+
content?: never;
|
|
3531
|
+
};
|
|
3532
|
+
/** @description Access Denied */
|
|
3533
|
+
403: {
|
|
3534
|
+
headers: {
|
|
3535
|
+
[name: string]: unknown;
|
|
3536
|
+
};
|
|
3537
|
+
content?: never;
|
|
3538
|
+
};
|
|
3539
|
+
/** @description Resource Not Found */
|
|
3540
|
+
404: {
|
|
3541
|
+
headers: {
|
|
3542
|
+
[name: string]: unknown;
|
|
3543
|
+
};
|
|
3544
|
+
content?: never;
|
|
3545
|
+
};
|
|
3546
|
+
/** @description Resource Conflict */
|
|
3547
|
+
409: {
|
|
3548
|
+
headers: {
|
|
3549
|
+
[name: string]: unknown;
|
|
3550
|
+
};
|
|
3551
|
+
content?: never;
|
|
3552
|
+
};
|
|
3553
|
+
/** @description Validation Error */
|
|
3554
|
+
422: {
|
|
3555
|
+
headers: {
|
|
3556
|
+
[name: string]: unknown;
|
|
3557
|
+
};
|
|
3558
|
+
content?: never;
|
|
3559
|
+
};
|
|
3560
|
+
/** @description Internal Server Error */
|
|
3561
|
+
500: {
|
|
3562
|
+
headers: {
|
|
3563
|
+
[name: string]: unknown;
|
|
3564
|
+
};
|
|
3565
|
+
content?: never;
|
|
3566
|
+
};
|
|
3567
|
+
};
|
|
3568
|
+
};
|
|
3569
|
+
get_tag_api_v1_tags__tag_id__get: {
|
|
3570
|
+
parameters: {
|
|
3571
|
+
query?: never;
|
|
3572
|
+
header?: {
|
|
3573
|
+
authorization?: string | null;
|
|
3574
|
+
"X-API-Key"?: string | null;
|
|
3575
|
+
};
|
|
3576
|
+
path: {
|
|
3577
|
+
tag_id: string;
|
|
3578
|
+
};
|
|
3579
|
+
cookie?: never;
|
|
3580
|
+
};
|
|
3581
|
+
requestBody?: never;
|
|
3582
|
+
responses: {
|
|
3583
|
+
/** @description Successful Response */
|
|
3584
|
+
200: {
|
|
3585
|
+
headers: {
|
|
3586
|
+
[name: string]: unknown;
|
|
3587
|
+
};
|
|
3588
|
+
content: {
|
|
3589
|
+
"application/json": components["schemas"]["TagResponse"];
|
|
3590
|
+
};
|
|
3591
|
+
};
|
|
3592
|
+
/** @description Bad Request */
|
|
3593
|
+
400: {
|
|
3594
|
+
headers: {
|
|
3595
|
+
[name: string]: unknown;
|
|
3596
|
+
};
|
|
3597
|
+
content?: never;
|
|
3598
|
+
};
|
|
3599
|
+
/** @description Authentication Required */
|
|
3600
|
+
401: {
|
|
3601
|
+
headers: {
|
|
3602
|
+
[name: string]: unknown;
|
|
3603
|
+
};
|
|
3604
|
+
content?: never;
|
|
3605
|
+
};
|
|
3606
|
+
/** @description Access Denied */
|
|
3607
|
+
403: {
|
|
3608
|
+
headers: {
|
|
3609
|
+
[name: string]: unknown;
|
|
3610
|
+
};
|
|
3611
|
+
content?: never;
|
|
3612
|
+
};
|
|
3613
|
+
/** @description Resource Not Found */
|
|
3614
|
+
404: {
|
|
3615
|
+
headers: {
|
|
3616
|
+
[name: string]: unknown;
|
|
3617
|
+
};
|
|
3618
|
+
content?: never;
|
|
3619
|
+
};
|
|
3620
|
+
/** @description Resource Conflict */
|
|
3621
|
+
409: {
|
|
3622
|
+
headers: {
|
|
3623
|
+
[name: string]: unknown;
|
|
3624
|
+
};
|
|
3625
|
+
content?: never;
|
|
3626
|
+
};
|
|
3627
|
+
/** @description Validation Error */
|
|
3628
|
+
422: {
|
|
3629
|
+
headers: {
|
|
3630
|
+
[name: string]: unknown;
|
|
3631
|
+
};
|
|
3632
|
+
content?: never;
|
|
3633
|
+
};
|
|
3634
|
+
/** @description Internal Server Error */
|
|
3635
|
+
500: {
|
|
3636
|
+
headers: {
|
|
3637
|
+
[name: string]: unknown;
|
|
3638
|
+
};
|
|
3639
|
+
content?: never;
|
|
3640
|
+
};
|
|
3641
|
+
};
|
|
3642
|
+
};
|
|
3643
|
+
update_tag_api_v1_tags__tag_id__put: {
|
|
3644
|
+
parameters: {
|
|
3645
|
+
query?: never;
|
|
3646
|
+
header?: {
|
|
3647
|
+
authorization?: string | null;
|
|
3648
|
+
"X-API-Key"?: string | null;
|
|
3649
|
+
};
|
|
3650
|
+
path: {
|
|
3651
|
+
tag_id: string;
|
|
3652
|
+
};
|
|
3653
|
+
cookie?: never;
|
|
3654
|
+
};
|
|
3655
|
+
requestBody: {
|
|
3656
|
+
content: {
|
|
3657
|
+
"application/json": components["schemas"]["TagUpdate"];
|
|
3658
|
+
};
|
|
3659
|
+
};
|
|
3660
|
+
responses: {
|
|
3661
|
+
/** @description Successful Response */
|
|
3662
|
+
200: {
|
|
3663
|
+
headers: {
|
|
3664
|
+
[name: string]: unknown;
|
|
3665
|
+
};
|
|
3666
|
+
content: {
|
|
3667
|
+
"application/json": components["schemas"]["TagResponse"];
|
|
3668
|
+
};
|
|
3669
|
+
};
|
|
3670
|
+
/** @description Bad Request */
|
|
3671
|
+
400: {
|
|
3672
|
+
headers: {
|
|
3673
|
+
[name: string]: unknown;
|
|
3674
|
+
};
|
|
3675
|
+
content?: never;
|
|
3676
|
+
};
|
|
3677
|
+
/** @description Authentication Required */
|
|
3678
|
+
401: {
|
|
3679
|
+
headers: {
|
|
3680
|
+
[name: string]: unknown;
|
|
3681
|
+
};
|
|
3682
|
+
content?: never;
|
|
3683
|
+
};
|
|
3684
|
+
/** @description Access Denied */
|
|
3685
|
+
403: {
|
|
3686
|
+
headers: {
|
|
3687
|
+
[name: string]: unknown;
|
|
3688
|
+
};
|
|
3689
|
+
content?: never;
|
|
3690
|
+
};
|
|
3691
|
+
/** @description Resource Not Found */
|
|
3692
|
+
404: {
|
|
3693
|
+
headers: {
|
|
3694
|
+
[name: string]: unknown;
|
|
3695
|
+
};
|
|
3696
|
+
content?: never;
|
|
3697
|
+
};
|
|
3698
|
+
/** @description Resource Conflict */
|
|
3699
|
+
409: {
|
|
3700
|
+
headers: {
|
|
3701
|
+
[name: string]: unknown;
|
|
3702
|
+
};
|
|
3703
|
+
content?: never;
|
|
3704
|
+
};
|
|
3705
|
+
/** @description Validation Error */
|
|
3706
|
+
422: {
|
|
3707
|
+
headers: {
|
|
3708
|
+
[name: string]: unknown;
|
|
3709
|
+
};
|
|
3710
|
+
content?: never;
|
|
3711
|
+
};
|
|
3712
|
+
/** @description Internal Server Error */
|
|
3713
|
+
500: {
|
|
3714
|
+
headers: {
|
|
3715
|
+
[name: string]: unknown;
|
|
3716
|
+
};
|
|
3717
|
+
content?: never;
|
|
3718
|
+
};
|
|
3719
|
+
};
|
|
3720
|
+
};
|
|
3721
|
+
archive_tag_api_v1_tags__tag_id__delete: {
|
|
3722
|
+
parameters: {
|
|
3723
|
+
query?: never;
|
|
3724
|
+
header?: {
|
|
3725
|
+
authorization?: string | null;
|
|
3726
|
+
"X-API-Key"?: string | null;
|
|
3727
|
+
};
|
|
3728
|
+
path: {
|
|
3729
|
+
tag_id: string;
|
|
3730
|
+
};
|
|
3731
|
+
cookie?: never;
|
|
3732
|
+
};
|
|
3733
|
+
requestBody?: never;
|
|
3734
|
+
responses: {
|
|
3735
|
+
/** @description Successful Response */
|
|
3736
|
+
204: {
|
|
3737
|
+
headers: {
|
|
3738
|
+
[name: string]: unknown;
|
|
3739
|
+
};
|
|
3740
|
+
content?: never;
|
|
3741
|
+
};
|
|
3742
|
+
/** @description Bad Request */
|
|
3743
|
+
400: {
|
|
3744
|
+
headers: {
|
|
3745
|
+
[name: string]: unknown;
|
|
3746
|
+
};
|
|
3747
|
+
content?: never;
|
|
3748
|
+
};
|
|
3749
|
+
/** @description Authentication Required */
|
|
3750
|
+
401: {
|
|
3751
|
+
headers: {
|
|
3752
|
+
[name: string]: unknown;
|
|
3753
|
+
};
|
|
3754
|
+
content?: never;
|
|
3755
|
+
};
|
|
3756
|
+
/** @description Access Denied */
|
|
3757
|
+
403: {
|
|
3758
|
+
headers: {
|
|
3759
|
+
[name: string]: unknown;
|
|
3760
|
+
};
|
|
3761
|
+
content?: never;
|
|
3762
|
+
};
|
|
3763
|
+
/** @description Resource Not Found */
|
|
3764
|
+
404: {
|
|
3765
|
+
headers: {
|
|
3766
|
+
[name: string]: unknown;
|
|
3767
|
+
};
|
|
3768
|
+
content?: never;
|
|
3769
|
+
};
|
|
3770
|
+
/** @description Resource Conflict */
|
|
3771
|
+
409: {
|
|
3772
|
+
headers: {
|
|
3773
|
+
[name: string]: unknown;
|
|
3774
|
+
};
|
|
3775
|
+
content?: never;
|
|
3776
|
+
};
|
|
3777
|
+
/** @description Validation Error */
|
|
3778
|
+
422: {
|
|
3779
|
+
headers: {
|
|
3780
|
+
[name: string]: unknown;
|
|
3781
|
+
};
|
|
3782
|
+
content?: never;
|
|
3783
|
+
};
|
|
3784
|
+
/** @description Internal Server Error */
|
|
3785
|
+
500: {
|
|
3786
|
+
headers: {
|
|
3787
|
+
[name: string]: unknown;
|
|
3788
|
+
};
|
|
3789
|
+
content?: never;
|
|
3790
|
+
};
|
|
3791
|
+
};
|
|
3792
|
+
};
|
|
3793
|
+
list_webhook_endpoints_api_v1_webhooks_get: {
|
|
3794
|
+
parameters: {
|
|
3795
|
+
query?: {
|
|
3796
|
+
/** @description Filter by active status */
|
|
3797
|
+
is_active?: boolean | null;
|
|
3798
|
+
/** @description Items per page */
|
|
3799
|
+
limit?: number;
|
|
3800
|
+
/** @description Number of items to skip */
|
|
3801
|
+
offset?: number;
|
|
3802
|
+
};
|
|
3803
|
+
header?: {
|
|
3804
|
+
authorization?: string | null;
|
|
3805
|
+
"X-API-Key"?: string | null;
|
|
3806
|
+
};
|
|
3807
|
+
path?: never;
|
|
3808
|
+
cookie?: never;
|
|
3809
|
+
};
|
|
3810
|
+
requestBody?: never;
|
|
3811
|
+
responses: {
|
|
3812
|
+
/** @description Successful Response */
|
|
3813
|
+
200: {
|
|
3814
|
+
headers: {
|
|
3815
|
+
[name: string]: unknown;
|
|
3816
|
+
};
|
|
3817
|
+
content: {
|
|
3818
|
+
"application/json": components["schemas"]["PaginatedWebhookEndpointResponse"];
|
|
3819
|
+
};
|
|
3820
|
+
};
|
|
3821
|
+
/** @description Bad Request */
|
|
3822
|
+
400: {
|
|
3823
|
+
headers: {
|
|
3824
|
+
[name: string]: unknown;
|
|
3825
|
+
};
|
|
3826
|
+
content?: never;
|
|
3827
|
+
};
|
|
3828
|
+
/** @description Authentication Required */
|
|
3829
|
+
401: {
|
|
3830
|
+
headers: {
|
|
3831
|
+
[name: string]: unknown;
|
|
3832
|
+
};
|
|
3833
|
+
content?: never;
|
|
3834
|
+
};
|
|
3835
|
+
/** @description Access Denied */
|
|
3836
|
+
403: {
|
|
3837
|
+
headers: {
|
|
3838
|
+
[name: string]: unknown;
|
|
3839
|
+
};
|
|
3840
|
+
content?: never;
|
|
3841
|
+
};
|
|
3842
|
+
/** @description Resource Not Found */
|
|
3843
|
+
404: {
|
|
3844
|
+
headers: {
|
|
3845
|
+
[name: string]: unknown;
|
|
3846
|
+
};
|
|
3847
|
+
content?: never;
|
|
3848
|
+
};
|
|
3849
|
+
/** @description Resource Conflict */
|
|
3850
|
+
409: {
|
|
3851
|
+
headers: {
|
|
3852
|
+
[name: string]: unknown;
|
|
3853
|
+
};
|
|
3854
|
+
content?: never;
|
|
3855
|
+
};
|
|
3856
|
+
/** @description Validation Error */
|
|
3857
|
+
422: {
|
|
3858
|
+
headers: {
|
|
3859
|
+
[name: string]: unknown;
|
|
3860
|
+
};
|
|
3861
|
+
content?: never;
|
|
3862
|
+
};
|
|
3863
|
+
/** @description Internal Server Error */
|
|
3864
|
+
500: {
|
|
3865
|
+
headers: {
|
|
3866
|
+
[name: string]: unknown;
|
|
3867
|
+
};
|
|
3868
|
+
content?: never;
|
|
3869
|
+
};
|
|
3870
|
+
};
|
|
3871
|
+
};
|
|
3872
|
+
create_webhook_endpoint_api_v1_webhooks_post: {
|
|
3873
|
+
parameters: {
|
|
3874
|
+
query?: never;
|
|
3875
|
+
header?: {
|
|
3876
|
+
authorization?: string | null;
|
|
3877
|
+
"X-API-Key"?: string | null;
|
|
3878
|
+
};
|
|
3879
|
+
path?: never;
|
|
3880
|
+
cookie?: never;
|
|
3881
|
+
};
|
|
3882
|
+
requestBody: {
|
|
3883
|
+
content: {
|
|
3884
|
+
"application/json": components["schemas"]["WebhookEndpointCreate"];
|
|
3885
|
+
};
|
|
3886
|
+
};
|
|
3887
|
+
responses: {
|
|
3888
|
+
/** @description Successful Response */
|
|
3889
|
+
201: {
|
|
3890
|
+
headers: {
|
|
3891
|
+
[name: string]: unknown;
|
|
3892
|
+
};
|
|
3893
|
+
content: {
|
|
3894
|
+
"application/json": components["schemas"]["WebhookEndpointWithSecret"];
|
|
3895
|
+
};
|
|
3896
|
+
};
|
|
3897
|
+
/** @description Bad Request */
|
|
3898
|
+
400: {
|
|
3899
|
+
headers: {
|
|
3900
|
+
[name: string]: unknown;
|
|
3901
|
+
};
|
|
3902
|
+
content?: never;
|
|
3903
|
+
};
|
|
3904
|
+
/** @description Authentication Required */
|
|
3905
|
+
401: {
|
|
3906
|
+
headers: {
|
|
3907
|
+
[name: string]: unknown;
|
|
3908
|
+
};
|
|
3909
|
+
content?: never;
|
|
3910
|
+
};
|
|
3911
|
+
/** @description Access Denied */
|
|
3912
|
+
403: {
|
|
3913
|
+
headers: {
|
|
3914
|
+
[name: string]: unknown;
|
|
3915
|
+
};
|
|
3916
|
+
content?: never;
|
|
3917
|
+
};
|
|
3918
|
+
/** @description Resource Not Found */
|
|
3919
|
+
404: {
|
|
3920
|
+
headers: {
|
|
3921
|
+
[name: string]: unknown;
|
|
3922
|
+
};
|
|
3923
|
+
content?: never;
|
|
3924
|
+
};
|
|
3925
|
+
/** @description Resource Conflict */
|
|
3926
|
+
409: {
|
|
3927
|
+
headers: {
|
|
3928
|
+
[name: string]: unknown;
|
|
3929
|
+
};
|
|
3930
|
+
content?: never;
|
|
3931
|
+
};
|
|
3932
|
+
/** @description Validation Error */
|
|
3933
|
+
422: {
|
|
3934
|
+
headers: {
|
|
3935
|
+
[name: string]: unknown;
|
|
3936
|
+
};
|
|
3937
|
+
content?: never;
|
|
3938
|
+
};
|
|
3939
|
+
/** @description Internal Server Error */
|
|
3940
|
+
500: {
|
|
3941
|
+
headers: {
|
|
3942
|
+
[name: string]: unknown;
|
|
3943
|
+
};
|
|
3944
|
+
content?: never;
|
|
3945
|
+
};
|
|
3946
|
+
};
|
|
3947
|
+
};
|
|
3948
|
+
get_webhook_endpoint_api_v1_webhooks__endpoint_id__get: {
|
|
3949
|
+
parameters: {
|
|
3950
|
+
query?: never;
|
|
3951
|
+
header?: {
|
|
3952
|
+
authorization?: string | null;
|
|
3953
|
+
"X-API-Key"?: string | null;
|
|
3954
|
+
};
|
|
3955
|
+
path: {
|
|
3956
|
+
endpoint_id: string;
|
|
3957
|
+
};
|
|
3958
|
+
cookie?: never;
|
|
3959
|
+
};
|
|
3960
|
+
requestBody?: never;
|
|
3961
|
+
responses: {
|
|
3962
|
+
/** @description Successful Response */
|
|
3963
|
+
200: {
|
|
3964
|
+
headers: {
|
|
3965
|
+
[name: string]: unknown;
|
|
3966
|
+
};
|
|
3967
|
+
content: {
|
|
3968
|
+
"application/json": components["schemas"]["WebhookEndpointResponse"];
|
|
3969
|
+
};
|
|
3970
|
+
};
|
|
3971
|
+
/** @description Bad Request */
|
|
3972
|
+
400: {
|
|
3973
|
+
headers: {
|
|
3974
|
+
[name: string]: unknown;
|
|
3975
|
+
};
|
|
3976
|
+
content?: never;
|
|
3977
|
+
};
|
|
3978
|
+
/** @description Authentication Required */
|
|
3979
|
+
401: {
|
|
3980
|
+
headers: {
|
|
3981
|
+
[name: string]: unknown;
|
|
3982
|
+
};
|
|
3983
|
+
content?: never;
|
|
3984
|
+
};
|
|
3985
|
+
/** @description Access Denied */
|
|
3986
|
+
403: {
|
|
3987
|
+
headers: {
|
|
3988
|
+
[name: string]: unknown;
|
|
3989
|
+
};
|
|
3990
|
+
content?: never;
|
|
3991
|
+
};
|
|
3992
|
+
/** @description Resource Not Found */
|
|
3993
|
+
404: {
|
|
3994
|
+
headers: {
|
|
3995
|
+
[name: string]: unknown;
|
|
3996
|
+
};
|
|
3997
|
+
content?: never;
|
|
3998
|
+
};
|
|
3999
|
+
/** @description Resource Conflict */
|
|
4000
|
+
409: {
|
|
4001
|
+
headers: {
|
|
4002
|
+
[name: string]: unknown;
|
|
4003
|
+
};
|
|
4004
|
+
content?: never;
|
|
4005
|
+
};
|
|
4006
|
+
/** @description Validation Error */
|
|
4007
|
+
422: {
|
|
4008
|
+
headers: {
|
|
4009
|
+
[name: string]: unknown;
|
|
4010
|
+
};
|
|
4011
|
+
content?: never;
|
|
4012
|
+
};
|
|
4013
|
+
/** @description Internal Server Error */
|
|
4014
|
+
500: {
|
|
4015
|
+
headers: {
|
|
4016
|
+
[name: string]: unknown;
|
|
4017
|
+
};
|
|
4018
|
+
content?: never;
|
|
4019
|
+
};
|
|
4020
|
+
};
|
|
4021
|
+
};
|
|
4022
|
+
delete_webhook_endpoint_api_v1_webhooks__endpoint_id__delete: {
|
|
4023
|
+
parameters: {
|
|
4024
|
+
query?: never;
|
|
4025
|
+
header?: {
|
|
4026
|
+
authorization?: string | null;
|
|
4027
|
+
"X-API-Key"?: string | null;
|
|
4028
|
+
};
|
|
4029
|
+
path: {
|
|
4030
|
+
endpoint_id: string;
|
|
4031
|
+
};
|
|
4032
|
+
cookie?: never;
|
|
4033
|
+
};
|
|
4034
|
+
requestBody?: never;
|
|
4035
|
+
responses: {
|
|
4036
|
+
/** @description Successful Response */
|
|
4037
|
+
204: {
|
|
4038
|
+
headers: {
|
|
4039
|
+
[name: string]: unknown;
|
|
4040
|
+
};
|
|
4041
|
+
content?: never;
|
|
4042
|
+
};
|
|
4043
|
+
/** @description Bad Request */
|
|
4044
|
+
400: {
|
|
4045
|
+
headers: {
|
|
4046
|
+
[name: string]: unknown;
|
|
4047
|
+
};
|
|
4048
|
+
content?: never;
|
|
4049
|
+
};
|
|
4050
|
+
/** @description Authentication Required */
|
|
4051
|
+
401: {
|
|
4052
|
+
headers: {
|
|
4053
|
+
[name: string]: unknown;
|
|
4054
|
+
};
|
|
4055
|
+
content?: never;
|
|
4056
|
+
};
|
|
4057
|
+
/** @description Access Denied */
|
|
4058
|
+
403: {
|
|
4059
|
+
headers: {
|
|
4060
|
+
[name: string]: unknown;
|
|
4061
|
+
};
|
|
4062
|
+
content?: never;
|
|
4063
|
+
};
|
|
4064
|
+
/** @description Resource Not Found */
|
|
4065
|
+
404: {
|
|
4066
|
+
headers: {
|
|
4067
|
+
[name: string]: unknown;
|
|
4068
|
+
};
|
|
4069
|
+
content?: never;
|
|
4070
|
+
};
|
|
4071
|
+
/** @description Resource Conflict */
|
|
4072
|
+
409: {
|
|
4073
|
+
headers: {
|
|
4074
|
+
[name: string]: unknown;
|
|
4075
|
+
};
|
|
4076
|
+
content?: never;
|
|
4077
|
+
};
|
|
4078
|
+
/** @description Validation Error */
|
|
4079
|
+
422: {
|
|
4080
|
+
headers: {
|
|
4081
|
+
[name: string]: unknown;
|
|
4082
|
+
};
|
|
4083
|
+
content?: never;
|
|
4084
|
+
};
|
|
4085
|
+
/** @description Internal Server Error */
|
|
4086
|
+
500: {
|
|
4087
|
+
headers: {
|
|
4088
|
+
[name: string]: unknown;
|
|
4089
|
+
};
|
|
4090
|
+
content?: never;
|
|
4091
|
+
};
|
|
4092
|
+
};
|
|
4093
|
+
};
|
|
4094
|
+
update_webhook_endpoint_api_v1_webhooks__endpoint_id__patch: {
|
|
4095
|
+
parameters: {
|
|
4096
|
+
query?: never;
|
|
4097
|
+
header?: {
|
|
4098
|
+
authorization?: string | null;
|
|
4099
|
+
"X-API-Key"?: string | null;
|
|
4100
|
+
};
|
|
4101
|
+
path: {
|
|
4102
|
+
endpoint_id: string;
|
|
4103
|
+
};
|
|
4104
|
+
cookie?: never;
|
|
4105
|
+
};
|
|
4106
|
+
requestBody: {
|
|
4107
|
+
content: {
|
|
4108
|
+
"application/json": components["schemas"]["WebhookEndpointUpdate"];
|
|
4109
|
+
};
|
|
4110
|
+
};
|
|
4111
|
+
responses: {
|
|
4112
|
+
/** @description Successful Response */
|
|
4113
|
+
200: {
|
|
4114
|
+
headers: {
|
|
4115
|
+
[name: string]: unknown;
|
|
4116
|
+
};
|
|
4117
|
+
content: {
|
|
4118
|
+
"application/json": components["schemas"]["WebhookEndpointResponse"];
|
|
4119
|
+
};
|
|
4120
|
+
};
|
|
4121
|
+
/** @description Bad Request */
|
|
4122
|
+
400: {
|
|
4123
|
+
headers: {
|
|
4124
|
+
[name: string]: unknown;
|
|
4125
|
+
};
|
|
4126
|
+
content?: never;
|
|
4127
|
+
};
|
|
4128
|
+
/** @description Authentication Required */
|
|
4129
|
+
401: {
|
|
4130
|
+
headers: {
|
|
4131
|
+
[name: string]: unknown;
|
|
4132
|
+
};
|
|
4133
|
+
content?: never;
|
|
4134
|
+
};
|
|
4135
|
+
/** @description Access Denied */
|
|
4136
|
+
403: {
|
|
4137
|
+
headers: {
|
|
4138
|
+
[name: string]: unknown;
|
|
4139
|
+
};
|
|
4140
|
+
content?: never;
|
|
4141
|
+
};
|
|
4142
|
+
/** @description Resource Not Found */
|
|
4143
|
+
404: {
|
|
4144
|
+
headers: {
|
|
4145
|
+
[name: string]: unknown;
|
|
4146
|
+
};
|
|
4147
|
+
content?: never;
|
|
4148
|
+
};
|
|
4149
|
+
/** @description Resource Conflict */
|
|
4150
|
+
409: {
|
|
4151
|
+
headers: {
|
|
4152
|
+
[name: string]: unknown;
|
|
4153
|
+
};
|
|
4154
|
+
content?: never;
|
|
4155
|
+
};
|
|
4156
|
+
/** @description Validation Error */
|
|
4157
|
+
422: {
|
|
4158
|
+
headers: {
|
|
4159
|
+
[name: string]: unknown;
|
|
4160
|
+
};
|
|
4161
|
+
content?: never;
|
|
4162
|
+
};
|
|
4163
|
+
/** @description Internal Server Error */
|
|
4164
|
+
500: {
|
|
4165
|
+
headers: {
|
|
4166
|
+
[name: string]: unknown;
|
|
4167
|
+
};
|
|
4168
|
+
content?: never;
|
|
4169
|
+
};
|
|
4170
|
+
};
|
|
4171
|
+
};
|
|
4172
|
+
regenerate_webhook_secret_api_v1_webhooks__endpoint_id__regenerate_secret_post: {
|
|
4173
|
+
parameters: {
|
|
4174
|
+
query?: never;
|
|
4175
|
+
header?: {
|
|
4176
|
+
authorization?: string | null;
|
|
4177
|
+
"X-API-Key"?: string | null;
|
|
4178
|
+
};
|
|
4179
|
+
path: {
|
|
4180
|
+
endpoint_id: string;
|
|
4181
|
+
};
|
|
4182
|
+
cookie?: never;
|
|
4183
|
+
};
|
|
4184
|
+
requestBody?: never;
|
|
4185
|
+
responses: {
|
|
4186
|
+
/** @description Successful Response */
|
|
4187
|
+
200: {
|
|
4188
|
+
headers: {
|
|
4189
|
+
[name: string]: unknown;
|
|
4190
|
+
};
|
|
4191
|
+
content: {
|
|
4192
|
+
"application/json": components["schemas"]["WebhookEndpointWithSecret"];
|
|
4193
|
+
};
|
|
4194
|
+
};
|
|
4195
|
+
/** @description Bad Request */
|
|
4196
|
+
400: {
|
|
4197
|
+
headers: {
|
|
4198
|
+
[name: string]: unknown;
|
|
4199
|
+
};
|
|
4200
|
+
content?: never;
|
|
4201
|
+
};
|
|
4202
|
+
/** @description Authentication Required */
|
|
4203
|
+
401: {
|
|
4204
|
+
headers: {
|
|
4205
|
+
[name: string]: unknown;
|
|
4206
|
+
};
|
|
4207
|
+
content?: never;
|
|
4208
|
+
};
|
|
4209
|
+
/** @description Access Denied */
|
|
4210
|
+
403: {
|
|
4211
|
+
headers: {
|
|
4212
|
+
[name: string]: unknown;
|
|
4213
|
+
};
|
|
4214
|
+
content?: never;
|
|
4215
|
+
};
|
|
4216
|
+
/** @description Resource Not Found */
|
|
4217
|
+
404: {
|
|
4218
|
+
headers: {
|
|
4219
|
+
[name: string]: unknown;
|
|
4220
|
+
};
|
|
4221
|
+
content?: never;
|
|
4222
|
+
};
|
|
4223
|
+
/** @description Resource Conflict */
|
|
4224
|
+
409: {
|
|
4225
|
+
headers: {
|
|
4226
|
+
[name: string]: unknown;
|
|
4227
|
+
};
|
|
4228
|
+
content?: never;
|
|
4229
|
+
};
|
|
4230
|
+
/** @description Validation Error */
|
|
4231
|
+
422: {
|
|
4232
|
+
headers: {
|
|
4233
|
+
[name: string]: unknown;
|
|
4234
|
+
};
|
|
4235
|
+
content?: never;
|
|
4236
|
+
};
|
|
4237
|
+
/** @description Internal Server Error */
|
|
4238
|
+
500: {
|
|
4239
|
+
headers: {
|
|
4240
|
+
[name: string]: unknown;
|
|
4241
|
+
};
|
|
4242
|
+
content?: never;
|
|
4243
|
+
};
|
|
4244
|
+
};
|
|
4245
|
+
};
|
|
4246
|
+
test_webhook_endpoint_api_v1_webhooks__endpoint_id__test_post: {
|
|
4247
|
+
parameters: {
|
|
4248
|
+
query?: never;
|
|
4249
|
+
header?: {
|
|
4250
|
+
authorization?: string | null;
|
|
4251
|
+
"X-API-Key"?: string | null;
|
|
4252
|
+
};
|
|
4253
|
+
path: {
|
|
4254
|
+
endpoint_id: string;
|
|
4255
|
+
};
|
|
4256
|
+
cookie?: never;
|
|
4257
|
+
};
|
|
4258
|
+
requestBody: {
|
|
4259
|
+
content: {
|
|
4260
|
+
"application/json": components["schemas"]["WebhookTestRequest"];
|
|
4261
|
+
};
|
|
4262
|
+
};
|
|
4263
|
+
responses: {
|
|
4264
|
+
/** @description Successful Response */
|
|
4265
|
+
200: {
|
|
4266
|
+
headers: {
|
|
4267
|
+
[name: string]: unknown;
|
|
4268
|
+
};
|
|
4269
|
+
content: {
|
|
4270
|
+
"application/json": components["schemas"]["WebhookTestResponse"];
|
|
4271
|
+
};
|
|
4272
|
+
};
|
|
4273
|
+
/** @description Bad Request */
|
|
4274
|
+
400: {
|
|
4275
|
+
headers: {
|
|
4276
|
+
[name: string]: unknown;
|
|
4277
|
+
};
|
|
4278
|
+
content?: never;
|
|
4279
|
+
};
|
|
4280
|
+
/** @description Authentication Required */
|
|
4281
|
+
401: {
|
|
4282
|
+
headers: {
|
|
4283
|
+
[name: string]: unknown;
|
|
4284
|
+
};
|
|
4285
|
+
content?: never;
|
|
4286
|
+
};
|
|
4287
|
+
/** @description Access Denied */
|
|
4288
|
+
403: {
|
|
4289
|
+
headers: {
|
|
4290
|
+
[name: string]: unknown;
|
|
4291
|
+
};
|
|
4292
|
+
content?: never;
|
|
4293
|
+
};
|
|
4294
|
+
/** @description Resource Not Found */
|
|
4295
|
+
404: {
|
|
4296
|
+
headers: {
|
|
4297
|
+
[name: string]: unknown;
|
|
4298
|
+
};
|
|
4299
|
+
content?: never;
|
|
4300
|
+
};
|
|
4301
|
+
/** @description Resource Conflict */
|
|
4302
|
+
409: {
|
|
4303
|
+
headers: {
|
|
4304
|
+
[name: string]: unknown;
|
|
4305
|
+
};
|
|
4306
|
+
content?: never;
|
|
4307
|
+
};
|
|
4308
|
+
/** @description Validation Error */
|
|
4309
|
+
422: {
|
|
4310
|
+
headers: {
|
|
4311
|
+
[name: string]: unknown;
|
|
4312
|
+
};
|
|
4313
|
+
content?: never;
|
|
4314
|
+
};
|
|
4315
|
+
/** @description Internal Server Error */
|
|
4316
|
+
500: {
|
|
4317
|
+
headers: {
|
|
4318
|
+
[name: string]: unknown;
|
|
4319
|
+
};
|
|
4320
|
+
content?: never;
|
|
4321
|
+
};
|
|
4322
|
+
};
|
|
4323
|
+
};
|
|
4324
|
+
list_endpoint_deliveries_api_v1_webhooks__endpoint_id__deliveries_get: {
|
|
4325
|
+
parameters: {
|
|
4326
|
+
query?: {
|
|
4327
|
+
/** @description Filter by event type */
|
|
4328
|
+
event_type?: components["schemas"]["WebhookEventType"] | null;
|
|
4329
|
+
/** @description Filter by status */
|
|
4330
|
+
status?: components["schemas"]["WebhookDeliveryStatus"] | null;
|
|
4331
|
+
/** @description Items per page */
|
|
4332
|
+
limit?: number;
|
|
4333
|
+
/** @description Number of items to skip */
|
|
4334
|
+
offset?: number;
|
|
4335
|
+
};
|
|
4336
|
+
header?: {
|
|
4337
|
+
authorization?: string | null;
|
|
4338
|
+
"X-API-Key"?: string | null;
|
|
4339
|
+
};
|
|
4340
|
+
path: {
|
|
4341
|
+
endpoint_id: string;
|
|
4342
|
+
};
|
|
4343
|
+
cookie?: never;
|
|
4344
|
+
};
|
|
4345
|
+
requestBody?: never;
|
|
4346
|
+
responses: {
|
|
4347
|
+
/** @description Successful Response */
|
|
4348
|
+
200: {
|
|
4349
|
+
headers: {
|
|
4350
|
+
[name: string]: unknown;
|
|
4351
|
+
};
|
|
4352
|
+
content: {
|
|
4353
|
+
"application/json": components["schemas"]["PaginatedWebhookDeliveryResponse"];
|
|
4354
|
+
};
|
|
4355
|
+
};
|
|
4356
|
+
/** @description Bad Request */
|
|
4357
|
+
400: {
|
|
4358
|
+
headers: {
|
|
4359
|
+
[name: string]: unknown;
|
|
4360
|
+
};
|
|
4361
|
+
content?: never;
|
|
4362
|
+
};
|
|
4363
|
+
/** @description Authentication Required */
|
|
4364
|
+
401: {
|
|
4365
|
+
headers: {
|
|
4366
|
+
[name: string]: unknown;
|
|
4367
|
+
};
|
|
4368
|
+
content?: never;
|
|
4369
|
+
};
|
|
4370
|
+
/** @description Access Denied */
|
|
4371
|
+
403: {
|
|
4372
|
+
headers: {
|
|
4373
|
+
[name: string]: unknown;
|
|
4374
|
+
};
|
|
4375
|
+
content?: never;
|
|
4376
|
+
};
|
|
4377
|
+
/** @description Resource Not Found */
|
|
4378
|
+
404: {
|
|
4379
|
+
headers: {
|
|
4380
|
+
[name: string]: unknown;
|
|
4381
|
+
};
|
|
4382
|
+
content?: never;
|
|
4383
|
+
};
|
|
4384
|
+
/** @description Resource Conflict */
|
|
4385
|
+
409: {
|
|
4386
|
+
headers: {
|
|
4387
|
+
[name: string]: unknown;
|
|
4388
|
+
};
|
|
4389
|
+
content?: never;
|
|
4390
|
+
};
|
|
4391
|
+
/** @description Validation Error */
|
|
4392
|
+
422: {
|
|
4393
|
+
headers: {
|
|
4394
|
+
[name: string]: unknown;
|
|
4395
|
+
};
|
|
4396
|
+
content?: never;
|
|
4397
|
+
};
|
|
4398
|
+
/** @description Internal Server Error */
|
|
4399
|
+
500: {
|
|
4400
|
+
headers: {
|
|
4401
|
+
[name: string]: unknown;
|
|
4402
|
+
};
|
|
4403
|
+
content?: never;
|
|
4404
|
+
};
|
|
4405
|
+
};
|
|
4406
|
+
};
|
|
4407
|
+
get_delivery_details_api_v1_webhooks__endpoint_id__deliveries__delivery_id__get: {
|
|
4408
|
+
parameters: {
|
|
4409
|
+
query?: never;
|
|
4410
|
+
header?: {
|
|
4411
|
+
authorization?: string | null;
|
|
4412
|
+
"X-API-Key"?: string | null;
|
|
4413
|
+
};
|
|
4414
|
+
path: {
|
|
4415
|
+
endpoint_id: string;
|
|
4416
|
+
delivery_id: string;
|
|
4417
|
+
};
|
|
4418
|
+
cookie?: never;
|
|
4419
|
+
};
|
|
4420
|
+
requestBody?: never;
|
|
4421
|
+
responses: {
|
|
4422
|
+
/** @description Successful Response */
|
|
4423
|
+
200: {
|
|
4424
|
+
headers: {
|
|
4425
|
+
[name: string]: unknown;
|
|
4426
|
+
};
|
|
4427
|
+
content: {
|
|
4428
|
+
"application/json": components["schemas"]["WebhookDeliveryDetailResponse"];
|
|
4429
|
+
};
|
|
4430
|
+
};
|
|
4431
|
+
/** @description Bad Request */
|
|
4432
|
+
400: {
|
|
4433
|
+
headers: {
|
|
4434
|
+
[name: string]: unknown;
|
|
4435
|
+
};
|
|
4436
|
+
content?: never;
|
|
4437
|
+
};
|
|
4438
|
+
/** @description Authentication Required */
|
|
4439
|
+
401: {
|
|
4440
|
+
headers: {
|
|
4441
|
+
[name: string]: unknown;
|
|
4442
|
+
};
|
|
4443
|
+
content?: never;
|
|
4444
|
+
};
|
|
4445
|
+
/** @description Access Denied */
|
|
4446
|
+
403: {
|
|
4447
|
+
headers: {
|
|
4448
|
+
[name: string]: unknown;
|
|
4449
|
+
};
|
|
4450
|
+
content?: never;
|
|
4451
|
+
};
|
|
4452
|
+
/** @description Resource Not Found */
|
|
4453
|
+
404: {
|
|
4454
|
+
headers: {
|
|
4455
|
+
[name: string]: unknown;
|
|
4456
|
+
};
|
|
4457
|
+
content?: never;
|
|
4458
|
+
};
|
|
4459
|
+
/** @description Resource Conflict */
|
|
4460
|
+
409: {
|
|
4461
|
+
headers: {
|
|
4462
|
+
[name: string]: unknown;
|
|
4463
|
+
};
|
|
4464
|
+
content?: never;
|
|
4465
|
+
};
|
|
4466
|
+
/** @description Validation Error */
|
|
4467
|
+
422: {
|
|
4468
|
+
headers: {
|
|
4469
|
+
[name: string]: unknown;
|
|
4470
|
+
};
|
|
4471
|
+
content?: never;
|
|
4472
|
+
};
|
|
4473
|
+
/** @description Internal Server Error */
|
|
4474
|
+
500: {
|
|
4475
|
+
headers: {
|
|
4476
|
+
[name: string]: unknown;
|
|
4477
|
+
};
|
|
4478
|
+
content?: never;
|
|
4479
|
+
};
|
|
4480
|
+
};
|
|
4481
|
+
};
|
|
4482
|
+
retry_delivery_api_v1_webhooks__endpoint_id__deliveries__delivery_id__retry_post: {
|
|
4483
|
+
parameters: {
|
|
4484
|
+
query?: never;
|
|
4485
|
+
header?: {
|
|
4486
|
+
authorization?: string | null;
|
|
4487
|
+
"X-API-Key"?: string | null;
|
|
4488
|
+
};
|
|
4489
|
+
path: {
|
|
4490
|
+
endpoint_id: string;
|
|
4491
|
+
delivery_id: string;
|
|
4492
|
+
};
|
|
4493
|
+
cookie?: never;
|
|
4494
|
+
};
|
|
4495
|
+
requestBody?: never;
|
|
4496
|
+
responses: {
|
|
4497
|
+
/** @description Successful Response */
|
|
4498
|
+
200: {
|
|
4499
|
+
headers: {
|
|
4500
|
+
[name: string]: unknown;
|
|
4501
|
+
};
|
|
4502
|
+
content: {
|
|
4503
|
+
"application/json": components["schemas"]["WebhookTestResponse"];
|
|
4504
|
+
};
|
|
4505
|
+
};
|
|
4506
|
+
/** @description Bad Request */
|
|
4507
|
+
400: {
|
|
4508
|
+
headers: {
|
|
4509
|
+
[name: string]: unknown;
|
|
4510
|
+
};
|
|
4511
|
+
content?: never;
|
|
4512
|
+
};
|
|
4513
|
+
/** @description Authentication Required */
|
|
4514
|
+
401: {
|
|
4515
|
+
headers: {
|
|
4516
|
+
[name: string]: unknown;
|
|
4517
|
+
};
|
|
4518
|
+
content?: never;
|
|
4519
|
+
};
|
|
4520
|
+
/** @description Access Denied */
|
|
4521
|
+
403: {
|
|
4522
|
+
headers: {
|
|
4523
|
+
[name: string]: unknown;
|
|
4524
|
+
};
|
|
4525
|
+
content?: never;
|
|
4526
|
+
};
|
|
4527
|
+
/** @description Resource Not Found */
|
|
4528
|
+
404: {
|
|
4529
|
+
headers: {
|
|
4530
|
+
[name: string]: unknown;
|
|
4531
|
+
};
|
|
4532
|
+
content?: never;
|
|
4533
|
+
};
|
|
4534
|
+
/** @description Resource Conflict */
|
|
4535
|
+
409: {
|
|
4536
|
+
headers: {
|
|
4537
|
+
[name: string]: unknown;
|
|
4538
|
+
};
|
|
4539
|
+
content?: never;
|
|
4540
|
+
};
|
|
4541
|
+
/** @description Validation Error */
|
|
4542
|
+
422: {
|
|
4543
|
+
headers: {
|
|
4544
|
+
[name: string]: unknown;
|
|
4545
|
+
};
|
|
4546
|
+
content?: never;
|
|
4547
|
+
};
|
|
4548
|
+
/** @description Internal Server Error */
|
|
4549
|
+
500: {
|
|
4550
|
+
headers: {
|
|
4551
|
+
[name: string]: unknown;
|
|
4552
|
+
};
|
|
4553
|
+
content?: never;
|
|
4554
|
+
};
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
get_endpoint_stats_api_v1_webhooks__endpoint_id__stats_get: {
|
|
4558
|
+
parameters: {
|
|
4559
|
+
query?: {
|
|
4560
|
+
/** @description Number of days */
|
|
4561
|
+
days?: number;
|
|
4562
|
+
};
|
|
4563
|
+
header?: {
|
|
4564
|
+
authorization?: string | null;
|
|
4565
|
+
"X-API-Key"?: string | null;
|
|
4566
|
+
};
|
|
4567
|
+
path: {
|
|
4568
|
+
endpoint_id: string;
|
|
4569
|
+
};
|
|
4570
|
+
cookie?: never;
|
|
4571
|
+
};
|
|
4572
|
+
requestBody?: never;
|
|
4573
|
+
responses: {
|
|
4574
|
+
/** @description Successful Response */
|
|
4575
|
+
200: {
|
|
4576
|
+
headers: {
|
|
4577
|
+
[name: string]: unknown;
|
|
4578
|
+
};
|
|
4579
|
+
content: {
|
|
4580
|
+
"application/json": components["schemas"]["WebhookDeliveryStatsResponse"];
|
|
4581
|
+
};
|
|
4582
|
+
};
|
|
4583
|
+
/** @description Bad Request */
|
|
4584
|
+
400: {
|
|
4585
|
+
headers: {
|
|
4586
|
+
[name: string]: unknown;
|
|
4587
|
+
};
|
|
4588
|
+
content?: never;
|
|
4589
|
+
};
|
|
4590
|
+
/** @description Authentication Required */
|
|
4591
|
+
401: {
|
|
4592
|
+
headers: {
|
|
4593
|
+
[name: string]: unknown;
|
|
4594
|
+
};
|
|
4595
|
+
content?: never;
|
|
4596
|
+
};
|
|
4597
|
+
/** @description Access Denied */
|
|
4598
|
+
403: {
|
|
4599
|
+
headers: {
|
|
4600
|
+
[name: string]: unknown;
|
|
4601
|
+
};
|
|
4602
|
+
content?: never;
|
|
4603
|
+
};
|
|
4604
|
+
/** @description Resource Not Found */
|
|
4605
|
+
404: {
|
|
4606
|
+
headers: {
|
|
4607
|
+
[name: string]: unknown;
|
|
4608
|
+
};
|
|
4609
|
+
content?: never;
|
|
4610
|
+
};
|
|
4611
|
+
/** @description Resource Conflict */
|
|
4612
|
+
409: {
|
|
4613
|
+
headers: {
|
|
4614
|
+
[name: string]: unknown;
|
|
4615
|
+
};
|
|
4616
|
+
content?: never;
|
|
4617
|
+
};
|
|
4618
|
+
/** @description Validation Error */
|
|
4619
|
+
422: {
|
|
4620
|
+
headers: {
|
|
4621
|
+
[name: string]: unknown;
|
|
4622
|
+
};
|
|
4623
|
+
content?: never;
|
|
4624
|
+
};
|
|
4625
|
+
/** @description Internal Server Error */
|
|
4626
|
+
500: {
|
|
4627
|
+
headers: {
|
|
4628
|
+
[name: string]: unknown;
|
|
4629
|
+
};
|
|
4630
|
+
content?: never;
|
|
4631
|
+
};
|
|
4632
|
+
};
|
|
4633
|
+
};
|
|
4634
|
+
list_all_deliveries_api_v1_webhooks_deliveries_all_get: {
|
|
4635
|
+
parameters: {
|
|
4636
|
+
query?: {
|
|
4637
|
+
/** @description Filter by event type */
|
|
4638
|
+
event_type?: components["schemas"]["WebhookEventType"] | null;
|
|
4639
|
+
/** @description Filter by status */
|
|
4640
|
+
status?: components["schemas"]["WebhookDeliveryStatus"] | null;
|
|
4641
|
+
/** @description Items per page */
|
|
4642
|
+
limit?: number;
|
|
4643
|
+
/** @description Number of items to skip */
|
|
4644
|
+
offset?: number;
|
|
4645
|
+
};
|
|
4646
|
+
header?: {
|
|
4647
|
+
authorization?: string | null;
|
|
4648
|
+
"X-API-Key"?: string | null;
|
|
4649
|
+
};
|
|
4650
|
+
path?: never;
|
|
4651
|
+
cookie?: never;
|
|
4652
|
+
};
|
|
4653
|
+
requestBody?: never;
|
|
4654
|
+
responses: {
|
|
4655
|
+
/** @description Successful Response */
|
|
4656
|
+
200: {
|
|
4657
|
+
headers: {
|
|
4658
|
+
[name: string]: unknown;
|
|
4659
|
+
};
|
|
4660
|
+
content: {
|
|
4661
|
+
"application/json": components["schemas"]["PaginatedWebhookDeliveryResponse"];
|
|
4662
|
+
};
|
|
4663
|
+
};
|
|
4664
|
+
/** @description Bad Request */
|
|
4665
|
+
400: {
|
|
4666
|
+
headers: {
|
|
4667
|
+
[name: string]: unknown;
|
|
4668
|
+
};
|
|
4669
|
+
content?: never;
|
|
4670
|
+
};
|
|
4671
|
+
/** @description Authentication Required */
|
|
4672
|
+
401: {
|
|
4673
|
+
headers: {
|
|
4674
|
+
[name: string]: unknown;
|
|
4675
|
+
};
|
|
4676
|
+
content?: never;
|
|
4677
|
+
};
|
|
4678
|
+
/** @description Access Denied */
|
|
4679
|
+
403: {
|
|
4680
|
+
headers: {
|
|
4681
|
+
[name: string]: unknown;
|
|
4682
|
+
};
|
|
4683
|
+
content?: never;
|
|
4684
|
+
};
|
|
4685
|
+
/** @description Resource Not Found */
|
|
4686
|
+
404: {
|
|
4687
|
+
headers: {
|
|
4688
|
+
[name: string]: unknown;
|
|
4689
|
+
};
|
|
4690
|
+
content?: never;
|
|
4691
|
+
};
|
|
4692
|
+
/** @description Resource Conflict */
|
|
4693
|
+
409: {
|
|
4694
|
+
headers: {
|
|
4695
|
+
[name: string]: unknown;
|
|
4696
|
+
};
|
|
4697
|
+
content?: never;
|
|
4698
|
+
};
|
|
4699
|
+
/** @description Validation Error */
|
|
4700
|
+
422: {
|
|
4701
|
+
headers: {
|
|
4702
|
+
[name: string]: unknown;
|
|
4703
|
+
};
|
|
4704
|
+
content?: never;
|
|
4705
|
+
};
|
|
4706
|
+
/** @description Internal Server Error */
|
|
4707
|
+
500: {
|
|
4708
|
+
headers: {
|
|
4709
|
+
[name: string]: unknown;
|
|
4710
|
+
};
|
|
4711
|
+
content?: never;
|
|
4712
|
+
};
|
|
4713
|
+
};
|
|
4714
|
+
};
|
|
4715
|
+
get_global_stats_api_v1_webhooks_stats_all_get: {
|
|
4716
|
+
parameters: {
|
|
4717
|
+
query?: {
|
|
4718
|
+
/** @description Number of days */
|
|
4719
|
+
days?: number;
|
|
4720
|
+
};
|
|
4721
|
+
header?: {
|
|
4722
|
+
authorization?: string | null;
|
|
4723
|
+
"X-API-Key"?: string | null;
|
|
4724
|
+
};
|
|
4725
|
+
path?: never;
|
|
4726
|
+
cookie?: never;
|
|
4727
|
+
};
|
|
4728
|
+
requestBody?: never;
|
|
4729
|
+
responses: {
|
|
4730
|
+
/** @description Successful Response */
|
|
4731
|
+
200: {
|
|
4732
|
+
headers: {
|
|
4733
|
+
[name: string]: unknown;
|
|
4734
|
+
};
|
|
4735
|
+
content: {
|
|
4736
|
+
"application/json": components["schemas"]["WebhookDeliveryStatsResponse"];
|
|
4737
|
+
};
|
|
4738
|
+
};
|
|
4739
|
+
/** @description Bad Request */
|
|
4740
|
+
400: {
|
|
4741
|
+
headers: {
|
|
4742
|
+
[name: string]: unknown;
|
|
4743
|
+
};
|
|
4744
|
+
content?: never;
|
|
4745
|
+
};
|
|
4746
|
+
/** @description Authentication Required */
|
|
4747
|
+
401: {
|
|
4748
|
+
headers: {
|
|
4749
|
+
[name: string]: unknown;
|
|
4750
|
+
};
|
|
4751
|
+
content?: never;
|
|
4752
|
+
};
|
|
4753
|
+
/** @description Access Denied */
|
|
4754
|
+
403: {
|
|
4755
|
+
headers: {
|
|
4756
|
+
[name: string]: unknown;
|
|
4757
|
+
};
|
|
4758
|
+
content?: never;
|
|
4759
|
+
};
|
|
4760
|
+
/** @description Resource Not Found */
|
|
4761
|
+
404: {
|
|
4762
|
+
headers: {
|
|
4763
|
+
[name: string]: unknown;
|
|
4764
|
+
};
|
|
4765
|
+
content?: never;
|
|
4766
|
+
};
|
|
4767
|
+
/** @description Resource Conflict */
|
|
4768
|
+
409: {
|
|
4769
|
+
headers: {
|
|
4770
|
+
[name: string]: unknown;
|
|
4771
|
+
};
|
|
4772
|
+
content?: never;
|
|
4773
|
+
};
|
|
4774
|
+
/** @description Validation Error */
|
|
4775
|
+
422: {
|
|
4776
|
+
headers: {
|
|
4777
|
+
[name: string]: unknown;
|
|
4778
|
+
};
|
|
4779
|
+
content?: never;
|
|
4780
|
+
};
|
|
4781
|
+
/** @description Internal Server Error */
|
|
4782
|
+
500: {
|
|
4783
|
+
headers: {
|
|
4784
|
+
[name: string]: unknown;
|
|
4785
|
+
};
|
|
4786
|
+
content?: never;
|
|
4787
|
+
};
|
|
4788
|
+
};
|
|
4789
|
+
};
|
|
4790
|
+
list_event_types_api_v1_webhooks_event_types_get: {
|
|
4791
|
+
parameters: {
|
|
4792
|
+
query?: never;
|
|
4793
|
+
header?: {
|
|
4794
|
+
authorization?: string | null;
|
|
4795
|
+
"X-API-Key"?: string | null;
|
|
4796
|
+
};
|
|
4797
|
+
path?: never;
|
|
4798
|
+
cookie?: never;
|
|
4799
|
+
};
|
|
4800
|
+
requestBody?: never;
|
|
4801
|
+
responses: {
|
|
4802
|
+
/** @description Successful Response */
|
|
4803
|
+
200: {
|
|
4804
|
+
headers: {
|
|
4805
|
+
[name: string]: unknown;
|
|
4806
|
+
};
|
|
4807
|
+
content: {
|
|
4808
|
+
"application/json": {
|
|
4809
|
+
[key: string]: unknown;
|
|
4810
|
+
};
|
|
4811
|
+
};
|
|
4812
|
+
};
|
|
4813
|
+
/** @description Bad Request */
|
|
4814
|
+
400: {
|
|
4815
|
+
headers: {
|
|
4816
|
+
[name: string]: unknown;
|
|
4817
|
+
};
|
|
4818
|
+
content?: never;
|
|
4819
|
+
};
|
|
4820
|
+
/** @description Authentication Required */
|
|
4821
|
+
401: {
|
|
4822
|
+
headers: {
|
|
4823
|
+
[name: string]: unknown;
|
|
4824
|
+
};
|
|
4825
|
+
content?: never;
|
|
4826
|
+
};
|
|
4827
|
+
/** @description Access Denied */
|
|
4828
|
+
403: {
|
|
4829
|
+
headers: {
|
|
4830
|
+
[name: string]: unknown;
|
|
4831
|
+
};
|
|
4832
|
+
content?: never;
|
|
4833
|
+
};
|
|
4834
|
+
/** @description Resource Not Found */
|
|
4835
|
+
404: {
|
|
4836
|
+
headers: {
|
|
4837
|
+
[name: string]: unknown;
|
|
4838
|
+
};
|
|
4839
|
+
content?: never;
|
|
4840
|
+
};
|
|
4841
|
+
/** @description Resource Conflict */
|
|
4842
|
+
409: {
|
|
4843
|
+
headers: {
|
|
4844
|
+
[name: string]: unknown;
|
|
4845
|
+
};
|
|
4846
|
+
content?: never;
|
|
4847
|
+
};
|
|
4848
|
+
/** @description Validation Error */
|
|
4849
|
+
422: {
|
|
4850
|
+
headers: {
|
|
4851
|
+
[name: string]: unknown;
|
|
4852
|
+
};
|
|
4853
|
+
content?: never;
|
|
4854
|
+
};
|
|
4855
|
+
/** @description Internal Server Error */
|
|
4856
|
+
500: {
|
|
4857
|
+
headers: {
|
|
4858
|
+
[name: string]: unknown;
|
|
4859
|
+
};
|
|
4860
|
+
content?: never;
|
|
4861
|
+
};
|
|
4862
|
+
};
|
|
4863
|
+
};
|
|
4864
|
+
}
|
|
4865
|
+
//# sourceMappingURL=api-types.d.ts.map
|