@productcraft/mail 0.2.2 → 0.2.3
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/dist/index.d.cts +366 -102
- package/dist/index.d.ts +366 -102
- package/package.json +3 -3
package/dist/index.d.cts
CHANGED
|
@@ -2752,7 +2752,10 @@ interface components {
|
|
|
2752
2752
|
visibility: "public" | "private";
|
|
2753
2753
|
};
|
|
2754
2754
|
CreateWebhookEndpointDto: {
|
|
2755
|
-
/**
|
|
2755
|
+
/**
|
|
2756
|
+
* @description A label for people.
|
|
2757
|
+
* @example Production receiver
|
|
2758
|
+
*/
|
|
2756
2759
|
description?: string | null;
|
|
2757
2760
|
/**
|
|
2758
2761
|
* Format: uuid
|
|
@@ -4304,15 +4307,19 @@ interface components {
|
|
|
4304
4307
|
pagination: components["schemas"]["PaginationDto"];
|
|
4305
4308
|
};
|
|
4306
4309
|
ListWebhookEndpointsResponseDto: {
|
|
4310
|
+
/** @description The endpoints, newest first. */
|
|
4307
4311
|
data: components["schemas"]["WebhookEndpointDto"][];
|
|
4308
4312
|
/** @description Always one page (an endpoint limit applies). */
|
|
4309
4313
|
pagination: components["schemas"]["WebhookPaginationDto"];
|
|
4310
4314
|
};
|
|
4311
4315
|
ListWebhookEventTypesResponseDto: {
|
|
4316
|
+
/** @description Every event type this product sends. */
|
|
4312
4317
|
data: components["schemas"]["WebhookEventTypeDto"][];
|
|
4313
4318
|
};
|
|
4314
4319
|
ListWebhookEventsResponseDto: {
|
|
4320
|
+
/** @description The events, newest first. */
|
|
4315
4321
|
data: components["schemas"]["WebhookEventDto"][];
|
|
4322
|
+
/** @description The cursor for the next page. */
|
|
4316
4323
|
pagination: components["schemas"]["WebhookPaginationDto"];
|
|
4317
4324
|
};
|
|
4318
4325
|
LookupDmarcDto: {
|
|
@@ -4385,7 +4392,7 @@ interface components {
|
|
|
4385
4392
|
reason: string;
|
|
4386
4393
|
};
|
|
4387
4394
|
/** @description Error codes this API returns (open set: a client must accept codes it does not know; new codes are not a breaking change). Each is documented at https://productcraft.co/docs/errors#<code>. */
|
|
4388
|
-
MailErrorCode: ("BAD_REQUEST" | "VALIDATION_ERROR" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "REQUEST_TIMEOUT" | "CONFLICT" | "GONE" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "UNSUPPORTED_MEDIA_TYPE" | "UNPROCESSABLE_ENTITY" | "PRECONDITION_REQUIRED" | "RATE_LIMITED" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "SERVICE_NOT_ENABLED" | "INVALID_CREDENTIALS" | "SESSION_REVOKED" | "MCP_NOT_PERMITTED" | "MCP_WORKSPACE_MISMATCH" | "PAK_NOT_PERMITTED" | "ACTIONS_NOT_GRANTABLE" | "IDEMPOTENCY_KEY_REUSE" | "IDEMPOTENCY_KEY_REQUIRED" | "WEBHOOK_ENDPOINT_LIMIT" | "WEBHOOK_ENDPOINT_NOT_FOUND" | "WEBHOOK_ENDPOINT_NOT_SUBSCRIBED" | "WEBHOOK_EVENT_NOT_FOUND" | "WEBHOOK_EVENT_TYPE_UNKNOWN" | "AUDIENCE_REQUIRED" | "BROADCAST_AUDIENCE_EMPTY" | "BROADCAST_CONTENT_CONFLICT" | "BROADCAST_NOT_CANCELABLE" | "BROADCAST_NOT_DELETABLE" | "BROADCAST_NOT_DRAFT" | "BROADCAST_NOT_FOUND" | "BROADCAST_NOT_READY" | "CAPABILITY_NOT_VERIFIED" | "CONTACT_EXISTS" | "CONTACT_LIMIT" | "CONTACT_NOT_FOUND" | "CONTACT_PROPERTY_EXISTS" | "CONTACT_PROPERTY_LIMIT" | "CONTACT_PROPERTY_NOT_FOUND" | "DATE_RANGE_BEYOND_RETENTION" | "DATE_RANGE_TOO_WIDE" | "DATE_WINDOW_TOO_WIDE" | "DKIM_KEY_MISSING" | "DNS_CONFLICTS" | "DOMAIN_CONNECT_DISABLED" | "DOMAIN_CONNECT_MAIL_FROM_LABEL" | "DOMAIN_CONNECT_NOT_SENDING" | "DOMAIN_CONNECT_UNAVAILABLE" | "DOMAIN_HAS_MAILBOXES" | "DOMAIN_NOT_FOUND" | "EMAIL_UNAVAILABLE" | "FROM_DOMAIN_MISMATCH" | "IDEMPOTENCY_KEY_CONFLICTS_WITH_ROW" | "IMPORT_IN_PROGRESS" | "IMPORT_NOT_FOUND" | "IMPORT_TOO_LARGE" | "INVALID_CAPABILITIES" | "INVALID_CONTACT_PROPERTY_VALUE" | "INVALID_CSV" | "INVALID_DATE" | "INVALID_DATE_RANGE" | "INVALID_DATE_WINDOW" | "INVALID_FORMAT" | "INVALID_FROM_ADDRESS" | "INVALID_SEGMENT_RULE" | "INVALID_TIMEZONE" | "INVALID_ZONE" | "MAIL_FROM_HOST_IN_USE" | "MAIL_FROM_NOT_SENDING" | "PROVIDER_ERROR" | "PROVIDER_PERMISSION_DENIED" | "PROVIDER_TOKEN_REJECTED" | "PROVIDER_UNAVAILABLE" | "PROVIDER_ZONE_NOT_FOUND" | "RECIPIENT_SUPPRESSED" | "REGION_NOT_AVAILABLE" | "RESERVED_PROPERTY_KEY" | "SEGMENT_EXISTS" | "SEGMENT_LIMIT" | "SEGMENT_NOT_FOUND" | "SEGMENT_RULE_BASED" | "SEGMENT_TYPE_FIXED" | "SES_IDENTITY_DELETE_FAILED" | "SHARE_LINK_NOT_FOUND" | "SMTP_AUTH_PARTIAL" | "SMTP_CONFIG_NOT_FOUND" | "SMTP_PASSWORD_REQUIRED" | "TEMPLATE_DATA_INVALID" | "TEMPLATE_KIND_NOT_SENDABLE" | "TEMPLATE_NOT_FOUND" | "TEMPLATE_RENDER_FAILED" | "TLS_ENFORCED_NOT_AVAILABLE" | "TOPIC_EXISTS" | "TOPIC_LIMIT" | "TOPIC_NOT_FOUND" | "TRACKING_NOT_AVAILABLE" | "UNKNOWN_CONTACT_PROPERTY" | "UNSUBSCRIBE_LINK_REQUIRED" | "domain_not_verified_by_provider" | "from_domain_not_verified" | "no_default_sender" | "sender_domain_not_in_workspace") | string;
|
|
4395
|
+
MailErrorCode: ("BAD_REQUEST" | "VALIDATION_ERROR" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "REQUEST_TIMEOUT" | "CONFLICT" | "GONE" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "UNSUPPORTED_MEDIA_TYPE" | "UNPROCESSABLE_ENTITY" | "PRECONDITION_REQUIRED" | "RATE_LIMITED" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "SERVICE_NOT_ENABLED" | "INVALID_CREDENTIALS" | "SESSION_REVOKED" | "MCP_NOT_PERMITTED" | "MCP_WORKSPACE_MISMATCH" | "PAK_NOT_PERMITTED" | "ACTIONS_NOT_GRANTABLE" | "IDEMPOTENCY_KEY_REUSE" | "IDEMPOTENCY_KEY_REQUIRED" | "IDEMPOTENCY_IN_PROGRESS" | "WEBHOOK_ENDPOINT_LIMIT" | "WEBHOOK_ENDPOINT_NOT_FOUND" | "WEBHOOK_ENDPOINT_NOT_SUBSCRIBED" | "WEBHOOK_EVENT_NOT_FOUND" | "WEBHOOK_EVENT_TYPE_UNKNOWN" | "AUDIENCE_REQUIRED" | "BROADCAST_AUDIENCE_EMPTY" | "BROADCAST_CONTENT_CONFLICT" | "BROADCAST_NOT_CANCELABLE" | "BROADCAST_NOT_DELETABLE" | "BROADCAST_NOT_DRAFT" | "BROADCAST_NOT_FOUND" | "BROADCAST_NOT_READY" | "CAPABILITY_NOT_VERIFIED" | "CONTACT_EXISTS" | "CONTACT_LIMIT" | "CONTACT_NOT_FOUND" | "CONTACT_PROPERTY_EXISTS" | "CONTACT_PROPERTY_LIMIT" | "CONTACT_PROPERTY_NOT_FOUND" | "DATE_RANGE_BEYOND_RETENTION" | "DATE_RANGE_TOO_WIDE" | "DATE_WINDOW_TOO_WIDE" | "DKIM_KEY_MISSING" | "DNS_CONFLICTS" | "DOMAIN_CONNECT_DISABLED" | "DOMAIN_CONNECT_MAIL_FROM_LABEL" | "DOMAIN_CONNECT_NOT_SENDING" | "DOMAIN_CONNECT_UNAVAILABLE" | "DOMAIN_HAS_MAILBOXES" | "DOMAIN_NOT_FOUND" | "EMAIL_UNAVAILABLE" | "FROM_DOMAIN_MISMATCH" | "IDEMPOTENCY_KEY_CONFLICTS_WITH_ROW" | "IMPORT_IN_PROGRESS" | "IMPORT_NOT_FOUND" | "IMPORT_TOO_LARGE" | "INVALID_CAPABILITIES" | "INVALID_CONTACT_PROPERTY_VALUE" | "INVALID_CSV" | "INVALID_DATE" | "INVALID_DATE_RANGE" | "INVALID_DATE_WINDOW" | "INVALID_FORMAT" | "INVALID_FROM_ADDRESS" | "INVALID_SEGMENT_RULE" | "INVALID_TIMEZONE" | "INVALID_ZONE" | "MAIL_FROM_HOST_IN_USE" | "MAIL_FROM_NOT_SENDING" | "PROVIDER_ERROR" | "PROVIDER_PERMISSION_DENIED" | "PROVIDER_TOKEN_REJECTED" | "PROVIDER_UNAVAILABLE" | "PROVIDER_ZONE_NOT_FOUND" | "RECIPIENT_SUPPRESSED" | "REGION_NOT_AVAILABLE" | "RESERVED_PROPERTY_KEY" | "SEGMENT_EXISTS" | "SEGMENT_LIMIT" | "SEGMENT_NOT_FOUND" | "SEGMENT_RULE_BASED" | "SEGMENT_TYPE_FIXED" | "SES_IDENTITY_DELETE_FAILED" | "SHARE_LINK_NOT_FOUND" | "SMTP_AUTH_PARTIAL" | "SMTP_CONFIG_NOT_FOUND" | "SMTP_PASSWORD_REQUIRED" | "TEMPLATE_DATA_INVALID" | "TEMPLATE_KIND_NOT_SENDABLE" | "TEMPLATE_NOT_FOUND" | "TEMPLATE_RENDER_FAILED" | "TLS_ENFORCED_NOT_AVAILABLE" | "TOPIC_EXISTS" | "TOPIC_LIMIT" | "TOPIC_NOT_FOUND" | "TRACKING_NOT_AVAILABLE" | "UNKNOWN_CONTACT_PROPERTY" | "UNSUBSCRIBE_LINK_REQUIRED" | "domain_not_verified_by_provider" | "from_domain_not_verified" | "no_default_sender" | "sender_domain_not_in_workspace") | string;
|
|
4389
4396
|
MailStatsInWindowDto: {
|
|
4390
4397
|
/**
|
|
4391
4398
|
* @description Bounce rate, 0 to 1: bounced / emails sent (sent, delivered, deferred, bounced, complained — narrower than `sent` above, which also counts failed and suppressed). Null when nothing was sent.
|
|
@@ -5363,6 +5370,7 @@ interface components {
|
|
|
5363
5370
|
ReplayWebhookEventResponseDto: {
|
|
5364
5371
|
/** @description One attempt per endpoint it was sent to. */
|
|
5365
5372
|
attempts: components["schemas"]["WebhookDeliveryAttemptDto"][];
|
|
5373
|
+
/** @description The replayed event (the same id as the original). */
|
|
5366
5374
|
event_id: string;
|
|
5367
5375
|
};
|
|
5368
5376
|
ResolvedBrandTokensDto: {
|
|
@@ -6032,6 +6040,7 @@ interface components {
|
|
|
6032
6040
|
visibility?: "public" | "private";
|
|
6033
6041
|
};
|
|
6034
6042
|
UpdateWebhookEndpointDto: {
|
|
6043
|
+
/** @description A new label; null clears it. */
|
|
6035
6044
|
description?: string | null;
|
|
6036
6045
|
/**
|
|
6037
6046
|
* Format: uuid
|
|
@@ -6046,6 +6055,7 @@ interface components {
|
|
|
6046
6055
|
events?: ("email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted" | "message.sent" | "message.delivered" | "message.deferred" | "message.bounced" | "message.complained" | "message.failed")[];
|
|
6047
6056
|
/**
|
|
6048
6057
|
* Format: uri
|
|
6058
|
+
* @description A new absolute https:// URL on a public host.
|
|
6049
6059
|
* @example https://api.acme.com/webhooks
|
|
6050
6060
|
*/
|
|
6051
6061
|
url?: string;
|
|
@@ -6153,26 +6163,47 @@ interface components {
|
|
|
6153
6163
|
/** @description SMTP username. May be omitted alongside password for anonymous SMTP (e.g. postfix on a private network); otherwise both are required. */
|
|
6154
6164
|
username?: string;
|
|
6155
6165
|
};
|
|
6166
|
+
/** @enum {string} */
|
|
6167
|
+
WebhookAttemptTrigger: "automatic" | "replay" | "test";
|
|
6156
6168
|
WebhookDeliveryAttemptDto: {
|
|
6157
6169
|
/** @description 1 for the first delivery; retries and replays count up. */
|
|
6158
6170
|
attempt_number: number;
|
|
6159
|
-
/**
|
|
6171
|
+
/**
|
|
6172
|
+
* Format: date-time
|
|
6173
|
+
* @description When the attempt was made.
|
|
6174
|
+
*/
|
|
6160
6175
|
attempted_at: string;
|
|
6161
6176
|
/**
|
|
6162
6177
|
* Format: uuid
|
|
6163
6178
|
* @description The endpoint's domain filter, if it has one.
|
|
6164
6179
|
*/
|
|
6165
6180
|
domain_id: string | null;
|
|
6166
|
-
/**
|
|
6181
|
+
/**
|
|
6182
|
+
* Format: uuid
|
|
6183
|
+
* @description The endpoint it was delivered to.
|
|
6184
|
+
*/
|
|
6167
6185
|
endpoint_id: string;
|
|
6168
|
-
/**
|
|
6186
|
+
/**
|
|
6187
|
+
* @description Why the attempt failed when no 2xx came back; null on success.
|
|
6188
|
+
* @example request timed out
|
|
6189
|
+
*/
|
|
6169
6190
|
error_message: string | null;
|
|
6170
|
-
/**
|
|
6191
|
+
/**
|
|
6192
|
+
* @description The event that was delivered.
|
|
6193
|
+
* @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f
|
|
6194
|
+
*/
|
|
6171
6195
|
event_id: string;
|
|
6172
|
-
/**
|
|
6196
|
+
/**
|
|
6197
|
+
* @description The event's type.
|
|
6198
|
+
* @example user.created
|
|
6199
|
+
*/
|
|
6173
6200
|
event_type: string;
|
|
6174
|
-
/**
|
|
6201
|
+
/**
|
|
6202
|
+
* Format: uuid
|
|
6203
|
+
* @description The attempt's id.
|
|
6204
|
+
*/
|
|
6175
6205
|
id: string;
|
|
6206
|
+
/** @description Milliseconds until the response; null when none came back. */
|
|
6176
6207
|
latency_ms: number | null;
|
|
6177
6208
|
/** @description The first 1 KiB of the response body. */
|
|
6178
6209
|
response_body: string | null;
|
|
@@ -6182,28 +6213,36 @@ interface components {
|
|
|
6182
6213
|
status_code: number | null;
|
|
6183
6214
|
/** @description True for a 2xx response. */
|
|
6184
6215
|
succeeded: boolean;
|
|
6185
|
-
/**
|
|
6186
|
-
|
|
6187
|
-
* @enum {string}
|
|
6188
|
-
*/
|
|
6189
|
-
trigger: "automatic" | "replay" | "test";
|
|
6216
|
+
/** @description `automatic` (first delivery or a retry), `replay` or `test`. */
|
|
6217
|
+
trigger: components["schemas"]["WebhookAttemptTrigger"];
|
|
6190
6218
|
/**
|
|
6191
6219
|
* Format: uri
|
|
6192
6220
|
* @description Where it was sent.
|
|
6193
6221
|
*/
|
|
6194
6222
|
url: string;
|
|
6195
6223
|
};
|
|
6224
|
+
/** @enum {string} */
|
|
6225
|
+
WebhookEndpointDisabledReason: "manual" | "failing";
|
|
6196
6226
|
WebhookEndpointDto: {
|
|
6197
6227
|
/** @description Failed automatic deliveries in a row; a success resets it. */
|
|
6198
6228
|
consecutive_failures: number;
|
|
6199
|
-
/**
|
|
6229
|
+
/**
|
|
6230
|
+
* Format: date-time
|
|
6231
|
+
* @description When the endpoint was created.
|
|
6232
|
+
*/
|
|
6200
6233
|
created_at: string;
|
|
6201
|
-
/**
|
|
6234
|
+
/**
|
|
6235
|
+
* @description A label for people; null when unset.
|
|
6236
|
+
* @example Production receiver
|
|
6237
|
+
*/
|
|
6202
6238
|
description: string | null;
|
|
6203
|
-
/**
|
|
6239
|
+
/**
|
|
6240
|
+
* Format: date-time
|
|
6241
|
+
* @description When it was switched off; null while enabled.
|
|
6242
|
+
*/
|
|
6204
6243
|
disabled_at: string | null;
|
|
6205
|
-
/** @
|
|
6206
|
-
disabled_reason: "
|
|
6244
|
+
/** @description `manual`: switched off by a caller. `failing`: switched off automatically after failed deliveries. Null while enabled. */
|
|
6245
|
+
disabled_reason: components["schemas"]["WebhookEndpointDisabledReason"] | null;
|
|
6207
6246
|
/**
|
|
6208
6247
|
* Format: uuid
|
|
6209
6248
|
* @description Only events about this domain; null for every event of the workspace.
|
|
@@ -6228,7 +6267,10 @@ interface components {
|
|
|
6228
6267
|
* @description Start of the current failure streak.
|
|
6229
6268
|
*/
|
|
6230
6269
|
first_failure_at: string | null;
|
|
6231
|
-
/**
|
|
6270
|
+
/**
|
|
6271
|
+
* Format: uuid
|
|
6272
|
+
* @description The endpoint's id.
|
|
6273
|
+
*/
|
|
6232
6274
|
id: string;
|
|
6233
6275
|
/** @description True for endpoints carried over from the product's previous webhook system: they also receive the old signature header until its sunset date. */
|
|
6234
6276
|
legacy_signature: boolean;
|
|
@@ -6256,30 +6298,42 @@ interface components {
|
|
|
6256
6298
|
* @example x9Q=
|
|
6257
6299
|
*/
|
|
6258
6300
|
signing_secret_hint: string;
|
|
6301
|
+
/** @description `enabled` receives events. `disabled` was switched off. `auto_disabled` was switched off after 20 failed deliveries in a row or 24 hours of failures; `PATCH { enabled: true }` turns it back on. */
|
|
6302
|
+
status: components["schemas"]["WebhookEndpointStatus"];
|
|
6259
6303
|
/**
|
|
6260
|
-
*
|
|
6261
|
-
* @
|
|
6304
|
+
* Format: date-time
|
|
6305
|
+
* @description When the endpoint last changed.
|
|
6262
6306
|
*/
|
|
6263
|
-
status: "enabled" | "disabled" | "auto_disabled";
|
|
6264
|
-
/** Format: date-time */
|
|
6265
6307
|
updated_at: string;
|
|
6266
6308
|
/**
|
|
6267
6309
|
* Format: uri
|
|
6310
|
+
* @description Where events are sent.
|
|
6268
6311
|
* @example https://api.acme.com/webhooks
|
|
6269
6312
|
*/
|
|
6270
6313
|
url: string;
|
|
6271
6314
|
};
|
|
6315
|
+
/** @enum {string} */
|
|
6316
|
+
WebhookEndpointStatus: "enabled" | "disabled" | "auto_disabled";
|
|
6272
6317
|
WebhookEndpointWithSecretDto: {
|
|
6273
6318
|
/** @description Failed automatic deliveries in a row; a success resets it. */
|
|
6274
6319
|
consecutive_failures: number;
|
|
6275
|
-
/**
|
|
6320
|
+
/**
|
|
6321
|
+
* Format: date-time
|
|
6322
|
+
* @description When the endpoint was created.
|
|
6323
|
+
*/
|
|
6276
6324
|
created_at: string;
|
|
6277
|
-
/**
|
|
6325
|
+
/**
|
|
6326
|
+
* @description A label for people; null when unset.
|
|
6327
|
+
* @example Production receiver
|
|
6328
|
+
*/
|
|
6278
6329
|
description: string | null;
|
|
6279
|
-
/**
|
|
6330
|
+
/**
|
|
6331
|
+
* Format: date-time
|
|
6332
|
+
* @description When it was switched off; null while enabled.
|
|
6333
|
+
*/
|
|
6280
6334
|
disabled_at: string | null;
|
|
6281
|
-
/** @
|
|
6282
|
-
disabled_reason: "
|
|
6335
|
+
/** @description `manual`: switched off by a caller. `failing`: switched off automatically after failed deliveries. Null while enabled. */
|
|
6336
|
+
disabled_reason: components["schemas"]["WebhookEndpointDisabledReason"] | null;
|
|
6283
6337
|
/**
|
|
6284
6338
|
* Format: uuid
|
|
6285
6339
|
* @description Only events about this domain; null for every event of the workspace.
|
|
@@ -6304,7 +6358,10 @@ interface components {
|
|
|
6304
6358
|
* @description Start of the current failure streak.
|
|
6305
6359
|
*/
|
|
6306
6360
|
first_failure_at: string | null;
|
|
6307
|
-
/**
|
|
6361
|
+
/**
|
|
6362
|
+
* Format: uuid
|
|
6363
|
+
* @description The endpoint's id.
|
|
6364
|
+
*/
|
|
6308
6365
|
id: string;
|
|
6309
6366
|
/** @description True for endpoints carried over from the product's previous webhook system: they also receive the old signature header until its sunset date. */
|
|
6310
6367
|
legacy_signature: boolean;
|
|
@@ -6337,15 +6394,16 @@ interface components {
|
|
|
6337
6394
|
* @example x9Q=
|
|
6338
6395
|
*/
|
|
6339
6396
|
signing_secret_hint: string;
|
|
6397
|
+
/** @description `enabled` receives events. `disabled` was switched off. `auto_disabled` was switched off after 20 failed deliveries in a row or 24 hours of failures; `PATCH { enabled: true }` turns it back on. */
|
|
6398
|
+
status: components["schemas"]["WebhookEndpointStatus"];
|
|
6340
6399
|
/**
|
|
6341
|
-
*
|
|
6342
|
-
* @
|
|
6400
|
+
* Format: date-time
|
|
6401
|
+
* @description When the endpoint last changed.
|
|
6343
6402
|
*/
|
|
6344
|
-
status: "enabled" | "disabled" | "auto_disabled";
|
|
6345
|
-
/** Format: date-time */
|
|
6346
6403
|
updated_at: string;
|
|
6347
6404
|
/**
|
|
6348
6405
|
* Format: uri
|
|
6406
|
+
* @description Where events are sent.
|
|
6349
6407
|
* @example https://api.acme.com/webhooks
|
|
6350
6408
|
*/
|
|
6351
6409
|
url: string;
|
|
@@ -6353,15 +6411,22 @@ interface components {
|
|
|
6353
6411
|
WebhookEventDeliveryDto: {
|
|
6354
6412
|
/** @description Number of the latest attempt; retries and replays count up. */
|
|
6355
6413
|
attempt_number: number;
|
|
6356
|
-
/**
|
|
6414
|
+
/**
|
|
6415
|
+
* Format: date-time
|
|
6416
|
+
* @description When the latest attempt was made.
|
|
6417
|
+
*/
|
|
6357
6418
|
attempted_at: string;
|
|
6358
|
-
/**
|
|
6419
|
+
/**
|
|
6420
|
+
* Format: uuid
|
|
6421
|
+
* @description The endpoint.
|
|
6422
|
+
*/
|
|
6359
6423
|
endpoint_id: string;
|
|
6360
6424
|
/**
|
|
6361
6425
|
* Format: date-time
|
|
6362
6426
|
* @description When the next automatic attempt is due; null when none is queued.
|
|
6363
6427
|
*/
|
|
6364
6428
|
next_attempt_at: string | null;
|
|
6429
|
+
/** @description HTTP status of the latest attempt; null when no response came back. */
|
|
6365
6430
|
status_code: number | null;
|
|
6366
6431
|
/** @description True when the latest attempt got a 2xx. */
|
|
6367
6432
|
succeeded: boolean;
|
|
@@ -6369,7 +6434,10 @@ interface components {
|
|
|
6369
6434
|
WebhookEventDetailDto: {
|
|
6370
6435
|
/** @description Every attempt, newest first. */
|
|
6371
6436
|
attempts: components["schemas"]["WebhookDeliveryAttemptDto"][];
|
|
6372
|
-
/**
|
|
6437
|
+
/**
|
|
6438
|
+
* Format: date-time
|
|
6439
|
+
* @description When the event happened.
|
|
6440
|
+
*/
|
|
6373
6441
|
created_at: string;
|
|
6374
6442
|
/** @description Latest attempt per endpoint (an endpoint whose first attempt is still queued is not listed yet). */
|
|
6375
6443
|
deliveries: components["schemas"]["WebhookEventDeliveryDto"][];
|
|
@@ -6392,21 +6460,21 @@ interface components {
|
|
|
6392
6460
|
payload: {
|
|
6393
6461
|
[key: string]: unknown;
|
|
6394
6462
|
};
|
|
6395
|
-
/**
|
|
6396
|
-
|
|
6397
|
-
* @enum {string}
|
|
6398
|
-
*/
|
|
6399
|
-
status: "pending" | "delivered" | "failed" | "not_sent";
|
|
6463
|
+
/** @description `pending`: a delivery is queued. `failed`: the latest attempt to some endpoint failed and none is queued. `delivered`: every endpoint answered 2xx. `not_sent`: no endpoint subscribed. */
|
|
6464
|
+
status: components["schemas"]["WebhookEventStatus"];
|
|
6400
6465
|
/** @description Made by "Send test". */
|
|
6401
6466
|
test: boolean;
|
|
6402
6467
|
/**
|
|
6468
|
+
* @description The event type (one of this product's catalogue).
|
|
6403
6469
|
* @example email.sent
|
|
6404
|
-
* @enum {string}
|
|
6405
6470
|
*/
|
|
6406
|
-
type: "
|
|
6471
|
+
type: components["schemas"]["WebhookEventType"];
|
|
6407
6472
|
};
|
|
6408
6473
|
WebhookEventDto: {
|
|
6409
|
-
/**
|
|
6474
|
+
/**
|
|
6475
|
+
* Format: date-time
|
|
6476
|
+
* @description When the event happened.
|
|
6477
|
+
*/
|
|
6410
6478
|
created_at: string;
|
|
6411
6479
|
/** @description Latest attempt per endpoint (an endpoint whose first attempt is still queued is not listed yet). */
|
|
6412
6480
|
deliveries: components["schemas"]["WebhookEventDeliveryDto"][];
|
|
@@ -6429,26 +6497,30 @@ interface components {
|
|
|
6429
6497
|
payload: {
|
|
6430
6498
|
[key: string]: unknown;
|
|
6431
6499
|
};
|
|
6432
|
-
/**
|
|
6433
|
-
|
|
6434
|
-
* @enum {string}
|
|
6435
|
-
*/
|
|
6436
|
-
status: "pending" | "delivered" | "failed" | "not_sent";
|
|
6500
|
+
/** @description `pending`: a delivery is queued. `failed`: the latest attempt to some endpoint failed and none is queued. `delivered`: every endpoint answered 2xx. `not_sent`: no endpoint subscribed. */
|
|
6501
|
+
status: components["schemas"]["WebhookEventStatus"];
|
|
6437
6502
|
/** @description Made by "Send test". */
|
|
6438
6503
|
test: boolean;
|
|
6439
6504
|
/**
|
|
6505
|
+
* @description The event type (one of this product's catalogue).
|
|
6440
6506
|
* @example email.sent
|
|
6441
|
-
* @enum {string}
|
|
6442
6507
|
*/
|
|
6443
|
-
type: "
|
|
6508
|
+
type: components["schemas"]["WebhookEventType"];
|
|
6444
6509
|
};
|
|
6510
|
+
/** @enum {string} */
|
|
6511
|
+
WebhookEventStatus: "pending" | "delivered" | "failed" | "not_sent";
|
|
6512
|
+
/** @enum {string} */
|
|
6513
|
+
WebhookEventType: "email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted";
|
|
6445
6514
|
WebhookEventTypeDto: {
|
|
6446
6515
|
/**
|
|
6447
6516
|
* @description Group shown in the event picker.
|
|
6448
6517
|
* @example Users
|
|
6449
6518
|
*/
|
|
6450
6519
|
category: string;
|
|
6451
|
-
/**
|
|
6520
|
+
/**
|
|
6521
|
+
* @description When this event is sent.
|
|
6522
|
+
* @example A user signed up or was created by an admin.
|
|
6523
|
+
*/
|
|
6452
6524
|
description: string;
|
|
6453
6525
|
/** @description False for types that can be subscribed to but are not sent yet (scheduled sends, open and click tracking, inbound). */
|
|
6454
6526
|
emitted: boolean;
|
|
@@ -6462,10 +6534,10 @@ interface components {
|
|
|
6462
6534
|
*/
|
|
6463
6535
|
legacy_alias: string | null;
|
|
6464
6536
|
/**
|
|
6537
|
+
* @description The event type (one of this product's catalogue).
|
|
6465
6538
|
* @example email.sent
|
|
6466
|
-
* @enum {string}
|
|
6467
6539
|
*/
|
|
6468
|
-
type: "
|
|
6540
|
+
type: components["schemas"]["WebhookEventType"];
|
|
6469
6541
|
};
|
|
6470
6542
|
WebhookPaginationDto: {
|
|
6471
6543
|
/** @description Whether another page follows. */
|
|
@@ -6922,6 +6994,8 @@ interface operations {
|
|
|
6922
6994
|
responses: {
|
|
6923
6995
|
200: {
|
|
6924
6996
|
headers: {
|
|
6997
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
6998
|
+
"Idempotent-Replay"?: "true";
|
|
6925
6999
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
6926
7000
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
6927
7001
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -6975,9 +7049,11 @@ interface operations {
|
|
|
6975
7049
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
6976
7050
|
};
|
|
6977
7051
|
};
|
|
6978
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
7052
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
6979
7053
|
409: {
|
|
6980
7054
|
headers: {
|
|
7055
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
7056
|
+
"Retry-After"?: number;
|
|
6981
7057
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
6982
7058
|
[name: string]: unknown;
|
|
6983
7059
|
};
|
|
@@ -7181,6 +7257,8 @@ interface operations {
|
|
|
7181
7257
|
responses: {
|
|
7182
7258
|
200: {
|
|
7183
7259
|
headers: {
|
|
7260
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
7261
|
+
"Idempotent-Replay"?: "true";
|
|
7184
7262
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
7185
7263
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
7186
7264
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -7234,9 +7312,11 @@ interface operations {
|
|
|
7234
7312
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
7235
7313
|
};
|
|
7236
7314
|
};
|
|
7237
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
7315
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
7238
7316
|
409: {
|
|
7239
7317
|
headers: {
|
|
7318
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
7319
|
+
"Retry-After"?: number;
|
|
7240
7320
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
7241
7321
|
[name: string]: unknown;
|
|
7242
7322
|
};
|
|
@@ -7367,6 +7447,8 @@ interface operations {
|
|
|
7367
7447
|
responses: {
|
|
7368
7448
|
201: {
|
|
7369
7449
|
headers: {
|
|
7450
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
7451
|
+
"Idempotent-Replay"?: "true";
|
|
7370
7452
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
7371
7453
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
7372
7454
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -7420,9 +7502,11 @@ interface operations {
|
|
|
7420
7502
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
7421
7503
|
};
|
|
7422
7504
|
};
|
|
7423
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
7505
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
7424
7506
|
409: {
|
|
7425
7507
|
headers: {
|
|
7508
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
7509
|
+
"Retry-After"?: number;
|
|
7426
7510
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
7427
7511
|
[name: string]: unknown;
|
|
7428
7512
|
};
|
|
@@ -7743,6 +7827,8 @@ interface operations {
|
|
|
7743
7827
|
responses: {
|
|
7744
7828
|
200: {
|
|
7745
7829
|
headers: {
|
|
7830
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
7831
|
+
"Idempotent-Replay"?: "true";
|
|
7746
7832
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
7747
7833
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
7748
7834
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -7796,9 +7882,11 @@ interface operations {
|
|
|
7796
7882
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
7797
7883
|
};
|
|
7798
7884
|
};
|
|
7799
|
-
/** @description Not a draft any more (`BROADCAST_NOT_DRAFT`, `details.status`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
7885
|
+
/** @description Not a draft any more (`BROADCAST_NOT_DRAFT`, `details.status`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
7800
7886
|
409: {
|
|
7801
7887
|
headers: {
|
|
7888
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
7889
|
+
"Retry-After"?: number;
|
|
7802
7890
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
7803
7891
|
[name: string]: unknown;
|
|
7804
7892
|
};
|
|
@@ -7848,6 +7936,8 @@ interface operations {
|
|
|
7848
7936
|
responses: {
|
|
7849
7937
|
200: {
|
|
7850
7938
|
headers: {
|
|
7939
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
7940
|
+
"Idempotent-Replay"?: "true";
|
|
7851
7941
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
7852
7942
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
7853
7943
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -7901,9 +7991,11 @@ interface operations {
|
|
|
7901
7991
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
7902
7992
|
};
|
|
7903
7993
|
};
|
|
7904
|
-
/** @description Draft, sent or already canceled (`BROADCAST_NOT_CANCELABLE`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
7994
|
+
/** @description Draft, sent or already canceled (`BROADCAST_NOT_CANCELABLE`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
7905
7995
|
409: {
|
|
7906
7996
|
headers: {
|
|
7997
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
7998
|
+
"Retry-After"?: number;
|
|
7907
7999
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
7908
8000
|
[name: string]: unknown;
|
|
7909
8001
|
};
|
|
@@ -8025,6 +8117,8 @@ interface operations {
|
|
|
8025
8117
|
responses: {
|
|
8026
8118
|
201: {
|
|
8027
8119
|
headers: {
|
|
8120
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
8121
|
+
"Idempotent-Replay"?: "true";
|
|
8028
8122
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
8029
8123
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
8030
8124
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -8078,9 +8172,11 @@ interface operations {
|
|
|
8078
8172
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
8079
8173
|
};
|
|
8080
8174
|
};
|
|
8081
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
8175
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
8082
8176
|
409: {
|
|
8083
8177
|
headers: {
|
|
8178
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
8179
|
+
"Retry-After"?: number;
|
|
8084
8180
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
8085
8181
|
[name: string]: unknown;
|
|
8086
8182
|
};
|
|
@@ -8214,6 +8310,8 @@ interface operations {
|
|
|
8214
8310
|
/** @description `status` is `sending` or `scheduled`. */
|
|
8215
8311
|
202: {
|
|
8216
8312
|
headers: {
|
|
8313
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
8314
|
+
"Idempotent-Replay"?: "true";
|
|
8217
8315
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
8218
8316
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
8219
8317
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -8267,9 +8365,11 @@ interface operations {
|
|
|
8267
8365
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
8268
8366
|
};
|
|
8269
8367
|
};
|
|
8270
|
-
/** @description Not a draft (`BROADCAST_NOT_DRAFT`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
8368
|
+
/** @description Not a draft (`BROADCAST_NOT_DRAFT`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
8271
8369
|
409: {
|
|
8272
8370
|
headers: {
|
|
8371
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
8372
|
+
"Retry-After"?: number;
|
|
8273
8373
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
8274
8374
|
[name: string]: unknown;
|
|
8275
8375
|
};
|
|
@@ -8408,6 +8508,8 @@ interface operations {
|
|
|
8408
8508
|
responses: {
|
|
8409
8509
|
201: {
|
|
8410
8510
|
headers: {
|
|
8511
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
8512
|
+
"Idempotent-Replay"?: "true";
|
|
8411
8513
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
8412
8514
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
8413
8515
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -8461,9 +8563,11 @@ interface operations {
|
|
|
8461
8563
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
8462
8564
|
};
|
|
8463
8565
|
};
|
|
8464
|
-
/** @description The key exists (`CONTACT_PROPERTY_EXISTS`), the workspace has 50 properties (`CONTACT_PROPERTY_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
8566
|
+
/** @description The key exists (`CONTACT_PROPERTY_EXISTS`), the workspace has 50 properties (`CONTACT_PROPERTY_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
8465
8567
|
409: {
|
|
8466
8568
|
headers: {
|
|
8569
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
8570
|
+
"Retry-After"?: number;
|
|
8467
8571
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
8468
8572
|
[name: string]: unknown;
|
|
8469
8573
|
};
|
|
@@ -8680,6 +8784,8 @@ interface operations {
|
|
|
8680
8784
|
responses: {
|
|
8681
8785
|
200: {
|
|
8682
8786
|
headers: {
|
|
8787
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
8788
|
+
"Idempotent-Replay"?: "true";
|
|
8683
8789
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
8684
8790
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
8685
8791
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -8733,9 +8839,11 @@ interface operations {
|
|
|
8733
8839
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
8734
8840
|
};
|
|
8735
8841
|
};
|
|
8736
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
8842
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
8737
8843
|
409: {
|
|
8738
8844
|
headers: {
|
|
8845
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
8846
|
+
"Retry-After"?: number;
|
|
8739
8847
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
8740
8848
|
[name: string]: unknown;
|
|
8741
8849
|
};
|
|
@@ -8878,6 +8986,8 @@ interface operations {
|
|
|
8878
8986
|
responses: {
|
|
8879
8987
|
201: {
|
|
8880
8988
|
headers: {
|
|
8989
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
8990
|
+
"Idempotent-Replay"?: "true";
|
|
8881
8991
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
8882
8992
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
8883
8993
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -8931,9 +9041,11 @@ interface operations {
|
|
|
8931
9041
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
8932
9042
|
};
|
|
8933
9043
|
};
|
|
8934
|
-
/** @description A contact with this email exists (`CONTACT_EXISTS`), the workspace has 100,000 contacts (`CONTACT_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
9044
|
+
/** @description A contact with this email exists (`CONTACT_EXISTS`), the workspace has 100,000 contacts (`CONTACT_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
8935
9045
|
409: {
|
|
8936
9046
|
headers: {
|
|
9047
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
9048
|
+
"Retry-After"?: number;
|
|
8937
9049
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
8938
9050
|
[name: string]: unknown;
|
|
8939
9051
|
};
|
|
@@ -9073,6 +9185,8 @@ interface operations {
|
|
|
9073
9185
|
/** @description Queued. */
|
|
9074
9186
|
202: {
|
|
9075
9187
|
headers: {
|
|
9188
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
9189
|
+
"Idempotent-Replay"?: "true";
|
|
9076
9190
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
9077
9191
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
9078
9192
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -9126,9 +9240,11 @@ interface operations {
|
|
|
9126
9240
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9127
9241
|
};
|
|
9128
9242
|
};
|
|
9129
|
-
/** @description Two imports are already running (`IMPORT_IN_PROGRESS`), or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. */
|
|
9243
|
+
/** @description Two imports are already running (`IMPORT_IN_PROGRESS`), or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
9130
9244
|
409: {
|
|
9131
9245
|
headers: {
|
|
9246
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
9247
|
+
"Retry-After"?: number;
|
|
9132
9248
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
9133
9249
|
[name: string]: unknown;
|
|
9134
9250
|
};
|
|
@@ -9440,6 +9556,8 @@ interface operations {
|
|
|
9440
9556
|
responses: {
|
|
9441
9557
|
200: {
|
|
9442
9558
|
headers: {
|
|
9559
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
9560
|
+
"Idempotent-Replay"?: "true";
|
|
9443
9561
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
9444
9562
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
9445
9563
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -9493,9 +9611,11 @@ interface operations {
|
|
|
9493
9611
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9494
9612
|
};
|
|
9495
9613
|
};
|
|
9496
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
9614
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
9497
9615
|
409: {
|
|
9498
9616
|
headers: {
|
|
9617
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
9618
|
+
"Retry-After"?: number;
|
|
9499
9619
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
9500
9620
|
[name: string]: unknown;
|
|
9501
9621
|
};
|
|
@@ -9631,6 +9751,8 @@ interface operations {
|
|
|
9631
9751
|
/** @description Already a member; nothing changed. */
|
|
9632
9752
|
200: {
|
|
9633
9753
|
headers: {
|
|
9754
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
9755
|
+
"Idempotent-Replay"?: "true";
|
|
9634
9756
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
9635
9757
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
9636
9758
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -9647,6 +9769,8 @@ interface operations {
|
|
|
9647
9769
|
/** @description Added. */
|
|
9648
9770
|
201: {
|
|
9649
9771
|
headers: {
|
|
9772
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
9773
|
+
"Idempotent-Replay"?: "true";
|
|
9650
9774
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
9651
9775
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
9652
9776
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -9700,9 +9824,11 @@ interface operations {
|
|
|
9700
9824
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9701
9825
|
};
|
|
9702
9826
|
};
|
|
9703
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
9827
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
9704
9828
|
409: {
|
|
9705
9829
|
headers: {
|
|
9830
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
9831
|
+
"Retry-After"?: number;
|
|
9706
9832
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
9707
9833
|
[name: string]: unknown;
|
|
9708
9834
|
};
|
|
@@ -9933,6 +10059,8 @@ interface operations {
|
|
|
9933
10059
|
responses: {
|
|
9934
10060
|
200: {
|
|
9935
10061
|
headers: {
|
|
10062
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
10063
|
+
"Idempotent-Replay"?: "true";
|
|
9936
10064
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
9937
10065
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
9938
10066
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -9986,9 +10114,11 @@ interface operations {
|
|
|
9986
10114
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9987
10115
|
};
|
|
9988
10116
|
};
|
|
9989
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
10117
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
9990
10118
|
409: {
|
|
9991
10119
|
headers: {
|
|
10120
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
10121
|
+
"Retry-After"?: number;
|
|
9992
10122
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
9993
10123
|
[name: string]: unknown;
|
|
9994
10124
|
};
|
|
@@ -10205,6 +10335,8 @@ interface operations {
|
|
|
10205
10335
|
responses: {
|
|
10206
10336
|
201: {
|
|
10207
10337
|
headers: {
|
|
10338
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
10339
|
+
"Idempotent-Replay"?: "true";
|
|
10208
10340
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
10209
10341
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
10210
10342
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -10258,9 +10390,11 @@ interface operations {
|
|
|
10258
10390
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10259
10391
|
};
|
|
10260
10392
|
};
|
|
10261
|
-
/** @description Domain already registered (globally unique); `MAIL_FROM_HOST_IN_USE`: the `custom_return_path` host already has records that are not ours (listed in `details.found`); or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. */
|
|
10393
|
+
/** @description Domain already registered (globally unique); `MAIL_FROM_HOST_IN_USE`: the `custom_return_path` host already has records that are not ours (listed in `details.found`); or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
10262
10394
|
409: {
|
|
10263
10395
|
headers: {
|
|
10396
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
10397
|
+
"Retry-After"?: number;
|
|
10264
10398
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
10265
10399
|
[name: string]: unknown;
|
|
10266
10400
|
};
|
|
@@ -10582,6 +10716,8 @@ interface operations {
|
|
|
10582
10716
|
responses: {
|
|
10583
10717
|
200: {
|
|
10584
10718
|
headers: {
|
|
10719
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
10720
|
+
"Idempotent-Replay"?: "true";
|
|
10585
10721
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
10586
10722
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
10587
10723
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -10635,9 +10771,11 @@ interface operations {
|
|
|
10635
10771
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10636
10772
|
};
|
|
10637
10773
|
};
|
|
10638
|
-
/** @description `CAPABILITY_NOT_VERIFIED`: a verified domain cannot gain sending or receiving until the new records verify (`details.failing`, `details.records`); `DOMAIN_HAS_MAILBOXES`: receiving cannot be turned off while active mailboxes exist (`details.count`, `details.mailboxes[].id|address`); `MAIL_FROM_HOST_IN_USE`: the MAIL FROM host already has a CNAME, a foreign MX or a foreign SPF record (listed in `details.found`); or `IDEMPOTENCY_KEY_REUSE`. */
|
|
10774
|
+
/** @description `CAPABILITY_NOT_VERIFIED`: a verified domain cannot gain sending or receiving until the new records verify (`details.failing`, `details.records`); `DOMAIN_HAS_MAILBOXES`: receiving cannot be turned off while active mailboxes exist (`details.count`, `details.mailboxes[].id|address`); `MAIL_FROM_HOST_IN_USE`: the MAIL FROM host already has a CNAME, a foreign MX or a foreign SPF record (listed in `details.found`); or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
10639
10775
|
409: {
|
|
10640
10776
|
headers: {
|
|
10777
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
10778
|
+
"Retry-After"?: number;
|
|
10641
10779
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
10642
10780
|
[name: string]: unknown;
|
|
10643
10781
|
};
|
|
@@ -10778,6 +10916,8 @@ interface operations {
|
|
|
10778
10916
|
/** @description The plan (dry run), or the plan with each record's `result` and the post-apply DNS check. */
|
|
10779
10917
|
200: {
|
|
10780
10918
|
headers: {
|
|
10919
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
10920
|
+
"Idempotent-Replay"?: "true";
|
|
10781
10921
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
10782
10922
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
10783
10923
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -10831,9 +10971,11 @@ interface operations {
|
|
|
10831
10971
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10832
10972
|
};
|
|
10833
10973
|
};
|
|
10834
|
-
/** @description `DNS_CONFLICTS`: a blocking conflict (a second SPF record, a CNAME at the name, another DKIM key at our selector, other MX records at the MAIL FROM host or the domain, a merge over 10 SPF lookups). Nothing was written; the body carries the full `plan` and `conflicts`. Or `IDEMPOTENCY_KEY_REUSE`. */
|
|
10974
|
+
/** @description `DNS_CONFLICTS`: a blocking conflict (a second SPF record, a CNAME at the name, another DKIM key at our selector, other MX records at the MAIL FROM host or the domain, a merge over 10 SPF lookups). Nothing was written; the body carries the full `plan` and `conflicts`. Or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
10835
10975
|
409: {
|
|
10836
10976
|
headers: {
|
|
10977
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
10978
|
+
"Retry-After"?: number;
|
|
10837
10979
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
10838
10980
|
[name: string]: unknown;
|
|
10839
10981
|
};
|
|
@@ -11065,6 +11207,8 @@ interface operations {
|
|
|
11065
11207
|
/** @description The signed apply URL to open in the browser. */
|
|
11066
11208
|
200: {
|
|
11067
11209
|
headers: {
|
|
11210
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
11211
|
+
"Idempotent-Replay"?: "true";
|
|
11068
11212
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
11069
11213
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
11070
11214
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -11118,9 +11262,11 @@ interface operations {
|
|
|
11118
11262
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
11119
11263
|
};
|
|
11120
11264
|
};
|
|
11121
|
-
/** @description One-click setup is not possible for this domain; nothing was started. `DOMAIN_CONNECT_DISABLED`: ProductCraft has not switched Domain Connect on. `DOMAIN_CONNECT_UNAVAILABLE`: the DNS provider does not run Domain Connect or has not onboarded our template (`details.reason`: `no_record`, `settings_unreachable`, `template_not_onboarded` or `lookup_failed`; `details.provider_name`). `DOMAIN_CONNECT_NOT_SENDING`: a receive-only domain. `DOMAIN_CONNECT_MAIL_FROM_LABEL`: the MAIL FROM label is not `bounce` or MAIL FROM is off. `DKIM_KEY_MISSING`: no DKIM key to publish. Or `IDEMPOTENCY_KEY_REUSE`. */
|
|
11265
|
+
/** @description One-click setup is not possible for this domain; nothing was started. `DOMAIN_CONNECT_DISABLED`: ProductCraft has not switched Domain Connect on. `DOMAIN_CONNECT_UNAVAILABLE`: the DNS provider does not run Domain Connect or has not onboarded our template (`details.reason`: `no_record`, `settings_unreachable`, `template_not_onboarded` or `lookup_failed`; `details.provider_name`). `DOMAIN_CONNECT_NOT_SENDING`: a receive-only domain. `DOMAIN_CONNECT_MAIL_FROM_LABEL`: the MAIL FROM label is not `bounce` or MAIL FROM is off. `DKIM_KEY_MISSING`: no DKIM key to publish. Or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
11122
11266
|
409: {
|
|
11123
11267
|
headers: {
|
|
11268
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
11269
|
+
"Retry-After"?: number;
|
|
11124
11270
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
11125
11271
|
[name: string]: unknown;
|
|
11126
11272
|
};
|
|
@@ -11338,6 +11484,8 @@ interface operations {
|
|
|
11338
11484
|
responses: {
|
|
11339
11485
|
201: {
|
|
11340
11486
|
headers: {
|
|
11487
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
11488
|
+
"Idempotent-Replay"?: "true";
|
|
11341
11489
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
11342
11490
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
11343
11491
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -11391,9 +11539,11 @@ interface operations {
|
|
|
11391
11539
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
11392
11540
|
};
|
|
11393
11541
|
};
|
|
11394
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the key was used with a different body. */
|
|
11542
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the key was used with a different body. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
11395
11543
|
409: {
|
|
11396
11544
|
headers: {
|
|
11545
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
11546
|
+
"Retry-After"?: number;
|
|
11397
11547
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
11398
11548
|
[name: string]: unknown;
|
|
11399
11549
|
};
|
|
@@ -11612,6 +11762,8 @@ interface operations {
|
|
|
11612
11762
|
responses: {
|
|
11613
11763
|
200: {
|
|
11614
11764
|
headers: {
|
|
11765
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
11766
|
+
"Idempotent-Replay"?: "true";
|
|
11615
11767
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
11616
11768
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
11617
11769
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -11665,9 +11817,11 @@ interface operations {
|
|
|
11665
11817
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
11666
11818
|
};
|
|
11667
11819
|
};
|
|
11668
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
11820
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
11669
11821
|
409: {
|
|
11670
11822
|
headers: {
|
|
11823
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
11824
|
+
"Retry-After"?: number;
|
|
11671
11825
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
11672
11826
|
[name: string]: unknown;
|
|
11673
11827
|
};
|
|
@@ -11875,6 +12029,8 @@ interface operations {
|
|
|
11875
12029
|
/** @description Accepted; queued for delivery. */
|
|
11876
12030
|
202: {
|
|
11877
12031
|
headers: {
|
|
12032
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
12033
|
+
"Idempotent-Replay"?: "true";
|
|
11878
12034
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
11879
12035
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
11880
12036
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -11928,9 +12084,11 @@ interface operations {
|
|
|
11928
12084
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
11929
12085
|
};
|
|
11930
12086
|
};
|
|
11931
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. */
|
|
12087
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
11932
12088
|
409: {
|
|
11933
12089
|
headers: {
|
|
12090
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
12091
|
+
"Retry-After"?: number;
|
|
11934
12092
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
11935
12093
|
[name: string]: unknown;
|
|
11936
12094
|
};
|
|
@@ -12254,6 +12412,8 @@ interface operations {
|
|
|
12254
12412
|
responses: {
|
|
12255
12413
|
200: {
|
|
12256
12414
|
headers: {
|
|
12415
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
12416
|
+
"Idempotent-Replay"?: "true";
|
|
12257
12417
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
12258
12418
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
12259
12419
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -12307,9 +12467,11 @@ interface operations {
|
|
|
12307
12467
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
12308
12468
|
};
|
|
12309
12469
|
};
|
|
12310
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
12470
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
12311
12471
|
409: {
|
|
12312
12472
|
headers: {
|
|
12473
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
12474
|
+
"Retry-After"?: number;
|
|
12313
12475
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
12314
12476
|
[name: string]: unknown;
|
|
12315
12477
|
};
|
|
@@ -12517,6 +12679,8 @@ interface operations {
|
|
|
12517
12679
|
/** @description Saved. */
|
|
12518
12680
|
204: {
|
|
12519
12681
|
headers: {
|
|
12682
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
12683
|
+
"Idempotent-Replay"?: "true";
|
|
12520
12684
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
12521
12685
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
12522
12686
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -12568,9 +12732,11 @@ interface operations {
|
|
|
12568
12732
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
12569
12733
|
};
|
|
12570
12734
|
};
|
|
12571
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
12735
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
12572
12736
|
409: {
|
|
12573
12737
|
headers: {
|
|
12738
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
12739
|
+
"Retry-After"?: number;
|
|
12574
12740
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
12575
12741
|
[name: string]: unknown;
|
|
12576
12742
|
};
|
|
@@ -12609,6 +12775,8 @@ interface operations {
|
|
|
12609
12775
|
responses: {
|
|
12610
12776
|
202: {
|
|
12611
12777
|
headers: {
|
|
12778
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
12779
|
+
"Idempotent-Replay"?: "true";
|
|
12612
12780
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
12613
12781
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
12614
12782
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -12662,9 +12830,11 @@ interface operations {
|
|
|
12662
12830
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
12663
12831
|
};
|
|
12664
12832
|
};
|
|
12665
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
12833
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
12666
12834
|
409: {
|
|
12667
12835
|
headers: {
|
|
12836
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
12837
|
+
"Retry-After"?: number;
|
|
12668
12838
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
12669
12839
|
[name: string]: unknown;
|
|
12670
12840
|
};
|
|
@@ -12869,6 +13039,8 @@ interface operations {
|
|
|
12869
13039
|
/** @description Disconnected. */
|
|
12870
13040
|
204: {
|
|
12871
13041
|
headers: {
|
|
13042
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
13043
|
+
"Idempotent-Replay"?: "true";
|
|
12872
13044
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
12873
13045
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
12874
13046
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -12920,9 +13092,11 @@ interface operations {
|
|
|
12920
13092
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
12921
13093
|
};
|
|
12922
13094
|
};
|
|
12923
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
13095
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
12924
13096
|
409: {
|
|
12925
13097
|
headers: {
|
|
13098
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
13099
|
+
"Retry-After"?: number;
|
|
12926
13100
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
12927
13101
|
[name: string]: unknown;
|
|
12928
13102
|
};
|
|
@@ -13050,6 +13224,8 @@ interface operations {
|
|
|
13050
13224
|
responses: {
|
|
13051
13225
|
201: {
|
|
13052
13226
|
headers: {
|
|
13227
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
13228
|
+
"Idempotent-Replay"?: "true";
|
|
13053
13229
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
13054
13230
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
13055
13231
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -13103,9 +13279,11 @@ interface operations {
|
|
|
13103
13279
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
13104
13280
|
};
|
|
13105
13281
|
};
|
|
13106
|
-
/** @description Mailbox local-part already exists on this domain, or the domain is not yet verified, or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. */
|
|
13282
|
+
/** @description Mailbox local-part already exists on this domain, or the domain is not yet verified, or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
13107
13283
|
409: {
|
|
13108
13284
|
headers: {
|
|
13285
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
13286
|
+
"Retry-After"?: number;
|
|
13109
13287
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
13110
13288
|
[name: string]: unknown;
|
|
13111
13289
|
};
|
|
@@ -13322,6 +13500,8 @@ interface operations {
|
|
|
13322
13500
|
responses: {
|
|
13323
13501
|
200: {
|
|
13324
13502
|
headers: {
|
|
13503
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
13504
|
+
"Idempotent-Replay"?: "true";
|
|
13325
13505
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
13326
13506
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
13327
13507
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -13375,9 +13555,11 @@ interface operations {
|
|
|
13375
13555
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
13376
13556
|
};
|
|
13377
13557
|
};
|
|
13378
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
13558
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
13379
13559
|
409: {
|
|
13380
13560
|
headers: {
|
|
13561
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
13562
|
+
"Retry-After"?: number;
|
|
13381
13563
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
13382
13564
|
[name: string]: unknown;
|
|
13383
13565
|
};
|
|
@@ -14315,6 +14497,8 @@ interface operations {
|
|
|
14315
14497
|
responses: {
|
|
14316
14498
|
200: {
|
|
14317
14499
|
headers: {
|
|
14500
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
14501
|
+
"Idempotent-Replay"?: "true";
|
|
14318
14502
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
14319
14503
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
14320
14504
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -14368,9 +14552,11 @@ interface operations {
|
|
|
14368
14552
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
14369
14553
|
};
|
|
14370
14554
|
};
|
|
14371
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
14555
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
14372
14556
|
409: {
|
|
14373
14557
|
headers: {
|
|
14558
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
14559
|
+
"Retry-After"?: number;
|
|
14374
14560
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
14375
14561
|
[name: string]: unknown;
|
|
14376
14562
|
};
|
|
@@ -15367,6 +15553,8 @@ interface operations {
|
|
|
15367
15553
|
responses: {
|
|
15368
15554
|
201: {
|
|
15369
15555
|
headers: {
|
|
15556
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
15557
|
+
"Idempotent-Replay"?: "true";
|
|
15370
15558
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
15371
15559
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
15372
15560
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -15420,9 +15608,11 @@ interface operations {
|
|
|
15420
15608
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
15421
15609
|
};
|
|
15422
15610
|
};
|
|
15423
|
-
/** @description A segment with this name exists (`SEGMENT_EXISTS`), the workspace has 100 segments (`SEGMENT_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
15611
|
+
/** @description A segment with this name exists (`SEGMENT_EXISTS`), the workspace has 100 segments (`SEGMENT_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
15424
15612
|
409: {
|
|
15425
15613
|
headers: {
|
|
15614
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
15615
|
+
"Retry-After"?: number;
|
|
15426
15616
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
15427
15617
|
[name: string]: unknown;
|
|
15428
15618
|
};
|
|
@@ -15734,6 +15924,8 @@ interface operations {
|
|
|
15734
15924
|
responses: {
|
|
15735
15925
|
200: {
|
|
15736
15926
|
headers: {
|
|
15927
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
15928
|
+
"Idempotent-Replay"?: "true";
|
|
15737
15929
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
15738
15930
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
15739
15931
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -15787,9 +15979,11 @@ interface operations {
|
|
|
15787
15979
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
15788
15980
|
};
|
|
15789
15981
|
};
|
|
15790
|
-
/** @description Another segment has this name (`SEGMENT_EXISTS`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
15982
|
+
/** @description Another segment has this name (`SEGMENT_EXISTS`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
15791
15983
|
409: {
|
|
15792
15984
|
headers: {
|
|
15985
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
15986
|
+
"Retry-After"?: number;
|
|
15793
15987
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
15794
15988
|
[name: string]: unknown;
|
|
15795
15989
|
};
|
|
@@ -16270,6 +16464,8 @@ interface operations {
|
|
|
16270
16464
|
responses: {
|
|
16271
16465
|
200: {
|
|
16272
16466
|
headers: {
|
|
16467
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16468
|
+
"Idempotent-Replay"?: "true";
|
|
16273
16469
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
16274
16470
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
16275
16471
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -16323,9 +16519,11 @@ interface operations {
|
|
|
16323
16519
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16324
16520
|
};
|
|
16325
16521
|
};
|
|
16326
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
16522
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
16327
16523
|
409: {
|
|
16328
16524
|
headers: {
|
|
16525
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16526
|
+
"Retry-After"?: number;
|
|
16329
16527
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16330
16528
|
[name: string]: unknown;
|
|
16331
16529
|
};
|
|
@@ -16871,6 +17069,8 @@ interface operations {
|
|
|
16871
17069
|
responses: {
|
|
16872
17070
|
201: {
|
|
16873
17071
|
headers: {
|
|
17072
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
17073
|
+
"Idempotent-Replay"?: "true";
|
|
16874
17074
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
16875
17075
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
16876
17076
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -16924,9 +17124,11 @@ interface operations {
|
|
|
16924
17124
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16925
17125
|
};
|
|
16926
17126
|
};
|
|
16927
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
17127
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
16928
17128
|
409: {
|
|
16929
17129
|
headers: {
|
|
17130
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
17131
|
+
"Retry-After"?: number;
|
|
16930
17132
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16931
17133
|
[name: string]: unknown;
|
|
16932
17134
|
};
|
|
@@ -17153,6 +17355,8 @@ interface operations {
|
|
|
17153
17355
|
responses: {
|
|
17154
17356
|
201: {
|
|
17155
17357
|
headers: {
|
|
17358
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
17359
|
+
"Idempotent-Replay"?: "true";
|
|
17156
17360
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
17157
17361
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
17158
17362
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -17206,9 +17410,11 @@ interface operations {
|
|
|
17206
17410
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17207
17411
|
};
|
|
17208
17412
|
};
|
|
17209
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
17413
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
17210
17414
|
409: {
|
|
17211
17415
|
headers: {
|
|
17416
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
17417
|
+
"Retry-After"?: number;
|
|
17212
17418
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17213
17419
|
[name: string]: unknown;
|
|
17214
17420
|
};
|
|
@@ -17793,6 +17999,8 @@ interface operations {
|
|
|
17793
17999
|
/** @description Send accepted; queued for delivery. */
|
|
17794
18000
|
202: {
|
|
17795
18001
|
headers: {
|
|
18002
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18003
|
+
"Idempotent-Replay"?: "true";
|
|
17796
18004
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
17797
18005
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
17798
18006
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -17846,9 +18054,11 @@ interface operations {
|
|
|
17846
18054
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17847
18055
|
};
|
|
17848
18056
|
};
|
|
17849
|
-
/** @description IDEMPOTENCY_KEY_REUSE — same key, different body. */
|
|
18057
|
+
/** @description IDEMPOTENCY_KEY_REUSE — same key, different body. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
17850
18058
|
409: {
|
|
17851
18059
|
headers: {
|
|
18060
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18061
|
+
"Retry-After"?: number;
|
|
17852
18062
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17853
18063
|
[name: string]: unknown;
|
|
17854
18064
|
};
|
|
@@ -17909,6 +18119,8 @@ interface operations {
|
|
|
17909
18119
|
responses: {
|
|
17910
18120
|
200: {
|
|
17911
18121
|
headers: {
|
|
18122
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18123
|
+
"Idempotent-Replay"?: "true";
|
|
17912
18124
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
17913
18125
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
17914
18126
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -17962,9 +18174,11 @@ interface operations {
|
|
|
17962
18174
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17963
18175
|
};
|
|
17964
18176
|
};
|
|
17965
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
18177
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
17966
18178
|
409: {
|
|
17967
18179
|
headers: {
|
|
18180
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18181
|
+
"Retry-After"?: number;
|
|
17968
18182
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17969
18183
|
[name: string]: unknown;
|
|
17970
18184
|
};
|
|
@@ -18018,6 +18232,8 @@ interface operations {
|
|
|
18018
18232
|
responses: {
|
|
18019
18233
|
202: {
|
|
18020
18234
|
headers: {
|
|
18235
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18236
|
+
"Idempotent-Replay"?: "true";
|
|
18021
18237
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
18022
18238
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
18023
18239
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -18071,9 +18287,11 @@ interface operations {
|
|
|
18071
18287
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18072
18288
|
};
|
|
18073
18289
|
};
|
|
18074
|
-
/** @description Cannot test-send a layout/partial, or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. */
|
|
18290
|
+
/** @description Cannot test-send a layout/partial, or `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different body or route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
18075
18291
|
409: {
|
|
18076
18292
|
headers: {
|
|
18293
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18294
|
+
"Retry-After"?: number;
|
|
18077
18295
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18078
18296
|
[name: string]: unknown;
|
|
18079
18297
|
};
|
|
@@ -18301,6 +18519,8 @@ interface operations {
|
|
|
18301
18519
|
responses: {
|
|
18302
18520
|
201: {
|
|
18303
18521
|
headers: {
|
|
18522
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18523
|
+
"Idempotent-Replay"?: "true";
|
|
18304
18524
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
18305
18525
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
18306
18526
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -18354,9 +18574,11 @@ interface operations {
|
|
|
18354
18574
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18355
18575
|
};
|
|
18356
18576
|
};
|
|
18357
|
-
/** @description A topic with this name exists (`TOPIC_EXISTS`), the workspace has 50 topics (`TOPIC_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
18577
|
+
/** @description A topic with this name exists (`TOPIC_EXISTS`), the workspace has 50 topics (`TOPIC_LIMIT`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
18358
18578
|
409: {
|
|
18359
18579
|
headers: {
|
|
18580
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18581
|
+
"Retry-After"?: number;
|
|
18360
18582
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18361
18583
|
[name: string]: unknown;
|
|
18362
18584
|
};
|
|
@@ -18563,6 +18785,8 @@ interface operations {
|
|
|
18563
18785
|
responses: {
|
|
18564
18786
|
200: {
|
|
18565
18787
|
headers: {
|
|
18788
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18789
|
+
"Idempotent-Replay"?: "true";
|
|
18566
18790
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
18567
18791
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
18568
18792
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -18616,9 +18840,11 @@ interface operations {
|
|
|
18616
18840
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18617
18841
|
};
|
|
18618
18842
|
};
|
|
18619
|
-
/** @description Another topic has this name (`TOPIC_EXISTS`), or `IDEMPOTENCY_KEY_REUSE`. */
|
|
18843
|
+
/** @description Another topic has this name (`TOPIC_EXISTS`), or `IDEMPOTENCY_KEY_REUSE`. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
18620
18844
|
409: {
|
|
18621
18845
|
headers: {
|
|
18846
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18847
|
+
"Retry-After"?: number;
|
|
18622
18848
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18623
18849
|
[name: string]: unknown;
|
|
18624
18850
|
};
|
|
@@ -18914,6 +19140,8 @@ interface operations {
|
|
|
18914
19140
|
responses: {
|
|
18915
19141
|
200: {
|
|
18916
19142
|
headers: {
|
|
19143
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19144
|
+
"Idempotent-Replay"?: "true";
|
|
18917
19145
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
18918
19146
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
18919
19147
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -18967,9 +19195,11 @@ interface operations {
|
|
|
18967
19195
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18968
19196
|
};
|
|
18969
19197
|
};
|
|
18970
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
19198
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
18971
19199
|
409: {
|
|
18972
19200
|
headers: {
|
|
19201
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19202
|
+
"Retry-After"?: number;
|
|
18973
19203
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18974
19204
|
[name: string]: unknown;
|
|
18975
19205
|
};
|
|
@@ -19098,6 +19328,8 @@ interface operations {
|
|
|
19098
19328
|
responses: {
|
|
19099
19329
|
200: {
|
|
19100
19330
|
headers: {
|
|
19331
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19332
|
+
"Idempotent-Replay"?: "true";
|
|
19101
19333
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
19102
19334
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
19103
19335
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -19151,9 +19383,11 @@ interface operations {
|
|
|
19151
19383
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19152
19384
|
};
|
|
19153
19385
|
};
|
|
19154
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
19386
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
19155
19387
|
409: {
|
|
19156
19388
|
headers: {
|
|
19389
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19390
|
+
"Retry-After"?: number;
|
|
19157
19391
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19158
19392
|
[name: string]: unknown;
|
|
19159
19393
|
};
|
|
@@ -19280,6 +19514,8 @@ interface operations {
|
|
|
19280
19514
|
responses: {
|
|
19281
19515
|
200: {
|
|
19282
19516
|
headers: {
|
|
19517
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19518
|
+
"Idempotent-Replay"?: "true";
|
|
19283
19519
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
19284
19520
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
19285
19521
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -19333,9 +19569,11 @@ interface operations {
|
|
|
19333
19569
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19334
19570
|
};
|
|
19335
19571
|
};
|
|
19336
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
19572
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
19337
19573
|
409: {
|
|
19338
19574
|
headers: {
|
|
19575
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19576
|
+
"Retry-After"?: number;
|
|
19339
19577
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19340
19578
|
[name: string]: unknown;
|
|
19341
19579
|
};
|
|
@@ -19466,6 +19704,8 @@ interface operations {
|
|
|
19466
19704
|
responses: {
|
|
19467
19705
|
200: {
|
|
19468
19706
|
headers: {
|
|
19707
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19708
|
+
"Idempotent-Replay"?: "true";
|
|
19469
19709
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
19470
19710
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
19471
19711
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -19519,9 +19759,11 @@ interface operations {
|
|
|
19519
19759
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19520
19760
|
};
|
|
19521
19761
|
};
|
|
19522
|
-
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. */
|
|
19762
|
+
/** @description `IDEMPOTENCY_KEY_REUSE`: the `Idempotency-Key` was already used with a different request body or on a different route. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
19523
19763
|
409: {
|
|
19524
19764
|
headers: {
|
|
19765
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19766
|
+
"Retry-After"?: number;
|
|
19525
19767
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19526
19768
|
[name: string]: unknown;
|
|
19527
19769
|
};
|
|
@@ -19645,6 +19887,8 @@ interface operations {
|
|
|
19645
19887
|
responses: {
|
|
19646
19888
|
201: {
|
|
19647
19889
|
headers: {
|
|
19890
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19891
|
+
"Idempotent-Replay"?: "true";
|
|
19648
19892
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
19649
19893
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
19650
19894
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -19698,9 +19942,11 @@ interface operations {
|
|
|
19698
19942
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19699
19943
|
};
|
|
19700
19944
|
};
|
|
19701
|
-
/** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
19945
|
+
/** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
19702
19946
|
409: {
|
|
19703
19947
|
headers: {
|
|
19948
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19949
|
+
"Retry-After"?: number;
|
|
19704
19950
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19705
19951
|
[name: string]: unknown;
|
|
19706
19952
|
};
|
|
@@ -19917,6 +20163,8 @@ interface operations {
|
|
|
19917
20163
|
responses: {
|
|
19918
20164
|
200: {
|
|
19919
20165
|
headers: {
|
|
20166
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
20167
|
+
"Idempotent-Replay"?: "true";
|
|
19920
20168
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
19921
20169
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
19922
20170
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -19970,9 +20218,11 @@ interface operations {
|
|
|
19970
20218
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19971
20219
|
};
|
|
19972
20220
|
};
|
|
19973
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
20221
|
+
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
19974
20222
|
409: {
|
|
19975
20223
|
headers: {
|
|
20224
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
20225
|
+
"Retry-After"?: number;
|
|
19976
20226
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19977
20227
|
[name: string]: unknown;
|
|
19978
20228
|
};
|
|
@@ -20026,6 +20276,8 @@ interface operations {
|
|
|
20026
20276
|
responses: {
|
|
20027
20277
|
200: {
|
|
20028
20278
|
headers: {
|
|
20279
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
20280
|
+
"Idempotent-Replay"?: "true";
|
|
20029
20281
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
20030
20282
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
20031
20283
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -20079,9 +20331,11 @@ interface operations {
|
|
|
20079
20331
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
20080
20332
|
};
|
|
20081
20333
|
};
|
|
20082
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
20334
|
+
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
20083
20335
|
409: {
|
|
20084
20336
|
headers: {
|
|
20337
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
20338
|
+
"Retry-After"?: number;
|
|
20085
20339
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
20086
20340
|
[name: string]: unknown;
|
|
20087
20341
|
};
|
|
@@ -20126,6 +20380,8 @@ interface operations {
|
|
|
20126
20380
|
/** @description The attempt, successful or not. */
|
|
20127
20381
|
200: {
|
|
20128
20382
|
headers: {
|
|
20383
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
20384
|
+
"Idempotent-Replay"?: "true";
|
|
20129
20385
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
20130
20386
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
20131
20387
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -20179,9 +20435,11 @@ interface operations {
|
|
|
20179
20435
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
20180
20436
|
};
|
|
20181
20437
|
};
|
|
20182
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
20438
|
+
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
20183
20439
|
409: {
|
|
20184
20440
|
headers: {
|
|
20441
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
20442
|
+
"Retry-After"?: number;
|
|
20185
20443
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
20186
20444
|
[name: string]: unknown;
|
|
20187
20445
|
};
|
|
@@ -20292,11 +20550,13 @@ interface operations {
|
|
|
20292
20550
|
type?: ("email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.complained" | "email.failed" | "email.suppressed" | "email.skipped" | "email.scheduled" | "email.canceled" | "email.opened" | "email.clicked" | "email.received" | "domain.created" | "domain.updated" | "domain.verified" | "domain.deleted" | "suppression.added" | "suppression.removed" | "sending_defaults.updated" | "contact.created" | "contact.updated" | "contact.deleted")[];
|
|
20293
20551
|
/** @description Only events sent (or queued) to this endpoint. */
|
|
20294
20552
|
endpoint_id?: string;
|
|
20295
|
-
|
|
20553
|
+
/** @description Only events in this delivery status. */
|
|
20554
|
+
status?: components["schemas"]["WebhookEventStatus"];
|
|
20296
20555
|
/** @description Only events created at or after this instant. */
|
|
20297
20556
|
created_after?: string;
|
|
20298
20557
|
/** @description Only events created before this instant. */
|
|
20299
20558
|
created_before?: string;
|
|
20559
|
+
/** @description Page size. */
|
|
20300
20560
|
limit?: number;
|
|
20301
20561
|
/** @description The previous page's `pagination.next_cursor`. */
|
|
20302
20562
|
cursor?: string;
|
|
@@ -20487,6 +20747,8 @@ interface operations {
|
|
|
20487
20747
|
responses: {
|
|
20488
20748
|
200: {
|
|
20489
20749
|
headers: {
|
|
20750
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
20751
|
+
"Idempotent-Replay"?: "true";
|
|
20490
20752
|
"X-RateLimit-Limit-long": components["headers"]["X-RateLimit-Limit-long"];
|
|
20491
20753
|
"X-RateLimit-Limit-short": components["headers"]["X-RateLimit-Limit-short"];
|
|
20492
20754
|
"X-RateLimit-Remaining-long": components["headers"]["X-RateLimit-Remaining-long"];
|
|
@@ -20540,9 +20802,11 @@ interface operations {
|
|
|
20540
20802
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
20541
20803
|
};
|
|
20542
20804
|
};
|
|
20543
|
-
/** @description `endpoint_id` is switched off or does not receive this event type (`WEBHOOK_ENDPOINT_NOT_SUBSCRIBED`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
20805
|
+
/** @description `endpoint_id` is switched off or does not receive this event type (`WEBHOOK_ENDPOINT_NOT_SUBSCRIBED`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
|
|
20544
20806
|
409: {
|
|
20545
20807
|
headers: {
|
|
20808
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
20809
|
+
"Retry-After"?: number;
|
|
20546
20810
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
20547
20811
|
[name: string]: unknown;
|
|
20548
20812
|
};
|