@productcraft/social 1.0.1 → 1.0.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/README.md +10 -10
- package/dist/index.d.cts +357 -91
- package/dist/index.d.ts +357 -91
- package/package.json +3 -3
package/dist/index.d.cts
CHANGED
|
@@ -2171,7 +2171,10 @@ interface paths {
|
|
|
2171
2171
|
path?: never;
|
|
2172
2172
|
cookie?: never;
|
|
2173
2173
|
};
|
|
2174
|
-
/**
|
|
2174
|
+
/**
|
|
2175
|
+
* Get one webhook endpoint (without its secret).
|
|
2176
|
+
* @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
|
|
2177
|
+
*/
|
|
2175
2178
|
get: operations["WebhooksController_social_community_getEndpoint"];
|
|
2176
2179
|
put?: never;
|
|
2177
2180
|
post?: never;
|
|
@@ -2276,7 +2279,10 @@ interface paths {
|
|
|
2276
2279
|
path?: never;
|
|
2277
2280
|
cookie?: never;
|
|
2278
2281
|
};
|
|
2279
|
-
/**
|
|
2282
|
+
/**
|
|
2283
|
+
* Get one webhook event with every delivery attempt.
|
|
2284
|
+
* @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
|
|
2285
|
+
*/
|
|
2280
2286
|
get: operations["WebhooksController_social_community_getEvent"];
|
|
2281
2287
|
put?: never;
|
|
2282
2288
|
post?: never;
|
|
@@ -2733,7 +2739,10 @@ interface paths {
|
|
|
2733
2739
|
path?: never;
|
|
2734
2740
|
cookie?: never;
|
|
2735
2741
|
};
|
|
2736
|
-
/**
|
|
2742
|
+
/**
|
|
2743
|
+
* Get one webhook endpoint (without its secret).
|
|
2744
|
+
* @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
|
|
2745
|
+
*/
|
|
2737
2746
|
get: operations["WebhooksController_social_workspace_community_getEndpoint"];
|
|
2738
2747
|
put?: never;
|
|
2739
2748
|
post?: never;
|
|
@@ -2838,7 +2847,10 @@ interface paths {
|
|
|
2838
2847
|
path?: never;
|
|
2839
2848
|
cookie?: never;
|
|
2840
2849
|
};
|
|
2841
|
-
/**
|
|
2850
|
+
/**
|
|
2851
|
+
* Get one webhook event with every delivery attempt.
|
|
2852
|
+
* @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
|
|
2853
|
+
*/
|
|
2842
2854
|
get: operations["WebhooksController_social_workspace_community_getEvent"];
|
|
2843
2855
|
put?: never;
|
|
2844
2856
|
post?: never;
|
|
@@ -2923,7 +2935,10 @@ interface paths {
|
|
|
2923
2935
|
path?: never;
|
|
2924
2936
|
cookie?: never;
|
|
2925
2937
|
};
|
|
2926
|
-
/**
|
|
2938
|
+
/**
|
|
2939
|
+
* Get one webhook endpoint (without its secret).
|
|
2940
|
+
* @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
|
|
2941
|
+
*/
|
|
2927
2942
|
get: operations["WebhooksController_social_workspace_getEndpoint"];
|
|
2928
2943
|
put?: never;
|
|
2929
2944
|
post?: never;
|
|
@@ -3028,7 +3043,10 @@ interface paths {
|
|
|
3028
3043
|
path?: never;
|
|
3029
3044
|
cookie?: never;
|
|
3030
3045
|
};
|
|
3031
|
-
/**
|
|
3046
|
+
/**
|
|
3047
|
+
* Get one webhook event with every delivery attempt.
|
|
3048
|
+
* @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
|
|
3049
|
+
*/
|
|
3032
3050
|
get: operations["WebhooksController_social_workspace_getEvent"];
|
|
3033
3051
|
put?: never;
|
|
3034
3052
|
post?: never;
|
|
@@ -4704,11 +4722,15 @@ interface components {
|
|
|
4704
4722
|
url: string;
|
|
4705
4723
|
};
|
|
4706
4724
|
CreateWebhookEndpointDto: {
|
|
4707
|
-
/**
|
|
4725
|
+
/**
|
|
4726
|
+
* @description A label for people.
|
|
4727
|
+
* @example Production receiver
|
|
4728
|
+
*/
|
|
4708
4729
|
description?: string | null;
|
|
4709
4730
|
/**
|
|
4710
|
-
* @description
|
|
4731
|
+
* @description Send `false` to create it switched off.
|
|
4711
4732
|
* @default true
|
|
4733
|
+
* @example true
|
|
4712
4734
|
*/
|
|
4713
4735
|
enabled: boolean;
|
|
4714
4736
|
/**
|
|
@@ -5552,15 +5574,19 @@ interface components {
|
|
|
5552
5574
|
};
|
|
5553
5575
|
LeaveConversationDto: Record<string, never>;
|
|
5554
5576
|
ListWebhookEndpointsResponseDto: {
|
|
5577
|
+
/** @description The endpoints, newest first. */
|
|
5555
5578
|
data: components["schemas"]["WebhookEndpointDto"][];
|
|
5556
5579
|
/** @description Always one page (an endpoint limit applies). */
|
|
5557
5580
|
pagination: components["schemas"]["WebhookPaginationDto"];
|
|
5558
5581
|
};
|
|
5559
5582
|
ListWebhookEventTypesResponseDto: {
|
|
5583
|
+
/** @description Every event type this product sends. */
|
|
5560
5584
|
data: components["schemas"]["WebhookEventTypeDto"][];
|
|
5561
5585
|
};
|
|
5562
5586
|
ListWebhookEventsResponseDto: {
|
|
5587
|
+
/** @description The events, newest first. */
|
|
5563
5588
|
data: components["schemas"]["WebhookEventDto"][];
|
|
5589
|
+
/** @description The cursor for the next page. */
|
|
5564
5590
|
pagination: components["schemas"]["WebhookPaginationDto"];
|
|
5565
5591
|
};
|
|
5566
5592
|
MarkAllReadDto: {
|
|
@@ -6585,6 +6611,7 @@ interface components {
|
|
|
6585
6611
|
ReplayWebhookEventResponseDto: {
|
|
6586
6612
|
/** @description One attempt per endpoint it was sent to. */
|
|
6587
6613
|
attempts: components["schemas"]["WebhookDeliveryAttemptDto"][];
|
|
6614
|
+
/** @description The replayed event (the same id as the original). */
|
|
6588
6615
|
event_id: string;
|
|
6589
6616
|
};
|
|
6590
6617
|
RepostListResponseDto: {
|
|
@@ -6596,6 +6623,7 @@ interface components {
|
|
|
6596
6623
|
/**
|
|
6597
6624
|
* @description Hours the previous secret keeps signing too (0 ends it now).
|
|
6598
6625
|
* @default 24
|
|
6626
|
+
* @example 24
|
|
6599
6627
|
*/
|
|
6600
6628
|
grace_hours: number;
|
|
6601
6629
|
};
|
|
@@ -6630,7 +6658,7 @@ interface components {
|
|
|
6630
6658
|
event_type: "post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed";
|
|
6631
6659
|
};
|
|
6632
6660
|
/** @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>. */
|
|
6633
|
-
SocialErrorCode: ("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" | "ASSET_INVALID_CONTAINER" | "ASSET_INVALID_SIZE" | "ASSET_INVALID_TYPE" | "ASSET_MAGIC_MISMATCH" | "ASSET_NOT_OWNED" | "ASSET_NOT_READY" | "ASSET_NOT_VIDEO" | "ASSET_PROCESSING_FAILED" | "ASSET_TOO_LARGE" | "ASSET_TRANSCODE_FAILED" | "ASSET_UPLOAD_INCOMPLETE" | "CANNOT_QUOTE_PRIVATE" | "CANNOT_QUOTE_SELF" | "CANNOT_REPOST_PRIVATE" | "CANNOT_REPOST_SELF" | "COMMENTS_DISABLED" | "COMMENTS_FOLLOWERS_ONLY" | "COMMENTS_MENTIONED_ONLY" | "EDIT_WINDOW_EXPIRED" | "INVALID_CURSOR" | "INVALID_DATE_FILTER" | "INVALID_EXPAND" | "INVALID_IDENTIFIER" | "INVALID_ID_LIST" | "INVALID_NOTIFICATION_KIND" | "INVALID_ORDER" | "INVALID_SEARCH_QUERY" | "PIN_CAP_REACHED" | "POLL_CLOSED" | "QUOTE_NOT_ALLOWED" | "QUOTE_REQUIRES_BODY" | "QUOTE_REQUIRES_SOURCE" | "REPOST_NOT_ALLOWED" | "SOURCE_POST_ID_REQUIRES_QUOTE" | "TOO_MANY_ACTIVE_UPLOADS" | "TOO_MANY_ATTACHMENTS" | "TOO_MANY_IDS") | string;
|
|
6661
|
+
SocialErrorCode: ("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" | "ASSET_INVALID_CONTAINER" | "ASSET_INVALID_SIZE" | "ASSET_INVALID_TYPE" | "ASSET_MAGIC_MISMATCH" | "ASSET_NOT_OWNED" | "ASSET_NOT_READY" | "ASSET_NOT_VIDEO" | "ASSET_PROCESSING_FAILED" | "ASSET_TOO_LARGE" | "ASSET_TRANSCODE_FAILED" | "ASSET_UPLOAD_INCOMPLETE" | "CANNOT_QUOTE_PRIVATE" | "CANNOT_QUOTE_SELF" | "CANNOT_REPOST_PRIVATE" | "CANNOT_REPOST_SELF" | "COMMENTS_DISABLED" | "COMMENTS_FOLLOWERS_ONLY" | "COMMENTS_MENTIONED_ONLY" | "EDIT_WINDOW_EXPIRED" | "INVALID_CURSOR" | "INVALID_DATE_FILTER" | "INVALID_EXPAND" | "INVALID_IDENTIFIER" | "INVALID_ID_LIST" | "INVALID_NOTIFICATION_KIND" | "INVALID_ORDER" | "INVALID_SEARCH_QUERY" | "PIN_CAP_REACHED" | "POLL_CLOSED" | "QUOTE_NOT_ALLOWED" | "QUOTE_REQUIRES_BODY" | "QUOTE_REQUIRES_SOURCE" | "REPOST_NOT_ALLOWED" | "SOURCE_POST_ID_REQUIRES_QUOTE" | "TOO_MANY_ACTIVE_UPLOADS" | "TOO_MANY_ATTACHMENTS" | "TOO_MANY_IDS") | string;
|
|
6634
6662
|
SocialStatsInWindowDto: {
|
|
6635
6663
|
/**
|
|
6636
6664
|
* @description Distinct members (actors) who published a post, published a comment or reacted in the window. A member active on several days counts once; actors belong to one community, so a person active in two communities counts in each.
|
|
@@ -7001,13 +7029,27 @@ interface components {
|
|
|
7001
7029
|
url?: string;
|
|
7002
7030
|
};
|
|
7003
7031
|
UpdateWebhookEndpointDto: {
|
|
7032
|
+
/**
|
|
7033
|
+
* @description A new label; null clears it.
|
|
7034
|
+
* @example Production receiver
|
|
7035
|
+
*/
|
|
7004
7036
|
description?: string | null;
|
|
7005
|
-
/**
|
|
7037
|
+
/**
|
|
7038
|
+
* @description Switch it on or off. Switching on also clears an automatic disable.
|
|
7039
|
+
* @example true
|
|
7040
|
+
*/
|
|
7006
7041
|
enabled?: boolean;
|
|
7007
|
-
/**
|
|
7042
|
+
/**
|
|
7043
|
+
* @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later.
|
|
7044
|
+
* @example [
|
|
7045
|
+
* "post.created",
|
|
7046
|
+
* "post.updated"
|
|
7047
|
+
* ]
|
|
7048
|
+
*/
|
|
7008
7049
|
event_types?: ("post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed")[];
|
|
7009
7050
|
/**
|
|
7010
7051
|
* Format: uri
|
|
7052
|
+
* @description A new absolute https:// URL on a public host.
|
|
7011
7053
|
* @example https://api.acme.com/webhooks
|
|
7012
7054
|
*/
|
|
7013
7055
|
url?: string;
|
|
@@ -7055,21 +7097,42 @@ interface components {
|
|
|
7055
7097
|
*/
|
|
7056
7098
|
created: boolean;
|
|
7057
7099
|
};
|
|
7100
|
+
/** @enum {string} */
|
|
7101
|
+
WebhookAttemptTrigger: "automatic" | "replay" | "test";
|
|
7058
7102
|
WebhookDeliveryAttemptDto: {
|
|
7059
7103
|
/** @description 1 for the first delivery; retries and replays count up. */
|
|
7060
7104
|
attempt_number: number;
|
|
7061
|
-
/**
|
|
7105
|
+
/**
|
|
7106
|
+
* Format: date-time
|
|
7107
|
+
* @description When the attempt was made.
|
|
7108
|
+
*/
|
|
7062
7109
|
attempted_at: string;
|
|
7063
|
-
/**
|
|
7110
|
+
/**
|
|
7111
|
+
* Format: uuid
|
|
7112
|
+
* @description The endpoint it was delivered to.
|
|
7113
|
+
*/
|
|
7064
7114
|
endpoint_id: string;
|
|
7065
|
-
/**
|
|
7115
|
+
/**
|
|
7116
|
+
* @description Why the attempt failed when no 2xx came back; null on success.
|
|
7117
|
+
* @example request timed out
|
|
7118
|
+
*/
|
|
7066
7119
|
error_message: string | null;
|
|
7067
|
-
/**
|
|
7120
|
+
/**
|
|
7121
|
+
* @description The event that was delivered.
|
|
7122
|
+
* @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f
|
|
7123
|
+
*/
|
|
7068
7124
|
event_id: string;
|
|
7069
|
-
/**
|
|
7125
|
+
/**
|
|
7126
|
+
* @description The event's type.
|
|
7127
|
+
* @example user.created
|
|
7128
|
+
*/
|
|
7070
7129
|
event_type: string;
|
|
7071
|
-
/**
|
|
7130
|
+
/**
|
|
7131
|
+
* Format: uuid
|
|
7132
|
+
* @description The attempt's id.
|
|
7133
|
+
*/
|
|
7072
7134
|
id: string;
|
|
7135
|
+
/** @description Milliseconds until the response; null when none came back. */
|
|
7073
7136
|
latency_ms: number | null;
|
|
7074
7137
|
/** @description The first 1 KiB of the response body. */
|
|
7075
7138
|
response_body: string | null;
|
|
@@ -7077,28 +7140,36 @@ interface components {
|
|
|
7077
7140
|
status_code: number | null;
|
|
7078
7141
|
/** @description True for a 2xx response. */
|
|
7079
7142
|
succeeded: boolean;
|
|
7080
|
-
/**
|
|
7081
|
-
|
|
7082
|
-
* @enum {string}
|
|
7083
|
-
*/
|
|
7084
|
-
trigger: "automatic" | "replay" | "test";
|
|
7143
|
+
/** @description `automatic` (first delivery or a retry), `replay` or `test`. */
|
|
7144
|
+
trigger: components["schemas"]["WebhookAttemptTrigger"];
|
|
7085
7145
|
/**
|
|
7086
7146
|
* Format: uri
|
|
7087
7147
|
* @description Where it was sent.
|
|
7088
7148
|
*/
|
|
7089
7149
|
url: string;
|
|
7090
7150
|
};
|
|
7151
|
+
/** @enum {string} */
|
|
7152
|
+
WebhookEndpointDisabledReason: "manual" | "failing";
|
|
7091
7153
|
WebhookEndpointDto: {
|
|
7092
7154
|
/** @description Failed automatic deliveries in a row; a success resets it. */
|
|
7093
7155
|
consecutive_failures: number;
|
|
7094
|
-
/**
|
|
7156
|
+
/**
|
|
7157
|
+
* Format: date-time
|
|
7158
|
+
* @description When the endpoint was created.
|
|
7159
|
+
*/
|
|
7095
7160
|
created_at: string;
|
|
7096
|
-
/**
|
|
7161
|
+
/**
|
|
7162
|
+
* @description A label for people; null when unset.
|
|
7163
|
+
* @example Production receiver
|
|
7164
|
+
*/
|
|
7097
7165
|
description: string | null;
|
|
7098
|
-
/**
|
|
7166
|
+
/**
|
|
7167
|
+
* Format: date-time
|
|
7168
|
+
* @description When it was switched off; null while enabled.
|
|
7169
|
+
*/
|
|
7099
7170
|
disabled_at: string | null;
|
|
7100
|
-
/** @
|
|
7101
|
-
disabled_reason: "
|
|
7171
|
+
/** @description `manual`: switched off by a caller. `failing`: switched off automatically after failed deliveries. Null while enabled. */
|
|
7172
|
+
disabled_reason: components["schemas"]["WebhookEndpointDisabledReason"] | null;
|
|
7102
7173
|
/** @description The on/off switch (`PATCH … { enabled }`). */
|
|
7103
7174
|
enabled: boolean;
|
|
7104
7175
|
/**
|
|
@@ -7111,7 +7182,10 @@ interface components {
|
|
|
7111
7182
|
* @description Start of the current failure streak.
|
|
7112
7183
|
*/
|
|
7113
7184
|
first_failure_at: string | null;
|
|
7114
|
-
/**
|
|
7185
|
+
/**
|
|
7186
|
+
* Format: uuid
|
|
7187
|
+
* @description The endpoint's id.
|
|
7188
|
+
*/
|
|
7115
7189
|
id: string;
|
|
7116
7190
|
/** @description True for endpoints carried over from the product's previous webhook system: they also receive the old signature header until its sunset date. */
|
|
7117
7191
|
legacy_signature: boolean;
|
|
@@ -7134,30 +7208,42 @@ interface components {
|
|
|
7134
7208
|
* @example x9Q=
|
|
7135
7209
|
*/
|
|
7136
7210
|
signing_secret_hint: string;
|
|
7211
|
+
/** @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. */
|
|
7212
|
+
status: components["schemas"]["WebhookEndpointStatus"];
|
|
7137
7213
|
/**
|
|
7138
|
-
*
|
|
7139
|
-
* @
|
|
7214
|
+
* Format: date-time
|
|
7215
|
+
* @description When the endpoint last changed.
|
|
7140
7216
|
*/
|
|
7141
|
-
status: "enabled" | "disabled" | "auto_disabled";
|
|
7142
|
-
/** Format: date-time */
|
|
7143
7217
|
updated_at: string;
|
|
7144
7218
|
/**
|
|
7145
7219
|
* Format: uri
|
|
7220
|
+
* @description Where events are sent.
|
|
7146
7221
|
* @example https://api.acme.com/webhooks
|
|
7147
7222
|
*/
|
|
7148
7223
|
url: string;
|
|
7149
7224
|
};
|
|
7225
|
+
/** @enum {string} */
|
|
7226
|
+
WebhookEndpointStatus: "enabled" | "disabled" | "auto_disabled";
|
|
7150
7227
|
WebhookEndpointWithSecretDto: {
|
|
7151
7228
|
/** @description Failed automatic deliveries in a row; a success resets it. */
|
|
7152
7229
|
consecutive_failures: number;
|
|
7153
|
-
/**
|
|
7230
|
+
/**
|
|
7231
|
+
* Format: date-time
|
|
7232
|
+
* @description When the endpoint was created.
|
|
7233
|
+
*/
|
|
7154
7234
|
created_at: string;
|
|
7155
|
-
/**
|
|
7235
|
+
/**
|
|
7236
|
+
* @description A label for people; null when unset.
|
|
7237
|
+
* @example Production receiver
|
|
7238
|
+
*/
|
|
7156
7239
|
description: string | null;
|
|
7157
|
-
/**
|
|
7240
|
+
/**
|
|
7241
|
+
* Format: date-time
|
|
7242
|
+
* @description When it was switched off; null while enabled.
|
|
7243
|
+
*/
|
|
7158
7244
|
disabled_at: string | null;
|
|
7159
|
-
/** @
|
|
7160
|
-
disabled_reason: "
|
|
7245
|
+
/** @description `manual`: switched off by a caller. `failing`: switched off automatically after failed deliveries. Null while enabled. */
|
|
7246
|
+
disabled_reason: components["schemas"]["WebhookEndpointDisabledReason"] | null;
|
|
7161
7247
|
/** @description The on/off switch (`PATCH … { enabled }`). */
|
|
7162
7248
|
enabled: boolean;
|
|
7163
7249
|
/**
|
|
@@ -7170,7 +7256,10 @@ interface components {
|
|
|
7170
7256
|
* @description Start of the current failure streak.
|
|
7171
7257
|
*/
|
|
7172
7258
|
first_failure_at: string | null;
|
|
7173
|
-
/**
|
|
7259
|
+
/**
|
|
7260
|
+
* Format: uuid
|
|
7261
|
+
* @description The endpoint's id.
|
|
7262
|
+
*/
|
|
7174
7263
|
id: string;
|
|
7175
7264
|
/** @description True for endpoints carried over from the product's previous webhook system: they also receive the old signature header until its sunset date. */
|
|
7176
7265
|
legacy_signature: boolean;
|
|
@@ -7198,15 +7287,16 @@ interface components {
|
|
|
7198
7287
|
* @example x9Q=
|
|
7199
7288
|
*/
|
|
7200
7289
|
signing_secret_hint: string;
|
|
7290
|
+
/** @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. */
|
|
7291
|
+
status: components["schemas"]["WebhookEndpointStatus"];
|
|
7201
7292
|
/**
|
|
7202
|
-
*
|
|
7203
|
-
* @
|
|
7293
|
+
* Format: date-time
|
|
7294
|
+
* @description When the endpoint last changed.
|
|
7204
7295
|
*/
|
|
7205
|
-
status: "enabled" | "disabled" | "auto_disabled";
|
|
7206
|
-
/** Format: date-time */
|
|
7207
7296
|
updated_at: string;
|
|
7208
7297
|
/**
|
|
7209
7298
|
* Format: uri
|
|
7299
|
+
* @description Where events are sent.
|
|
7210
7300
|
* @example https://api.acme.com/webhooks
|
|
7211
7301
|
*/
|
|
7212
7302
|
url: string;
|
|
@@ -7214,15 +7304,22 @@ interface components {
|
|
|
7214
7304
|
WebhookEventDeliveryDto: {
|
|
7215
7305
|
/** @description Number of the latest attempt; retries and replays count up. */
|
|
7216
7306
|
attempt_number: number;
|
|
7217
|
-
/**
|
|
7307
|
+
/**
|
|
7308
|
+
* Format: date-time
|
|
7309
|
+
* @description When the latest attempt was made.
|
|
7310
|
+
*/
|
|
7218
7311
|
attempted_at: string;
|
|
7219
|
-
/**
|
|
7312
|
+
/**
|
|
7313
|
+
* Format: uuid
|
|
7314
|
+
* @description The endpoint.
|
|
7315
|
+
*/
|
|
7220
7316
|
endpoint_id: string;
|
|
7221
7317
|
/**
|
|
7222
7318
|
* Format: date-time
|
|
7223
7319
|
* @description When the next automatic attempt is due; null when none is queued.
|
|
7224
7320
|
*/
|
|
7225
7321
|
next_attempt_at: string | null;
|
|
7322
|
+
/** @description HTTP status of the latest attempt; null when no response came back. */
|
|
7226
7323
|
status_code: number | null;
|
|
7227
7324
|
/** @description True when the latest attempt got a 2xx. */
|
|
7228
7325
|
succeeded: boolean;
|
|
@@ -7230,7 +7327,10 @@ interface components {
|
|
|
7230
7327
|
WebhookEventDetailDto: {
|
|
7231
7328
|
/** @description Every attempt, newest first. */
|
|
7232
7329
|
attempts: components["schemas"]["WebhookDeliveryAttemptDto"][];
|
|
7233
|
-
/**
|
|
7330
|
+
/**
|
|
7331
|
+
* Format: date-time
|
|
7332
|
+
* @description When the event happened.
|
|
7333
|
+
*/
|
|
7234
7334
|
created_at: string;
|
|
7235
7335
|
/** @description Latest attempt per endpoint (an endpoint whose first attempt is still queued is not listed yet). */
|
|
7236
7336
|
deliveries: components["schemas"]["WebhookEventDeliveryDto"][];
|
|
@@ -7243,21 +7343,21 @@ interface components {
|
|
|
7243
7343
|
payload: {
|
|
7244
7344
|
[key: string]: unknown;
|
|
7245
7345
|
};
|
|
7246
|
-
/**
|
|
7247
|
-
|
|
7248
|
-
* @enum {string}
|
|
7249
|
-
*/
|
|
7250
|
-
status: "pending" | "delivered" | "failed" | "not_sent";
|
|
7346
|
+
/** @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. */
|
|
7347
|
+
status: components["schemas"]["WebhookEventStatus"];
|
|
7251
7348
|
/** @description Made by "Send test". */
|
|
7252
7349
|
test: boolean;
|
|
7253
7350
|
/**
|
|
7351
|
+
* @description The event type (one of this product's catalogue).
|
|
7254
7352
|
* @example post.created
|
|
7255
|
-
* @enum {string}
|
|
7256
7353
|
*/
|
|
7257
|
-
type: "
|
|
7354
|
+
type: components["schemas"]["WebhookEventType"];
|
|
7258
7355
|
};
|
|
7259
7356
|
WebhookEventDto: {
|
|
7260
|
-
/**
|
|
7357
|
+
/**
|
|
7358
|
+
* Format: date-time
|
|
7359
|
+
* @description When the event happened.
|
|
7360
|
+
*/
|
|
7261
7361
|
created_at: string;
|
|
7262
7362
|
/** @description Latest attempt per endpoint (an endpoint whose first attempt is still queued is not listed yet). */
|
|
7263
7363
|
deliveries: components["schemas"]["WebhookEventDeliveryDto"][];
|
|
@@ -7270,36 +7370,40 @@ interface components {
|
|
|
7270
7370
|
payload: {
|
|
7271
7371
|
[key: string]: unknown;
|
|
7272
7372
|
};
|
|
7273
|
-
/**
|
|
7274
|
-
|
|
7275
|
-
* @enum {string}
|
|
7276
|
-
*/
|
|
7277
|
-
status: "pending" | "delivered" | "failed" | "not_sent";
|
|
7373
|
+
/** @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. */
|
|
7374
|
+
status: components["schemas"]["WebhookEventStatus"];
|
|
7278
7375
|
/** @description Made by "Send test". */
|
|
7279
7376
|
test: boolean;
|
|
7280
7377
|
/**
|
|
7378
|
+
* @description The event type (one of this product's catalogue).
|
|
7281
7379
|
* @example post.created
|
|
7282
|
-
* @enum {string}
|
|
7283
7380
|
*/
|
|
7284
|
-
type: "
|
|
7381
|
+
type: components["schemas"]["WebhookEventType"];
|
|
7285
7382
|
};
|
|
7383
|
+
/** @enum {string} */
|
|
7384
|
+
WebhookEventStatus: "pending" | "delivered" | "failed" | "not_sent";
|
|
7385
|
+
/** @enum {string} */
|
|
7386
|
+
WebhookEventType: "post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed";
|
|
7286
7387
|
WebhookEventTypeDto: {
|
|
7287
7388
|
/**
|
|
7288
7389
|
* @description Group shown in the event picker.
|
|
7289
7390
|
* @example Users
|
|
7290
7391
|
*/
|
|
7291
7392
|
category: string;
|
|
7292
|
-
/**
|
|
7393
|
+
/**
|
|
7394
|
+
* @description When this event is sent.
|
|
7395
|
+
* @example A user signed up or was created by an admin.
|
|
7396
|
+
*/
|
|
7293
7397
|
description: string;
|
|
7294
7398
|
/** @description An example `data` object; "Send test" delivers exactly this. */
|
|
7295
7399
|
example: {
|
|
7296
7400
|
[key: string]: unknown;
|
|
7297
7401
|
};
|
|
7298
7402
|
/**
|
|
7403
|
+
* @description The event type (one of this product's catalogue).
|
|
7299
7404
|
* @example post.created
|
|
7300
|
-
* @enum {string}
|
|
7301
7405
|
*/
|
|
7302
|
-
type: "
|
|
7406
|
+
type: components["schemas"]["WebhookEventType"];
|
|
7303
7407
|
};
|
|
7304
7408
|
WebhookEventTypesResponseDto: {
|
|
7305
7409
|
/**
|
|
@@ -9773,6 +9877,8 @@ interface operations {
|
|
|
9773
9877
|
/** @description Image stored and ready, or video created in `uploading` with `upload` instructions. */
|
|
9774
9878
|
201: {
|
|
9775
9879
|
headers: {
|
|
9880
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
9881
|
+
"Idempotent-Replay"?: "true";
|
|
9776
9882
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
9777
9883
|
[name: string]: unknown;
|
|
9778
9884
|
};
|
|
@@ -9810,6 +9916,18 @@ interface operations {
|
|
|
9810
9916
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9811
9917
|
};
|
|
9812
9918
|
};
|
|
9919
|
+
/** @description 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). */
|
|
9920
|
+
409: {
|
|
9921
|
+
headers: {
|
|
9922
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
9923
|
+
"Retry-After"?: number;
|
|
9924
|
+
"X-Request-Id": components["headers"]["RequestId"];
|
|
9925
|
+
[name: string]: unknown;
|
|
9926
|
+
};
|
|
9927
|
+
content: {
|
|
9928
|
+
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9929
|
+
};
|
|
9930
|
+
};
|
|
9813
9931
|
/** @description The image could not be decoded/processed. */
|
|
9814
9932
|
422: {
|
|
9815
9933
|
headers: {
|
|
@@ -9940,6 +10058,8 @@ interface operations {
|
|
|
9940
10058
|
/** @description Finalized (`processing`) — or the current status on replay. */
|
|
9941
10059
|
200: {
|
|
9942
10060
|
headers: {
|
|
10061
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
10062
|
+
"Idempotent-Replay"?: "true";
|
|
9943
10063
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
9944
10064
|
[name: string]: unknown;
|
|
9945
10065
|
};
|
|
@@ -9967,6 +10087,18 @@ interface operations {
|
|
|
9967
10087
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
9968
10088
|
};
|
|
9969
10089
|
};
|
|
10090
|
+
/** @description 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). */
|
|
10091
|
+
409: {
|
|
10092
|
+
headers: {
|
|
10093
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
10094
|
+
"Retry-After"?: number;
|
|
10095
|
+
"X-Request-Id": components["headers"]["RequestId"];
|
|
10096
|
+
[name: string]: unknown;
|
|
10097
|
+
};
|
|
10098
|
+
content: {
|
|
10099
|
+
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10100
|
+
};
|
|
10101
|
+
};
|
|
9970
10102
|
/** @description `ASSET_UPLOAD_INCOMPLETE` (no object / size mismatch — still retryable), `ASSET_TOO_LARGE` or `ASSET_INVALID_CONTAINER` (upload failed + object deleted), or `ASSET_NOT_VIDEO`. */
|
|
9971
10103
|
422: {
|
|
9972
10104
|
headers: {
|
|
@@ -10268,6 +10400,8 @@ interface operations {
|
|
|
10268
10400
|
/** @description Collection created. */
|
|
10269
10401
|
201: {
|
|
10270
10402
|
headers: {
|
|
10403
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
10404
|
+
"Idempotent-Replay"?: "true";
|
|
10271
10405
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
10272
10406
|
[name: string]: unknown;
|
|
10273
10407
|
};
|
|
@@ -10305,6 +10439,18 @@ interface operations {
|
|
|
10305
10439
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10306
10440
|
};
|
|
10307
10441
|
};
|
|
10442
|
+
/** @description 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). */
|
|
10443
|
+
409: {
|
|
10444
|
+
headers: {
|
|
10445
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
10446
|
+
"Retry-After"?: number;
|
|
10447
|
+
"X-Request-Id": components["headers"]["RequestId"];
|
|
10448
|
+
[name: string]: unknown;
|
|
10449
|
+
};
|
|
10450
|
+
content: {
|
|
10451
|
+
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10452
|
+
};
|
|
10453
|
+
};
|
|
10308
10454
|
/** @description Cover asset is not ready. */
|
|
10309
10455
|
422: {
|
|
10310
10456
|
headers: {
|
|
@@ -10894,6 +11040,8 @@ interface operations {
|
|
|
10894
11040
|
/** @description Conversation created or (1-on-1 only) returned. */
|
|
10895
11041
|
201: {
|
|
10896
11042
|
headers: {
|
|
11043
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
11044
|
+
"Idempotent-Replay"?: "true";
|
|
10897
11045
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
10898
11046
|
[name: string]: unknown;
|
|
10899
11047
|
};
|
|
@@ -10931,9 +11079,11 @@ interface operations {
|
|
|
10931
11079
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
10932
11080
|
};
|
|
10933
11081
|
};
|
|
10934
|
-
/** @description A block exists, the group exceeds `community.settings.max_group_conversation_size`, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-Key, different body). */
|
|
11082
|
+
/** @description A block exists, the group exceeds `community.settings.max_group_conversation_size`, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-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). */
|
|
10935
11083
|
409: {
|
|
10936
11084
|
headers: {
|
|
11085
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
11086
|
+
"Retry-After"?: number;
|
|
10937
11087
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
10938
11088
|
[name: string]: unknown;
|
|
10939
11089
|
};
|
|
@@ -11452,6 +11602,8 @@ interface operations {
|
|
|
11452
11602
|
/** @description Message sent. */
|
|
11453
11603
|
201: {
|
|
11454
11604
|
headers: {
|
|
11605
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
11606
|
+
"Idempotent-Replay"?: "true";
|
|
11455
11607
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
11456
11608
|
[name: string]: unknown;
|
|
11457
11609
|
};
|
|
@@ -11489,9 +11641,11 @@ interface operations {
|
|
|
11489
11641
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
11490
11642
|
};
|
|
11491
11643
|
};
|
|
11492
|
-
/** @description A block exists between the sender and another participant, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-Key, different body). */
|
|
11644
|
+
/** @description A block exists between the sender and another participant, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-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). */
|
|
11493
11645
|
409: {
|
|
11494
11646
|
headers: {
|
|
11647
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
11648
|
+
"Retry-After"?: number;
|
|
11495
11649
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
11496
11650
|
[name: string]: unknown;
|
|
11497
11651
|
};
|
|
@@ -12784,6 +12938,8 @@ interface operations {
|
|
|
12784
12938
|
/** @description List created. */
|
|
12785
12939
|
201: {
|
|
12786
12940
|
headers: {
|
|
12941
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
12942
|
+
"Idempotent-Replay"?: "true";
|
|
12787
12943
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
12788
12944
|
[name: string]: unknown;
|
|
12789
12945
|
};
|
|
@@ -12821,9 +12977,11 @@ interface operations {
|
|
|
12821
12977
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
12822
12978
|
};
|
|
12823
12979
|
};
|
|
12824
|
-
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request body. */
|
|
12980
|
+
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request 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). */
|
|
12825
12981
|
409: {
|
|
12826
12982
|
headers: {
|
|
12983
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
12984
|
+
"Retry-After"?: number;
|
|
12827
12985
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
12828
12986
|
[name: string]: unknown;
|
|
12829
12987
|
};
|
|
@@ -13434,6 +13592,8 @@ interface operations {
|
|
|
13434
13592
|
/** @description Post created. Defaults: `kind=text`, `visibility=public`, `status=published`. */
|
|
13435
13593
|
201: {
|
|
13436
13594
|
headers: {
|
|
13595
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
13596
|
+
"Idempotent-Replay"?: "true";
|
|
13437
13597
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
13438
13598
|
[name: string]: unknown;
|
|
13439
13599
|
};
|
|
@@ -13471,9 +13631,11 @@ interface operations {
|
|
|
13471
13631
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
13472
13632
|
};
|
|
13473
13633
|
};
|
|
13474
|
-
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request body. */
|
|
13634
|
+
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request 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). */
|
|
13475
13635
|
409: {
|
|
13476
13636
|
headers: {
|
|
13637
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
13638
|
+
"Retry-After"?: number;
|
|
13477
13639
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
13478
13640
|
[name: string]: unknown;
|
|
13479
13641
|
};
|
|
@@ -13896,6 +14058,8 @@ interface operations {
|
|
|
13896
14058
|
/** @description Comment created. */
|
|
13897
14059
|
201: {
|
|
13898
14060
|
headers: {
|
|
14061
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
14062
|
+
"Idempotent-Replay"?: "true";
|
|
13899
14063
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
13900
14064
|
[name: string]: unknown;
|
|
13901
14065
|
};
|
|
@@ -13933,9 +14097,11 @@ interface operations {
|
|
|
13933
14097
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
13934
14098
|
};
|
|
13935
14099
|
};
|
|
13936
|
-
/** @description Block exists between commenter and post author, depth exceeds community.settings.max_comment_depth, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-Key, different body). */
|
|
14100
|
+
/** @description Block exists between commenter and post author, depth exceeds community.settings.max_comment_depth, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-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). */
|
|
13937
14101
|
409: {
|
|
13938
14102
|
headers: {
|
|
14103
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
14104
|
+
"Retry-After"?: number;
|
|
13939
14105
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
13940
14106
|
[name: string]: unknown;
|
|
13941
14107
|
};
|
|
@@ -15901,6 +16067,8 @@ interface operations {
|
|
|
15901
16067
|
/** @description Webhook created. */
|
|
15902
16068
|
201: {
|
|
15903
16069
|
headers: {
|
|
16070
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16071
|
+
"Idempotent-Replay"?: "true";
|
|
15904
16072
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
15905
16073
|
[name: string]: unknown;
|
|
15906
16074
|
};
|
|
@@ -15938,9 +16106,11 @@ interface operations {
|
|
|
15938
16106
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
15939
16107
|
};
|
|
15940
16108
|
};
|
|
15941
|
-
/** @description Webhook cap reached (10 per community), or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-Key, different body). */
|
|
16109
|
+
/** @description Webhook cap reached (10 per community), or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-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). */
|
|
15942
16110
|
409: {
|
|
15943
16111
|
headers: {
|
|
16112
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16113
|
+
"Retry-After"?: number;
|
|
15944
16114
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
15945
16115
|
[name: string]: unknown;
|
|
15946
16116
|
};
|
|
@@ -16044,6 +16214,8 @@ interface operations {
|
|
|
16044
16214
|
responses: {
|
|
16045
16215
|
201: {
|
|
16046
16216
|
headers: {
|
|
16217
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16218
|
+
"Idempotent-Replay"?: "true";
|
|
16047
16219
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16048
16220
|
[name: string]: unknown;
|
|
16049
16221
|
};
|
|
@@ -16091,9 +16263,11 @@ interface operations {
|
|
|
16091
16263
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16092
16264
|
};
|
|
16093
16265
|
};
|
|
16094
|
-
/** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
16266
|
+
/** @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). */
|
|
16095
16267
|
409: {
|
|
16096
16268
|
headers: {
|
|
16269
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16270
|
+
"Retry-After"?: number;
|
|
16097
16271
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16098
16272
|
[name: string]: unknown;
|
|
16099
16273
|
};
|
|
@@ -16262,6 +16436,8 @@ interface operations {
|
|
|
16262
16436
|
responses: {
|
|
16263
16437
|
200: {
|
|
16264
16438
|
headers: {
|
|
16439
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16440
|
+
"Idempotent-Replay"?: "true";
|
|
16265
16441
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16266
16442
|
[name: string]: unknown;
|
|
16267
16443
|
};
|
|
@@ -16309,9 +16485,11 @@ interface operations {
|
|
|
16309
16485
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16310
16486
|
};
|
|
16311
16487
|
};
|
|
16312
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
16488
|
+
/** @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). */
|
|
16313
16489
|
409: {
|
|
16314
16490
|
headers: {
|
|
16491
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16492
|
+
"Retry-After"?: number;
|
|
16315
16493
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16316
16494
|
[name: string]: unknown;
|
|
16317
16495
|
};
|
|
@@ -16353,6 +16531,8 @@ interface operations {
|
|
|
16353
16531
|
responses: {
|
|
16354
16532
|
200: {
|
|
16355
16533
|
headers: {
|
|
16534
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16535
|
+
"Idempotent-Replay"?: "true";
|
|
16356
16536
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16357
16537
|
[name: string]: unknown;
|
|
16358
16538
|
};
|
|
@@ -16400,9 +16580,11 @@ interface operations {
|
|
|
16400
16580
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16401
16581
|
};
|
|
16402
16582
|
};
|
|
16403
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
16583
|
+
/** @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). */
|
|
16404
16584
|
409: {
|
|
16405
16585
|
headers: {
|
|
16586
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16587
|
+
"Retry-After"?: number;
|
|
16406
16588
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16407
16589
|
[name: string]: unknown;
|
|
16408
16590
|
};
|
|
@@ -16435,6 +16617,8 @@ interface operations {
|
|
|
16435
16617
|
/** @description The attempt, successful or not. */
|
|
16436
16618
|
200: {
|
|
16437
16619
|
headers: {
|
|
16620
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16621
|
+
"Idempotent-Replay"?: "true";
|
|
16438
16622
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16439
16623
|
[name: string]: unknown;
|
|
16440
16624
|
};
|
|
@@ -16482,9 +16666,11 @@ interface operations {
|
|
|
16482
16666
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16483
16667
|
};
|
|
16484
16668
|
};
|
|
16485
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
16669
|
+
/** @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). */
|
|
16486
16670
|
409: {
|
|
16487
16671
|
headers: {
|
|
16672
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16673
|
+
"Retry-After"?: number;
|
|
16488
16674
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16489
16675
|
[name: string]: unknown;
|
|
16490
16676
|
};
|
|
@@ -16554,11 +16740,13 @@ interface operations {
|
|
|
16554
16740
|
type?: ("post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed")[];
|
|
16555
16741
|
/** @description Only events sent (or queued) to this endpoint. */
|
|
16556
16742
|
endpoint_id?: string;
|
|
16557
|
-
|
|
16743
|
+
/** @description Only events in this delivery status. */
|
|
16744
|
+
status?: components["schemas"]["WebhookEventStatus"];
|
|
16558
16745
|
/** @description Only events created at or after this instant. */
|
|
16559
16746
|
created_after?: string;
|
|
16560
16747
|
/** @description Only events created before this instant. */
|
|
16561
16748
|
created_before?: string;
|
|
16749
|
+
/** @description Page size. */
|
|
16562
16750
|
limit?: number;
|
|
16563
16751
|
/** @description The previous page's `pagination.next_cursor`. */
|
|
16564
16752
|
cursor?: string;
|
|
@@ -16710,6 +16898,8 @@ interface operations {
|
|
|
16710
16898
|
responses: {
|
|
16711
16899
|
200: {
|
|
16712
16900
|
headers: {
|
|
16901
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
16902
|
+
"Idempotent-Replay"?: "true";
|
|
16713
16903
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16714
16904
|
[name: string]: unknown;
|
|
16715
16905
|
};
|
|
@@ -16757,9 +16947,11 @@ interface operations {
|
|
|
16757
16947
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
16758
16948
|
};
|
|
16759
16949
|
};
|
|
16760
|
-
/** @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`). */
|
|
16950
|
+
/** @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). */
|
|
16761
16951
|
409: {
|
|
16762
16952
|
headers: {
|
|
16953
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
16954
|
+
"Retry-After"?: number;
|
|
16763
16955
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
16764
16956
|
[name: string]: unknown;
|
|
16765
16957
|
};
|
|
@@ -17006,6 +17198,8 @@ interface operations {
|
|
|
17006
17198
|
/** @description New secret. */
|
|
17007
17199
|
200: {
|
|
17008
17200
|
headers: {
|
|
17201
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
17202
|
+
"Idempotent-Replay"?: "true";
|
|
17009
17203
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17010
17204
|
[name: string]: unknown;
|
|
17011
17205
|
};
|
|
@@ -17033,9 +17227,11 @@ interface operations {
|
|
|
17033
17227
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17034
17228
|
};
|
|
17035
17229
|
};
|
|
17036
|
-
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request body. */
|
|
17230
|
+
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request 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). */
|
|
17037
17231
|
409: {
|
|
17038
17232
|
headers: {
|
|
17233
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
17234
|
+
"Retry-After"?: number;
|
|
17039
17235
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17040
17236
|
[name: string]: unknown;
|
|
17041
17237
|
};
|
|
@@ -17188,6 +17384,8 @@ interface operations {
|
|
|
17188
17384
|
/** @description Community created. */
|
|
17189
17385
|
201: {
|
|
17190
17386
|
headers: {
|
|
17387
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
17388
|
+
"Idempotent-Replay"?: "true";
|
|
17191
17389
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17192
17390
|
[name: string]: unknown;
|
|
17193
17391
|
};
|
|
@@ -17235,9 +17433,11 @@ interface operations {
|
|
|
17235
17433
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17236
17434
|
};
|
|
17237
17435
|
};
|
|
17238
|
-
/** @description Community slug already taken in this workspace, the supplied `app_id` is already connected to a community, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-Key, different body). */
|
|
17436
|
+
/** @description Community slug already taken in this workspace, the supplied `app_id` is already connected to a community, or `IDEMPOTENCY_KEY_REUSE` (same Idempotency-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). */
|
|
17239
17437
|
409: {
|
|
17240
17438
|
headers: {
|
|
17439
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
17440
|
+
"Retry-After"?: number;
|
|
17241
17441
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17242
17442
|
[name: string]: unknown;
|
|
17243
17443
|
};
|
|
@@ -17567,6 +17767,8 @@ interface operations {
|
|
|
17567
17767
|
/** @description Action recorded (flag_id=null audit row); side-effect applied. */
|
|
17568
17768
|
201: {
|
|
17569
17769
|
headers: {
|
|
17770
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
17771
|
+
"Idempotent-Replay"?: "true";
|
|
17570
17772
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17571
17773
|
[name: string]: unknown;
|
|
17572
17774
|
};
|
|
@@ -17604,6 +17806,18 @@ interface operations {
|
|
|
17604
17806
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17605
17807
|
};
|
|
17606
17808
|
};
|
|
17809
|
+
/** @description 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). */
|
|
17810
|
+
409: {
|
|
17811
|
+
headers: {
|
|
17812
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
17813
|
+
"Retry-After"?: number;
|
|
17814
|
+
"X-Request-Id": components["headers"]["RequestId"];
|
|
17815
|
+
[name: string]: unknown;
|
|
17816
|
+
};
|
|
17817
|
+
content: {
|
|
17818
|
+
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17819
|
+
};
|
|
17820
|
+
};
|
|
17607
17821
|
};
|
|
17608
17822
|
};
|
|
17609
17823
|
ModerationAdminController_shadowBan: {
|
|
@@ -17629,6 +17843,8 @@ interface operations {
|
|
|
17629
17843
|
/** @description Shadow ban applied. */
|
|
17630
17844
|
200: {
|
|
17631
17845
|
headers: {
|
|
17846
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
17847
|
+
"Idempotent-Replay"?: "true";
|
|
17632
17848
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17633
17849
|
[name: string]: unknown;
|
|
17634
17850
|
};
|
|
@@ -17666,9 +17882,11 @@ interface operations {
|
|
|
17666
17882
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
17667
17883
|
};
|
|
17668
17884
|
};
|
|
17669
|
-
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request body. */
|
|
17885
|
+
/** @description `IDEMPOTENCY_KEY_REUSE` — the supplied Idempotency-Key was already used with a different request 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). */
|
|
17670
17886
|
409: {
|
|
17671
17887
|
headers: {
|
|
17888
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
17889
|
+
"Retry-After"?: number;
|
|
17672
17890
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
17673
17891
|
[name: string]: unknown;
|
|
17674
17892
|
};
|
|
@@ -18098,6 +18316,8 @@ interface operations {
|
|
|
18098
18316
|
/** @description Action recorded; target status updated where applicable. Returns the updated flag and the audit row. */
|
|
18099
18317
|
201: {
|
|
18100
18318
|
headers: {
|
|
18319
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18320
|
+
"Idempotent-Replay"?: "true";
|
|
18101
18321
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18102
18322
|
[name: string]: unknown;
|
|
18103
18323
|
};
|
|
@@ -18135,9 +18355,11 @@ interface operations {
|
|
|
18135
18355
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18136
18356
|
};
|
|
18137
18357
|
};
|
|
18138
|
-
/** @description FLAG_ALREADY_CLOSED — the flag is already actioned/dismissed and the requested action is punitive (hide/remove/warn/ban); reversals (unhide/restore/dismiss) stay legal on a closed flag. Also `IDEMPOTENCY_KEY_REUSE` (same Idempotency-Key, different body). */
|
|
18358
|
+
/** @description FLAG_ALREADY_CLOSED — the flag is already actioned/dismissed and the requested action is punitive (hide/remove/warn/ban); reversals (unhide/restore/dismiss) stay legal on a closed flag. Also `IDEMPOTENCY_KEY_REUSE` (same Idempotency-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). */
|
|
18139
18359
|
409: {
|
|
18140
18360
|
headers: {
|
|
18361
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18362
|
+
"Retry-After"?: number;
|
|
18141
18363
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18142
18364
|
[name: string]: unknown;
|
|
18143
18365
|
};
|
|
@@ -18296,6 +18518,8 @@ interface operations {
|
|
|
18296
18518
|
responses: {
|
|
18297
18519
|
201: {
|
|
18298
18520
|
headers: {
|
|
18521
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18522
|
+
"Idempotent-Replay"?: "true";
|
|
18299
18523
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18300
18524
|
[name: string]: unknown;
|
|
18301
18525
|
};
|
|
@@ -18343,9 +18567,11 @@ interface operations {
|
|
|
18343
18567
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18344
18568
|
};
|
|
18345
18569
|
};
|
|
18346
|
-
/** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
18570
|
+
/** @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). */
|
|
18347
18571
|
409: {
|
|
18348
18572
|
headers: {
|
|
18573
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18574
|
+
"Retry-After"?: number;
|
|
18349
18575
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18350
18576
|
[name: string]: unknown;
|
|
18351
18577
|
};
|
|
@@ -18520,6 +18746,8 @@ interface operations {
|
|
|
18520
18746
|
responses: {
|
|
18521
18747
|
200: {
|
|
18522
18748
|
headers: {
|
|
18749
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18750
|
+
"Idempotent-Replay"?: "true";
|
|
18523
18751
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18524
18752
|
[name: string]: unknown;
|
|
18525
18753
|
};
|
|
@@ -18567,9 +18795,11 @@ interface operations {
|
|
|
18567
18795
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18568
18796
|
};
|
|
18569
18797
|
};
|
|
18570
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
18798
|
+
/** @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). */
|
|
18571
18799
|
409: {
|
|
18572
18800
|
headers: {
|
|
18801
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18802
|
+
"Retry-After"?: number;
|
|
18573
18803
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18574
18804
|
[name: string]: unknown;
|
|
18575
18805
|
};
|
|
@@ -18613,6 +18843,8 @@ interface operations {
|
|
|
18613
18843
|
responses: {
|
|
18614
18844
|
200: {
|
|
18615
18845
|
headers: {
|
|
18846
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18847
|
+
"Idempotent-Replay"?: "true";
|
|
18616
18848
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18617
18849
|
[name: string]: unknown;
|
|
18618
18850
|
};
|
|
@@ -18660,9 +18892,11 @@ interface operations {
|
|
|
18660
18892
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18661
18893
|
};
|
|
18662
18894
|
};
|
|
18663
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
18895
|
+
/** @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). */
|
|
18664
18896
|
409: {
|
|
18665
18897
|
headers: {
|
|
18898
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18899
|
+
"Retry-After"?: number;
|
|
18666
18900
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18667
18901
|
[name: string]: unknown;
|
|
18668
18902
|
};
|
|
@@ -18697,6 +18931,8 @@ interface operations {
|
|
|
18697
18931
|
/** @description The attempt, successful or not. */
|
|
18698
18932
|
200: {
|
|
18699
18933
|
headers: {
|
|
18934
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
18935
|
+
"Idempotent-Replay"?: "true";
|
|
18700
18936
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18701
18937
|
[name: string]: unknown;
|
|
18702
18938
|
};
|
|
@@ -18744,9 +18980,11 @@ interface operations {
|
|
|
18744
18980
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
18745
18981
|
};
|
|
18746
18982
|
};
|
|
18747
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
18983
|
+
/** @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). */
|
|
18748
18984
|
409: {
|
|
18749
18985
|
headers: {
|
|
18986
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
18987
|
+
"Retry-After"?: number;
|
|
18750
18988
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18751
18989
|
[name: string]: unknown;
|
|
18752
18990
|
};
|
|
@@ -18818,11 +19056,13 @@ interface operations {
|
|
|
18818
19056
|
type?: ("post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed")[];
|
|
18819
19057
|
/** @description Only events sent (or queued) to this endpoint. */
|
|
18820
19058
|
endpoint_id?: string;
|
|
18821
|
-
|
|
19059
|
+
/** @description Only events in this delivery status. */
|
|
19060
|
+
status?: components["schemas"]["WebhookEventStatus"];
|
|
18822
19061
|
/** @description Only events created at or after this instant. */
|
|
18823
19062
|
created_after?: string;
|
|
18824
19063
|
/** @description Only events created before this instant. */
|
|
18825
19064
|
created_before?: string;
|
|
19065
|
+
/** @description Page size. */
|
|
18826
19066
|
limit?: number;
|
|
18827
19067
|
/** @description The previous page's `pagination.next_cursor`. */
|
|
18828
19068
|
cursor?: string;
|
|
@@ -18980,6 +19220,8 @@ interface operations {
|
|
|
18980
19220
|
responses: {
|
|
18981
19221
|
200: {
|
|
18982
19222
|
headers: {
|
|
19223
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19224
|
+
"Idempotent-Replay"?: "true";
|
|
18983
19225
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
18984
19226
|
[name: string]: unknown;
|
|
18985
19227
|
};
|
|
@@ -19027,9 +19269,11 @@ interface operations {
|
|
|
19027
19269
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19028
19270
|
};
|
|
19029
19271
|
};
|
|
19030
|
-
/** @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`). */
|
|
19272
|
+
/** @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). */
|
|
19031
19273
|
409: {
|
|
19032
19274
|
headers: {
|
|
19275
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19276
|
+
"Retry-After"?: number;
|
|
19033
19277
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19034
19278
|
[name: string]: unknown;
|
|
19035
19279
|
};
|
|
@@ -19180,6 +19424,8 @@ interface operations {
|
|
|
19180
19424
|
responses: {
|
|
19181
19425
|
201: {
|
|
19182
19426
|
headers: {
|
|
19427
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19428
|
+
"Idempotent-Replay"?: "true";
|
|
19183
19429
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19184
19430
|
[name: string]: unknown;
|
|
19185
19431
|
};
|
|
@@ -19227,9 +19473,11 @@ interface operations {
|
|
|
19227
19473
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19228
19474
|
};
|
|
19229
19475
|
};
|
|
19230
|
-
/** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
19476
|
+
/** @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). */
|
|
19231
19477
|
409: {
|
|
19232
19478
|
headers: {
|
|
19479
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19480
|
+
"Retry-After"?: number;
|
|
19233
19481
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19234
19482
|
[name: string]: unknown;
|
|
19235
19483
|
};
|
|
@@ -19398,6 +19646,8 @@ interface operations {
|
|
|
19398
19646
|
responses: {
|
|
19399
19647
|
200: {
|
|
19400
19648
|
headers: {
|
|
19649
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19650
|
+
"Idempotent-Replay"?: "true";
|
|
19401
19651
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19402
19652
|
[name: string]: unknown;
|
|
19403
19653
|
};
|
|
@@ -19445,9 +19695,11 @@ interface operations {
|
|
|
19445
19695
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19446
19696
|
};
|
|
19447
19697
|
};
|
|
19448
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
19698
|
+
/** @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). */
|
|
19449
19699
|
409: {
|
|
19450
19700
|
headers: {
|
|
19701
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19702
|
+
"Retry-After"?: number;
|
|
19451
19703
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19452
19704
|
[name: string]: unknown;
|
|
19453
19705
|
};
|
|
@@ -19489,6 +19741,8 @@ interface operations {
|
|
|
19489
19741
|
responses: {
|
|
19490
19742
|
200: {
|
|
19491
19743
|
headers: {
|
|
19744
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19745
|
+
"Idempotent-Replay"?: "true";
|
|
19492
19746
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19493
19747
|
[name: string]: unknown;
|
|
19494
19748
|
};
|
|
@@ -19536,9 +19790,11 @@ interface operations {
|
|
|
19536
19790
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19537
19791
|
};
|
|
19538
19792
|
};
|
|
19539
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
19793
|
+
/** @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). */
|
|
19540
19794
|
409: {
|
|
19541
19795
|
headers: {
|
|
19796
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19797
|
+
"Retry-After"?: number;
|
|
19542
19798
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19543
19799
|
[name: string]: unknown;
|
|
19544
19800
|
};
|
|
@@ -19571,6 +19827,8 @@ interface operations {
|
|
|
19571
19827
|
/** @description The attempt, successful or not. */
|
|
19572
19828
|
200: {
|
|
19573
19829
|
headers: {
|
|
19830
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
19831
|
+
"Idempotent-Replay"?: "true";
|
|
19574
19832
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19575
19833
|
[name: string]: unknown;
|
|
19576
19834
|
};
|
|
@@ -19618,9 +19876,11 @@ interface operations {
|
|
|
19618
19876
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19619
19877
|
};
|
|
19620
19878
|
};
|
|
19621
|
-
/** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
|
|
19879
|
+
/** @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). */
|
|
19622
19880
|
409: {
|
|
19623
19881
|
headers: {
|
|
19882
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
19883
|
+
"Retry-After"?: number;
|
|
19624
19884
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19625
19885
|
[name: string]: unknown;
|
|
19626
19886
|
};
|
|
@@ -19690,11 +19950,13 @@ interface operations {
|
|
|
19690
19950
|
type?: ("post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed")[];
|
|
19691
19951
|
/** @description Only events sent (or queued) to this endpoint. */
|
|
19692
19952
|
endpoint_id?: string;
|
|
19693
|
-
|
|
19953
|
+
/** @description Only events in this delivery status. */
|
|
19954
|
+
status?: components["schemas"]["WebhookEventStatus"];
|
|
19694
19955
|
/** @description Only events created at or after this instant. */
|
|
19695
19956
|
created_after?: string;
|
|
19696
19957
|
/** @description Only events created before this instant. */
|
|
19697
19958
|
created_before?: string;
|
|
19959
|
+
/** @description Page size. */
|
|
19698
19960
|
limit?: number;
|
|
19699
19961
|
/** @description The previous page's `pagination.next_cursor`. */
|
|
19700
19962
|
cursor?: string;
|
|
@@ -19846,6 +20108,8 @@ interface operations {
|
|
|
19846
20108
|
responses: {
|
|
19847
20109
|
200: {
|
|
19848
20110
|
headers: {
|
|
20111
|
+
/** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
|
|
20112
|
+
"Idempotent-Replay"?: "true";
|
|
19849
20113
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19850
20114
|
[name: string]: unknown;
|
|
19851
20115
|
};
|
|
@@ -19893,9 +20157,11 @@ interface operations {
|
|
|
19893
20157
|
"application/json": components["schemas"]["ErrorResponseDto"];
|
|
19894
20158
|
};
|
|
19895
20159
|
};
|
|
19896
|
-
/** @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`). */
|
|
20160
|
+
/** @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). */
|
|
19897
20161
|
409: {
|
|
19898
20162
|
headers: {
|
|
20163
|
+
/** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
|
|
20164
|
+
"Retry-After"?: number;
|
|
19899
20165
|
"X-Request-Id": components["headers"]["RequestId"];
|
|
19900
20166
|
[name: string]: unknown;
|
|
19901
20167
|
};
|