From 4d266b32b984879408527bb99d9ccf8174d5d728 Mon Sep 17 00:00:00 2001 From: Daniel Remiszewski Date: Tue, 14 May 2024 11:15:09 +0200 Subject: [PATCH] docs: rate limiting (#1878) * docs: rate limiting * fix: duplicated headers section * fix: reword description * fix: apply suggestions from code review to improve readability Co-authored-by: Chris <85164331+noon-dawg@users.noreply.github.com> * fix: apply suggestions from code review to improve readability Co-authored-by: Chris <85164331+noon-dawg@users.noreply.github.com> * refactor: add retry after header, materialize base problem * fix: typo --------- Co-authored-by: Chris <85164331+noon-dawg@users.noreply.github.com> --- .../components/headers/X-RateLimit-Limit.yaml | 6 ++++ .../headers/X-RateLimit-Remaining.yaml | 6 ++++ .../headers/X-RateLimit-Retry-After.yaml | 4 +++ .../components/responses/TooManyRequests.yaml | 8 +++++ .../schemas/ProblemTypes/TooManyRequests.yaml | 34 +++++++++++++++++++ openapi/description.md | 9 +++++ openapi/paths/allowlists.yaml | 12 +++++-- openapi/paths/allowlists@{id}.yaml | 12 +++++++ openapi/paths/aml-checks@{id}@review.yaml | 6 ++++ .../paths/aml-checks@{id}@start-review.yaml | 6 ++++ .../paths/aml-checks@{id}@stop-review.yaml | 6 ++++ openapi/paths/aml-settings.yaml | 11 ++++++ openapi/paths/api-keys.yaml | 6 ++++ openapi/paths/api-keys@{id}.yaml | 13 +++++++ ...application-instances@{applicationId}.yaml | 13 +++++++ ...stances@{applicationId}@configuration.yaml | 11 ++++++ openapi/paths/applications.yaml | 6 ++++ openapi/paths/attachments.yaml | 6 ++++ openapi/paths/attachments@{id}.yaml | 13 +++++++ openapi/paths/authentication-options.yaml | 7 ++++ openapi/paths/authentication-tokens.yaml | 6 ++++ .../paths/authentication-tokens@{token}.yaml | 7 ++++ ...uthentication-tokens@{token}@exchange.yaml | 6 ++++ openapi/paths/billing-portals.yaml | 6 ++++ openapi/paths/billing-portals@{id}.yaml | 18 ++++++++++ openapi/paths/blocklists.yaml | 6 ++++ openapi/paths/blocklists@{id}.yaml | 13 +++++++ openapi/paths/broadcast-messages.yaml | 6 ++++ openapi/paths/broadcast-messages@{id}.yaml | 9 +++++ openapi/paths/checkout-forms.yaml | 6 ++++ openapi/paths/checkout-forms@{id}.yaml | 13 +++++++ openapi/paths/coupons-redemptions.yaml | 6 ++++ .../coupons-redemptions@{id}@cancel.yaml | 6 ++++ openapi/paths/coupons.yaml | 6 ++++ openapi/paths/coupons@{id}.yaml | 11 ++++++ openapi/paths/coupons@{id}@expiration.yaml | 6 ++++ openapi/paths/credentials.yaml | 6 ++++ openapi/paths/credentials@{id}.yaml | 18 ++++++++++ openapi/paths/credit-memos.yaml | 6 ++++ openapi/paths/credit-memos@{id}.yaml | 18 ++++++++++ openapi/paths/credit-memos@{id}@timeline.yaml | 6 ++++ ...redit-memos@{id}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/credit-memos@{id}@void.yaml | 6 ++++ openapi/paths/custom-domains.yaml | 6 ++++ openapi/paths/custom-domains@{domain}.yaml | 7 ++++ .../custom-fields@{resource}@{name}.yaml | 11 ++++++ .../customer-timeline-custom-events.yaml | 6 ++++ openapi/paths/customers.yaml | 6 ++++ openapi/paths/customers@{id}.yaml | 13 +++++++ openapi/paths/customers@{id}@edd-score.yaml | 7 ++++ .../paths/customers@{id}@edd-timeline.yaml | 6 ++++ ...stomers@{id}@edd-timeline@{messageId}.yaml | 7 ++++ openapi/paths/customers@{id}@lead-source.yaml | 13 +++++++ openapi/paths/customers@{id}@timeline.yaml | 6 ++++ .../customers@{id}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/data-exports.yaml | 6 ++++ openapi/paths/data-exports@{id}.yaml | 9 +++++ .../paths/deposit-custom-property-sets.yaml | 6 ++++ .../deposit-custom-property-sets@{id}.yaml | 18 ++++++++++ openapi/paths/deposit-requests.yaml | 6 ++++ openapi/paths/deposit-strategies.yaml | 6 ++++ openapi/paths/deposit-strategies@{id}.yaml | 13 +++++++ .../digital-wallets@onboarding@apple-pay.yaml | 11 ++++++ openapi/paths/digital-wallets@validation.yaml | 6 ++++ openapi/paths/disputes.yaml | 6 ++++ openapi/paths/disputes@{id}.yaml | 11 ++++++ ...elivery-setting-verifications@{token}.yaml | 7 ++++ openapi/paths/email-delivery-settings.yaml | 6 ++++ .../paths/email-delivery-settings@{id}.yaml | 14 ++++++++ ...ttings@{id}@resend-email-verification.yaml | 7 ++++ openapi/paths/email-messages.yaml | 6 ++++ openapi/paths/email-messages@{id}.yaml | 14 ++++++++ openapi/paths/events@{eventType}@rules.yaml | 7 ++++ .../events@{eventType}@rules@drafts.yaml | 6 ++++ .../events@{eventType}@rules@drafts@{id}.yaml | 18 ++++++++++ .../paths/events@{eventType}@timeline.yaml | 6 ++++ ...ents@{eventType}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/external-services-settings.yaml | 7 ++++ openapi/paths/fees.yaml | 6 ++++ openapi/paths/fees@{id}.yaml | 15 ++++++++ openapi/paths/files.yaml | 6 ++++ openapi/paths/files@{id}.yaml | 14 ++++++++ openapi/paths/gateway-accounts.yaml | 6 ++++ openapi/paths/gateway-accounts@{id}.yaml | 25 ++++++++++++++ ...teway-accounts@{id}@check-credentials.yaml | 7 ++++ .../paths/gateway-accounts@{id}@close.yaml | 6 ++++ .../paths/gateway-accounts@{id}@disable.yaml | 6 ++++ ...eway-accounts@{id}@downtime-schedules.yaml | 6 ++++ ...@{id}@downtime-schedules@{downtimeId}.yaml | 12 +++++++ .../paths/gateway-accounts@{id}@enable.yaml | 6 ++++ ...eway-accounts@{id}@financial-settings.yaml | 11 ++++++ ...ateway-accounts@{id}@limits@{limitId}.yaml | 11 ++++++ .../paths/gateway-accounts@{id}@timeline.yaml | 6 ++++ ...ay-accounts@{id}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/grid-segments.yaml | 6 ++++ openapi/paths/grid-segments@{id}.yaml | 14 ++++++++ openapi/paths/invoices.yaml | 6 ++++ openapi/paths/invoices@{id}.yaml | 11 ++++++ openapi/paths/invoices@{id}@abandon.yaml | 6 ++++ openapi/paths/invoices@{id}@issue.yaml | 6 ++++ openapi/paths/invoices@{id}@items.yaml | 6 ++++ .../paths/invoices@{id}@items@{itemId}.yaml | 14 ++++++++ openapi/paths/invoices@{id}@recalculate.yaml | 6 ++++ openapi/paths/invoices@{id}@reissue.yaml | 6 ++++ openapi/paths/invoices@{id}@timeline.yaml | 6 ++++ .../invoices@{id}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/invoices@{id}@transaction.yaml | 7 ++++ openapi/paths/invoices@{id}@void.yaml | 6 ++++ openapi/paths/journal-accounts.yaml | 6 ++++ openapi/paths/journal-accounts@{id}.yaml | 11 ++++++ openapi/paths/journal-entries.yaml | 6 ++++ openapi/paths/journal-entries@{id}.yaml | 11 ++++++ .../paths/journal-entries@{id}@records.yaml | 6 ++++ ...ntries@{id}@records@{journalRecordId}.yaml | 18 ++++++++++ openapi/paths/kyc-documents.yaml | 6 ++++ openapi/paths/kyc-documents@{id}.yaml | 11 ++++++ .../paths/kyc-documents@{id}@acceptance.yaml | 6 ++++ openapi/paths/kyc-documents@{id}@matches.yaml | 7 ++++ .../paths/kyc-documents@{id}@rejection.yaml | 6 ++++ openapi/paths/kyc-documents@{id}@review.yaml | 6 ++++ .../kyc-documents@{id}@start-review.yaml | 6 ++++ .../paths/kyc-documents@{id}@stop-review.yaml | 6 ++++ openapi/paths/kyc-requests.yaml | 6 ++++ openapi/paths/kyc-requests@{id}.yaml | 14 ++++++++ openapi/paths/kyc-settings.yaml | 7 ++++ openapi/paths/lists.yaml | 6 ++++ openapi/paths/lists@{id}.yaml | 18 ++++++++++ ...memberships@{organizationId}@{userId}.yaml | 18 ++++++++++ openapi/paths/organization-exports.yaml | 6 ++++ openapi/paths/organizations.yaml | 6 ++++ openapi/paths/organizations@{id}.yaml | 7 ++++ openapi/paths/password-tokens.yaml | 6 ++++ openapi/paths/password-tokens@{id}.yaml | 7 ++++ openapi/paths/payment-instruments.yaml | 10 ++++++ openapi/paths/payment-instruments@{id}.yaml | 7 ++++ ...payment-instruments@{id}@deactivation.yaml | 6 ++++ openapi/paths/payout-requests.yaml | 6 ++++ openapi/paths/payout-requests@{id}.yaml | 19 ++++++++--- .../paths/payout-requests@{id}@cancel.yaml | 6 ++++ ...out-requests@{id}@payment-instruments.yaml | 8 ++--- openapi/paths/payouts.yaml | 6 ++++ openapi/paths/permissions-emulation.yaml | 12 +++++++ openapi/paths/plans.yaml | 6 ++++ openapi/paths/plans@{id}.yaml | 18 ++++++++++ openapi/paths/previews@orders.yaml | 15 +++++--- .../previews@rule-actions@send-email.yaml | 7 ++++ openapi/paths/previews@webhooks.yaml | 7 ++++ openapi/paths/products.yaml | 6 ++++ openapi/paths/products@{id}.yaml | 13 +++++++ openapi/paths/profile.yaml | 7 ++++ openapi/paths/profile@mfa.yaml | 13 +++++++ openapi/paths/quotes.yaml | 6 ++++ openapi/paths/quotes@{id}.yaml | 18 ++++++++++ openapi/paths/quotes@{id}@accept.yaml | 7 ++++ openapi/paths/quotes@{id}@cancel.yaml | 7 ++++ openapi/paths/quotes@{id}@issue.yaml | 7 ++++ openapi/paths/quotes@{id}@recall.yaml | 7 ++++ openapi/paths/quotes@{id}@reject.yaml | 7 ++++ openapi/paths/quotes@{id}@timeline.yaml | 6 ++++ .../quotes@{id}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/ready-to-pay.yaml | 15 +++++--- openapi/paths/risk-score-rules.yaml | 11 ++++++ .../paths/risk-score-rules@blocklists.yaml | 11 ++++++ openapi/paths/roles.yaml | 6 ++++ openapi/paths/roles@{id}.yaml | 13 +++++++ openapi/paths/service-credentials@{type}.yaml | 17 +++++++++- .../service-credentials@{type}@{id}.yaml | 7 ++++ openapi/paths/shipping-rates.yaml | 6 ++++ openapi/paths/shipping-rates@{id}.yaml | 18 ++++++++++ openapi/paths/storefront/account.yaml | 21 ++++++++---- .../storefront/account@forgot-password.yaml | 15 +++++--- .../paths/storefront/account@password.yaml | 15 +++++--- .../account@resend-verification.yaml | 15 +++++--- .../account@reset-password@{token}.yaml | 14 +++++--- .../account@verification@{token}.yaml | 15 +++++--- openapi/paths/storefront/deposit.yaml | 16 ++++++--- openapi/paths/storefront/invoices.yaml | 6 ++-- openapi/paths/storefront/invoices@{id}.yaml | 6 ++-- openapi/paths/storefront/kyc-documents.yaml | 20 +++++++---- .../paths/storefront/kyc-documents@{id}.yaml | 25 +++++++++----- .../storefront/kyc-liveness-sessions.yaml | 6 ++++ .../kyc-liveness-sessions@{id}@finish.yaml | 6 ++++ .../paths/storefront/kyc-requests@{id}.yaml | 8 ++--- openapi/paths/storefront/login.yaml | 10 ++++-- openapi/paths/storefront/logout.yaml | 11 ++++-- openapi/paths/storefront/orders.yaml | 6 ++-- openapi/paths/storefront/orders@{id}.yaml | 25 +++++++++----- .../storefront/orders@{id}@cancellation.yaml | 18 ++++++---- .../paths/storefront/orders@{id}@pause.yaml | 18 ++++++---- .../orders@{id}@upcoming-invoice.yaml | 8 ++--- .../paths/storefront/payment-instruments.yaml | 20 +++++++---- .../storefront/payment-instruments@{id}.yaml | 25 +++++++++----- ...payment-instruments@{id}@deactivation.yaml | 16 ++++++--- .../payment-instruments@{id}@setup.yaml | 24 ++++++++----- openapi/paths/storefront/payment.yaml | 25 ++++++++++---- openapi/paths/storefront/payout-requests.yaml | 6 ++-- .../storefront/payout-requests@{id}.yaml | 25 +++++++++----- openapi/paths/storefront/plans.yaml | 6 ++-- openapi/paths/storefront/plans@{id}.yaml | 8 ++--- .../paths/storefront/preview-purchase.yaml | 15 +++++--- openapi/paths/storefront/products.yaml | 6 ++-- openapi/paths/storefront/products@{id}.yaml | 8 ++--- openapi/paths/storefront/purchase.yaml | 14 +++++--- .../paths/storefront/quotes@{id}@accept.yaml | 7 ++++ .../paths/storefront/quotes@{id}@reject.yaml | 7 ++++ openapi/paths/storefront/ready-to-pay.yaml | 15 +++++--- openapi/paths/storefront/ready-to-payout.yaml | 15 +++++--- openapi/paths/storefront/register.yaml | 14 +++++--- openapi/paths/storefront/subscriptions.yaml | 6 ++++ .../subscriptions@{id}@change-items.yaml | 6 ++++ openapi/paths/storefront/transactions.yaml | 6 ++-- .../paths/storefront/transactions@{id}.yaml | 8 ++--- .../transactions@{id}@{token}@bypass.yaml | 15 +++++--- .../transactions@{id}@{token}@continue.yaml | 17 +++++++--- openapi/paths/storefront/websites@{id}.yaml | 8 ++--- openapi/paths/subscription-cancellations.yaml | 6 ++++ .../subscription-cancellations@{id}.yaml | 25 ++++++++++++++ openapi/paths/subscription-pauses.yaml | 6 ++++ openapi/paths/subscription-pauses@{id}.yaml | 18 ++++++++++ openapi/paths/subscription-reactivations.yaml | 6 ++++ openapi/paths/subscriptions.yaml | 6 ++++ openapi/paths/subscriptions@{id}.yaml | 14 ++++++++ .../subscriptions@{id}@change-items.yaml | 6 ++++ .../subscriptions@{id}@interim-invoice.yaml | 6 ++++ .../subscriptions@{id}@items@{itemId}.yaml | 7 ++++ .../paths/subscriptions@{id}@timeline.yaml | 6 ++++ ...bscriptions@{id}@timeline@{messageId}.yaml | 7 ++++ ...criptions@{id}@upcoming-invoice@issue.yaml | 6 ++++ ...}@upcoming-invoices@{invoiceId}@issue.yaml | 6 ++++ openapi/paths/subscriptions@{id}@void.yaml | 6 ++++ openapi/paths/tags-rules.yaml | 6 ++++ openapi/paths/tags-rules@{id}.yaml | 18 ++++++++++ openapi/paths/tags.yaml | 6 ++++ openapi/paths/tags@{tag}.yaml | 14 ++++++++ openapi/paths/tags@{tag}@aml-checks.yaml | 14 ++++++++ .../tags@{tag}@aml-checks@{amlCheckId}.yaml | 14 ++++++++ openapi/paths/tags@{tag}@customers.yaml | 14 ++++++++ .../tags@{tag}@customers@{customerId}.yaml | 14 ++++++++ openapi/paths/tags@{tag}@kyc-documents.yaml | 14 ++++++++ ...s@{tag}@kyc-documents@{kycDocumentId}.yaml | 14 ++++++++ openapi/paths/tokens.yaml | 6 ++++ .../paths/tracking@webhooks@{id}@resend.yaml | 7 ++++ openapi/paths/transactions.yaml | 6 ++++ openapi/paths/transactions@{id}.yaml | 7 ++++ openapi/paths/transactions@{id}@query.yaml | 6 ++++ openapi/paths/transactions@{id}@refund.yaml | 6 ++++ openapi/paths/transactions@{id}@timeline.yaml | 6 ++++ ...ransactions@{id}@timeline@{messageId}.yaml | 7 ++++ openapi/paths/transactions@{id}@update.yaml | 7 ++++ openapi/paths/usages.yaml | 6 ++++ openapi/paths/usages@{id}.yaml | 18 ++++++++++ openapi/paths/users.yaml | 6 ++++ openapi/paths/users@{id}.yaml | 11 ++++++ openapi/paths/webhooks.yaml | 6 ++++ openapi/paths/webhooks@{id}.yaml | 11 ++++++ openapi/paths/websites.yaml | 6 ++++ openapi/paths/websites@{id}.yaml | 13 +++++++ ...rceId}@external-identifiers@{service}.yaml | 25 ++++++++++++++ 258 files changed, 2321 insertions(+), 213 deletions(-) create mode 100644 openapi/components/headers/X-RateLimit-Limit.yaml create mode 100644 openapi/components/headers/X-RateLimit-Remaining.yaml create mode 100644 openapi/components/headers/X-RateLimit-Retry-After.yaml create mode 100644 openapi/components/responses/TooManyRequests.yaml create mode 100644 openapi/components/schemas/ProblemTypes/TooManyRequests.yaml diff --git a/openapi/components/headers/X-RateLimit-Limit.yaml b/openapi/components/headers/X-RateLimit-Limit.yaml new file mode 100644 index 0000000000..697f8d2473 --- /dev/null +++ b/openapi/components/headers/X-RateLimit-Limit.yaml @@ -0,0 +1,6 @@ +description: |- + Total number of rate limit tokens for this request within a rate limit period. + For more information, see [Rate limits](#section/Rate-limits). +schema: + type: integer +example: 3600 diff --git a/openapi/components/headers/X-RateLimit-Remaining.yaml b/openapi/components/headers/X-RateLimit-Remaining.yaml new file mode 100644 index 0000000000..270ffab28e --- /dev/null +++ b/openapi/components/headers/X-RateLimit-Remaining.yaml @@ -0,0 +1,6 @@ +description: |- + Remaining number of rate limit tokens for this request within the rate limit period. + For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes. +schema: + type: integer +example: 3600 diff --git a/openapi/components/headers/X-RateLimit-Retry-After.yaml b/openapi/components/headers/X-RateLimit-Retry-After.yaml new file mode 100644 index 0000000000..f6a0b8faa1 --- /dev/null +++ b/openapi/components/headers/X-RateLimit-Retry-After.yaml @@ -0,0 +1,4 @@ +description: UTC timestamp after which the rate limit resets and the request can be retried. +schema: + type: integer +example: 1713187500 diff --git a/openapi/components/responses/TooManyRequests.yaml b/openapi/components/responses/TooManyRequests.yaml new file mode 100644 index 0000000000..adb3797773 --- /dev/null +++ b/openapi/components/responses/TooManyRequests.yaml @@ -0,0 +1,8 @@ +description: Request rate limit exceeded. +headers: + X-RateLimit-Retry-After: + $ref: ../headers/X-RateLimit-Retry-After.yaml +content: + application/json: + schema: + $ref: ../schemas/ProblemTypes/TooManyRequests.yaml diff --git a/openapi/components/schemas/ProblemTypes/TooManyRequests.yaml b/openapi/components/schemas/ProblemTypes/TooManyRequests.yaml new file mode 100644 index 0000000000..3e583b294a --- /dev/null +++ b/openapi/components/schemas/ProblemTypes/TooManyRequests.yaml @@ -0,0 +1,34 @@ +type: object +additionalProperties: true +minProperties: 1 +description: RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. +properties: + type: + type: string + description: |- + Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. + It should provide human-readable documentation for the problem type. + When this member is not present, its value is assumed to be "about:blank". + format: uri + example: about:blank + title: + type: string + description: |- + Short, human-readable summary of the problem type. + Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. + example: Rate Limit Exceeded + status: + type: integer + description: HTTP status code. + minimum: 429 + maximum: 429 + detail: + type: string + description: Human-readable explanation that is specific to this occurrence of the problem. + example: A request cannot be executed because the user has sent too many requests within a certain period of time + instance: + type: string + description: |- + URI reference that identifies the specific occurrence of the problem. + It may or may not yield further information if dereferenced. + diff --git a/openapi/description.md b/openapi/description.md index 7ae2bbeed4..63a4a863fb 100644 --- a/openapi/description.md +++ b/openapi/description.md @@ -71,3 +71,12 @@ If you would like to implement a particular use case, To integrate Rebilly, and learn about related resources and concepts, see [Get started](https://www.rebilly.com/docs/dev-docs/get-started/). + +# Rate limits + +Rebilly enforces rate limits on the API to ensure that no single organization consumes too many resources. +Rate limits are applied to the organization, and not to the API key. +In sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes. +You can find the exact number of consumed requests in the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers in the response. +If the rate limit is exceeded, the API returns a `429 Too Many Requests` response +and a `X-RateLimit-Retry-After` header that includes a UTC timestamp of when the rate limit resets. diff --git a/openapi/paths/allowlists.yaml b/openapi/paths/allowlists.yaml index 3f4b3aed6e..ef8a9e345f 100644 --- a/openapi/paths/allowlists.yaml +++ b/openapi/paths/allowlists.yaml @@ -47,16 +47,22 @@ post: description: Allowlist record. required: true responses: - 201: + '201': description: Allowlist record created. headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../components/schemas/Allowlist.yaml - 401: + '401': $ref: ../components/responses/Unauthorized.yaml - 409: + '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/allowlists@{id}.yaml b/openapi/paths/allowlists@{id}.yaml index f7c602793b..45b26da6be 100644 --- a/openapi/paths/allowlists@{id}.yaml +++ b/openapi/paths/allowlists@{id}.yaml @@ -15,6 +15,11 @@ get: responses: '200': description: Allowlist record retrieved. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -35,3 +40,10 @@ delete: responses: '204': description: Allowlist record deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/aml-checks@{id}@review.yaml b/openapi/paths/aml-checks@{id}@review.yaml index b877f468c1..fdccc6d3bd 100644 --- a/openapi/paths/aml-checks@{id}@review.yaml +++ b/openapi/paths/aml-checks@{id}@review.yaml @@ -22,6 +22,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -34,3 +38,5 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/aml-checks@{id}@start-review.yaml b/openapi/paths/aml-checks@{id}@start-review.yaml index 94263383cd..5b21b40b66 100644 --- a/openapi/paths/aml-checks@{id}@start-review.yaml +++ b/openapi/paths/aml-checks@{id}@start-review.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -31,3 +35,5 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/aml-checks@{id}@stop-review.yaml b/openapi/paths/aml-checks@{id}@stop-review.yaml index 83b1d6d0de..4e6c379e36 100644 --- a/openapi/paths/aml-checks@{id}@stop-review.yaml +++ b/openapi/paths/aml-checks@{id}@stop-review.yaml @@ -20,6 +20,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -32,3 +36,5 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/aml-settings.yaml b/openapi/paths/aml-settings.yaml index c744fbba36..fba5570802 100644 --- a/openapi/paths/aml-settings.yaml +++ b/openapi/paths/aml-settings.yaml @@ -39,6 +39,11 @@ put: responses: '200': description: AML settings updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -48,6 +53,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -58,3 +67,5 @@ put: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/api-keys.yaml b/openapi/paths/api-keys.yaml index 9f0bd04b9e..db09dd84e8 100644 --- a/openapi/paths/api-keys.yaml +++ b/openapi/paths/api-keys.yaml @@ -59,6 +59,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -69,6 +73,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/api-keys@{id}.yaml b/openapi/paths/api-keys@{id}.yaml index 4b6d381c3c..e644fe4f5b 100644 --- a/openapi/paths/api-keys@{id}.yaml +++ b/openapi/paths/api-keys@{id}.yaml @@ -54,6 +54,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +70,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/ApiKey.yaml x-codeSamples: @@ -91,6 +97,11 @@ delete: responses: '204': description: API key deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -99,6 +110,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/application-instances@{applicationId}.yaml b/openapi/paths/application-instances@{applicationId}.yaml index ccae3ce248..1293f30142 100644 --- a/openapi/paths/application-instances@{applicationId}.yaml +++ b/openapi/paths/application-instances@{applicationId}.yaml @@ -58,6 +58,11 @@ put: responses: '200': description: Application instance updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,6 +72,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -77,6 +86,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -110,6 +121,8 @@ delete: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/application-instances@{applicationId}@configuration.yaml b/openapi/paths/application-instances@{applicationId}@configuration.yaml index 6bf2517eba..d705571557 100644 --- a/openapi/paths/application-instances@{applicationId}@configuration.yaml +++ b/openapi/paths/application-instances@{applicationId}@configuration.yaml @@ -52,6 +52,11 @@ put: responses: '200': description: Application instance configuration updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -61,6 +66,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,3 +80,5 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/applications.yaml b/openapi/paths/applications.yaml index 43de7c0216..72eaafe9fb 100644 --- a/openapi/paths/applications.yaml +++ b/openapi/paths/applications.yaml @@ -71,6 +71,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -83,6 +87,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/attachments.yaml b/openapi/paths/attachments.yaml index c9501fbfcf..7a814d6227 100644 --- a/openapi/paths/attachments.yaml +++ b/openapi/paths/attachments.yaml @@ -70,6 +70,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -82,6 +86,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/attachments@{id}.yaml b/openapi/paths/attachments@{id}.yaml index c6ec15efad..f33ef444e4 100644 --- a/openapi/paths/attachments@{id}.yaml +++ b/openapi/paths/attachments@{id}.yaml @@ -47,6 +47,11 @@ put: responses: '200': description: Attachment updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -56,6 +61,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -70,6 +79,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -97,6 +108,8 @@ delete: $ref: ../components/responses/Unauthorized.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/authentication-options.yaml b/openapi/paths/authentication-options.yaml index 3ab50e5af3..0c1cfd183b 100644 --- a/openapi/paths/authentication-options.yaml +++ b/openapi/paths/authentication-options.yaml @@ -50,6 +50,11 @@ put: responses: '200': description: Authentication options updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -61,6 +66,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/authentication-tokens.yaml b/openapi/paths/authentication-tokens.yaml index 29e386ecb5..003d6e3c54 100644 --- a/openapi/paths/authentication-tokens.yaml +++ b/openapi/paths/authentication-tokens.yaml @@ -69,6 +69,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -80,6 +84,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/authentication-tokens@{token}.yaml b/openapi/paths/authentication-tokens@{token}.yaml index 994abbeb09..efb116c860 100644 --- a/openapi/paths/authentication-tokens@{token}.yaml +++ b/openapi/paths/authentication-tokens@{token}.yaml @@ -59,10 +59,17 @@ delete: responses: '204': description: Customer logged out. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/authentication-tokens@{token}@exchange.yaml b/openapi/paths/authentication-tokens@{token}@exchange.yaml index 2f6e75dfd8..b258f738f7 100644 --- a/openapi/paths/authentication-tokens@{token}@exchange.yaml +++ b/openapi/paths/authentication-tokens@{token}@exchange.yaml @@ -34,6 +34,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -44,3 +48,5 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/billing-portals.yaml b/openapi/paths/billing-portals.yaml index bf3cf3929b..c3937709ff 100644 --- a/openapi/paths/billing-portals.yaml +++ b/openapi/paths/billing-portals.yaml @@ -48,6 +48,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -58,6 +62,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/billing-portals@{id}.yaml b/openapi/paths/billing-portals@{id}.yaml index 9a78f023db..9208e8e521 100644 --- a/openapi/paths/billing-portals@{id}.yaml +++ b/openapi/paths/billing-portals@{id}.yaml @@ -34,6 +34,11 @@ put: responses: '200': description: Billing portal updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -43,6 +48,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -55,6 +64,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -72,9 +83,16 @@ delete: responses: '204': description: Billing portal deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/blocklists.yaml b/openapi/paths/blocklists.yaml index ebda0e95d3..37f731373d 100644 --- a/openapi/paths/blocklists.yaml +++ b/openapi/paths/blocklists.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/blocklists@{id}.yaml b/openapi/paths/blocklists@{id}.yaml index 7e6400e5a2..16c6bec9f6 100644 --- a/openapi/paths/blocklists@{id}.yaml +++ b/openapi/paths/blocklists@{id}.yaml @@ -56,6 +56,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,6 +72,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -91,12 +97,19 @@ delete: responses: '204': description: Blocklist deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/broadcast-messages.yaml b/openapi/paths/broadcast-messages.yaml index aa5593c479..e13927e27e 100644 --- a/openapi/paths/broadcast-messages.yaml +++ b/openapi/paths/broadcast-messages.yaml @@ -47,6 +47,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -57,6 +61,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/broadcast-messages@{id}.yaml b/openapi/paths/broadcast-messages@{id}.yaml index 8336fa0866..480369ec6d 100644 --- a/openapi/paths/broadcast-messages@{id}.yaml +++ b/openapi/paths/broadcast-messages@{id}.yaml @@ -34,6 +34,8 @@ delete: responses: '204': description: Broadcast message deleted. + '429': + $ref: ../components/responses/TooManyRequests.yaml patch: x-products: - Users @@ -46,6 +48,11 @@ patch: responses: '200': description: Broadcast message updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -56,6 +63,8 @@ patch: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/checkout-forms.yaml b/openapi/paths/checkout-forms.yaml index f71ad51ca6..7addc42054 100644 --- a/openapi/paths/checkout-forms.yaml +++ b/openapi/paths/checkout-forms.yaml @@ -48,6 +48,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -58,6 +62,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/checkout-forms@{id}.yaml b/openapi/paths/checkout-forms@{id}.yaml index 6e4c02735a..fa9885f777 100644 --- a/openapi/paths/checkout-forms@{id}.yaml +++ b/openapi/paths/checkout-forms@{id}.yaml @@ -43,6 +43,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -55,6 +59,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -72,9 +78,16 @@ delete: responses: '204': description: Checkout form deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/coupons-redemptions.yaml b/openapi/paths/coupons-redemptions.yaml index 229e8aa028..05136a50a6 100644 --- a/openapi/paths/coupons-redemptions.yaml +++ b/openapi/paths/coupons-redemptions.yaml @@ -70,6 +70,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -80,6 +84,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/coupons-redemptions@{id}@cancel.yaml b/openapi/paths/coupons-redemptions@{id}@cancel.yaml index 19215d318a..7e832b9355 100644 --- a/openapi/paths/coupons-redemptions@{id}@cancel.yaml +++ b/openapi/paths/coupons-redemptions@{id}@cancel.yaml @@ -15,12 +15,18 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/coupons.yaml b/openapi/paths/coupons.yaml index b65de917b3..9f79c05807 100644 --- a/openapi/paths/coupons.yaml +++ b/openapi/paths/coupons.yaml @@ -65,6 +65,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -75,6 +79,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/coupons@{id}.yaml b/openapi/paths/coupons@{id}.yaml index 348bd0a2bf..fb69a33ef1 100644 --- a/openapi/paths/coupons@{id}.yaml +++ b/openapi/paths/coupons@{id}.yaml @@ -51,6 +51,11 @@ put: responses: '200': description: Coupon updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -60,6 +65,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -72,6 +81,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/coupons@{id}@expiration.yaml b/openapi/paths/coupons@{id}@expiration.yaml index 62a419f58a..a09660d6cf 100644 --- a/openapi/paths/coupons@{id}@expiration.yaml +++ b/openapi/paths/coupons@{id}@expiration.yaml @@ -25,6 +25,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -45,6 +49,8 @@ post: $ref: ../components/schemas/Error.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/credentials.yaml b/openapi/paths/credentials.yaml index 9c5009421c..8553002485 100644 --- a/openapi/paths/credentials.yaml +++ b/openapi/paths/credentials.yaml @@ -63,6 +63,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -73,6 +77,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/credentials@{id}.yaml b/openapi/paths/credentials@{id}.yaml index 9e72532e24..0a196ec864 100644 --- a/openapi/paths/credentials@{id}.yaml +++ b/openapi/paths/credentials@{id}.yaml @@ -52,6 +52,11 @@ put: responses: '200': description: Credential updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -61,6 +66,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -73,6 +82,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -96,10 +107,17 @@ delete: responses: '204': description: Credential deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/credit-memos.yaml b/openapi/paths/credit-memos.yaml index 793c850b4d..0fcf102b11 100644 --- a/openapi/paths/credit-memos.yaml +++ b/openapi/paths/credit-memos.yaml @@ -58,6 +58,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,3 +72,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/credit-memos@{id}.yaml b/openapi/paths/credit-memos@{id}.yaml index 2e2674704d..c744f1df7a 100644 --- a/openapi/paths/credit-memos@{id}.yaml +++ b/openapi/paths/credit-memos@{id}.yaml @@ -44,6 +44,11 @@ put: responses: '200': description: Credit memo updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -53,6 +58,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -65,6 +74,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml patch: x-products: - Core @@ -83,6 +94,11 @@ patch: responses: '200': description: Credit memo updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -95,3 +111,5 @@ patch: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/credit-memos@{id}@timeline.yaml b/openapi/paths/credit-memos@{id}@timeline.yaml index ba007e703c..49c442418b 100644 --- a/openapi/paths/credit-memos@{id}@timeline.yaml +++ b/openapi/paths/credit-memos@{id}@timeline.yaml @@ -57,6 +57,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,3 +71,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/credit-memos@{id}@timeline@{messageId}.yaml b/openapi/paths/credit-memos@{id}@timeline@{messageId}.yaml index c3f713630f..732ffbf9c0 100644 --- a/openapi/paths/credit-memos@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/credit-memos@{id}@timeline@{messageId}.yaml @@ -41,6 +41,11 @@ delete: responses: '204': description: Credit memo timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -49,3 +54,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/credit-memos@{id}@void.yaml b/openapi/paths/credit-memos@{id}@void.yaml index 0d025cba9b..da869790b1 100644 --- a/openapi/paths/credit-memos@{id}@void.yaml +++ b/openapi/paths/credit-memos@{id}@void.yaml @@ -15,6 +15,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -25,3 +29,5 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/custom-domains.yaml b/openapi/paths/custom-domains.yaml index 9d88e03f04..0f4f776002 100644 --- a/openapi/paths/custom-domains.yaml +++ b/openapi/paths/custom-domains.yaml @@ -48,6 +48,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -58,6 +62,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/custom-domains@{domain}.yaml b/openapi/paths/custom-domains@{domain}.yaml index a7eac4b29c..9db48ce817 100644 --- a/openapi/paths/custom-domains@{domain}.yaml +++ b/openapi/paths/custom-domains@{domain}.yaml @@ -41,9 +41,16 @@ delete: responses: '204': description: Custom domains deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/custom-fields@{resource}@{name}.yaml b/openapi/paths/custom-fields@{resource}@{name}.yaml index bb7c705eea..918f3d30c1 100644 --- a/openapi/paths/custom-fields@{resource}@{name}.yaml +++ b/openapi/paths/custom-fields@{resource}@{name}.yaml @@ -60,6 +60,11 @@ put: responses: '200': description: Custom field updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -69,6 +74,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -85,6 +94,8 @@ put: $ref: ../components/schemas/Error.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/customer-timeline-custom-events.yaml b/openapi/paths/customer-timeline-custom-events.yaml index 334ca214ef..76ae46835e 100644 --- a/openapi/paths/customer-timeline-custom-events.yaml +++ b/openapi/paths/customer-timeline-custom-events.yaml @@ -53,6 +53,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -63,3 +67,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/customers.yaml b/openapi/paths/customers.yaml index d22ee0a630..8c44e58df8 100644 --- a/openapi/paths/customers.yaml +++ b/openapi/paths/customers.yaml @@ -77,6 +77,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -89,6 +93,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/customers@{id}.yaml b/openapi/paths/customers@{id}.yaml index 9ed5e2039c..f1dd090d15 100644 --- a/openapi/paths/customers@{id}.yaml +++ b/openapi/paths/customers@{id}.yaml @@ -64,6 +64,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -76,6 +80,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -108,12 +114,19 @@ delete: responses: '204': description: Customer is merged and deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/customers@{id}@edd-score.yaml b/openapi/paths/customers@{id}@edd-score.yaml index 829a1ef125..de883d17b2 100644 --- a/openapi/paths/customers@{id}@edd-score.yaml +++ b/openapi/paths/customers@{id}@edd-score.yaml @@ -55,6 +55,11 @@ patch: responses: '200': description: EDD score updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -65,3 +70,5 @@ patch: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/customers@{id}@edd-timeline.yaml b/openapi/paths/customers@{id}@edd-timeline.yaml index ed0692b19a..d9836f3138 100644 --- a/openapi/paths/customers@{id}@edd-timeline.yaml +++ b/openapi/paths/customers@{id}@edd-timeline.yaml @@ -57,6 +57,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,3 +71,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/customers@{id}@edd-timeline@{messageId}.yaml b/openapi/paths/customers@{id}@edd-timeline@{messageId}.yaml index 329e1dbfed..35e7620840 100644 --- a/openapi/paths/customers@{id}@edd-timeline@{messageId}.yaml +++ b/openapi/paths/customers@{id}@edd-timeline@{messageId}.yaml @@ -40,6 +40,11 @@ delete: responses: '204': description: EDD timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -48,3 +53,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/customers@{id}@lead-source.yaml b/openapi/paths/customers@{id}@lead-source.yaml index d5119cf31b..182f049f36 100644 --- a/openapi/paths/customers@{id}@lead-source.yaml +++ b/openapi/paths/customers@{id}@lead-source.yaml @@ -65,6 +65,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -75,6 +79,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -98,6 +104,11 @@ delete: responses: '204': description: Lead source deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -106,6 +117,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/customers@{id}@timeline.yaml b/openapi/paths/customers@{id}@timeline.yaml index f087fb194f..c9e646d1ca 100644 --- a/openapi/paths/customers@{id}@timeline.yaml +++ b/openapi/paths/customers@{id}@timeline.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/customers@{id}@timeline@{messageId}.yaml b/openapi/paths/customers@{id}@timeline@{messageId}.yaml index 0bdcca3523..b3707d4aeb 100644 --- a/openapi/paths/customers@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/customers@{id}@timeline@{messageId}.yaml @@ -44,6 +44,11 @@ delete: responses: '204': description: Customer timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -52,6 +57,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/data-exports.yaml b/openapi/paths/data-exports.yaml index 9ceb606a8a..b5c78cbd77 100644 --- a/openapi/paths/data-exports.yaml +++ b/openapi/paths/data-exports.yaml @@ -36,6 +36,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -46,6 +50,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/data-exports@{id}.yaml b/openapi/paths/data-exports@{id}.yaml index 1b28126f24..03a6b9a796 100644 --- a/openapi/paths/data-exports@{id}.yaml +++ b/openapi/paths/data-exports@{id}.yaml @@ -73,6 +73,11 @@ put: responses: '200': description: Data export modified. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -92,6 +97,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: @@ -114,6 +121,8 @@ delete: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/deposit-custom-property-sets.yaml b/openapi/paths/deposit-custom-property-sets.yaml index 1c53be5f91..98eac8842e 100644 --- a/openapi/paths/deposit-custom-property-sets.yaml +++ b/openapi/paths/deposit-custom-property-sets.yaml @@ -25,6 +25,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -35,6 +39,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml get: x-products: - Core diff --git a/openapi/paths/deposit-custom-property-sets@{id}.yaml b/openapi/paths/deposit-custom-property-sets@{id}.yaml index 615c82cd8e..4e3ef5c1ab 100644 --- a/openapi/paths/deposit-custom-property-sets@{id}.yaml +++ b/openapi/paths/deposit-custom-property-sets@{id}.yaml @@ -45,6 +45,11 @@ put: responses: '200': description: Custom deposit property updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -54,6 +59,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +75,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -80,9 +91,16 @@ delete: responses: '204': description: Custom deposit property set deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/deposit-requests.yaml b/openapi/paths/deposit-requests.yaml index e2204cf7af..7202a61341 100644 --- a/openapi/paths/deposit-requests.yaml +++ b/openapi/paths/deposit-requests.yaml @@ -26,6 +26,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,6 +40,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml get: x-products: - Core diff --git a/openapi/paths/deposit-strategies.yaml b/openapi/paths/deposit-strategies.yaml index c8a52c14c6..3ce436a1ec 100644 --- a/openapi/paths/deposit-strategies.yaml +++ b/openapi/paths/deposit-strategies.yaml @@ -26,6 +26,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,6 +40,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml get: x-products: - Core diff --git a/openapi/paths/deposit-strategies@{id}.yaml b/openapi/paths/deposit-strategies@{id}.yaml index bb496b0bcf..ae4f42012d 100644 --- a/openapi/paths/deposit-strategies@{id}.yaml +++ b/openapi/paths/deposit-strategies@{id}.yaml @@ -54,6 +54,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +70,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -80,9 +86,16 @@ delete: responses: '204': description: Deposit strategy deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/digital-wallets@onboarding@apple-pay.yaml b/openapi/paths/digital-wallets@onboarding@apple-pay.yaml index ba82bd38a7..4d6546cbcf 100644 --- a/openapi/paths/digital-wallets@onboarding@apple-pay.yaml +++ b/openapi/paths/digital-wallets@onboarding@apple-pay.yaml @@ -27,6 +27,11 @@ post: responses: '200': description: Action executed without error. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,6 +41,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -46,3 +55,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/digital-wallets@validation.yaml b/openapi/paths/digital-wallets@validation.yaml index 71b4871948..5a6ca4c4ca 100644 --- a/openapi/paths/digital-wallets@validation.yaml +++ b/openapi/paths/digital-wallets@validation.yaml @@ -27,6 +27,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -37,3 +41,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/disputes.yaml b/openapi/paths/disputes.yaml index c03dbdc130..0ecfd1fead 100644 --- a/openapi/paths/disputes.yaml +++ b/openapi/paths/disputes.yaml @@ -62,6 +62,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -72,6 +76,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/disputes@{id}.yaml b/openapi/paths/disputes@{id}.yaml index 67d7310408..673e22a814 100644 --- a/openapi/paths/disputes@{id}.yaml +++ b/openapi/paths/disputes@{id}.yaml @@ -47,6 +47,11 @@ put: responses: '200': description: Dispute updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -56,6 +61,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +75,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/email-delivery-setting-verifications@{token}.yaml b/openapi/paths/email-delivery-setting-verifications@{token}.yaml index 2f9ed263e8..b06c6220db 100644 --- a/openapi/paths/email-delivery-setting-verifications@{token}.yaml +++ b/openapi/paths/email-delivery-setting-verifications@{token}.yaml @@ -12,6 +12,11 @@ put: responses: '200': description: Email delivery setting verified. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -23,3 +28,5 @@ put: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/email-delivery-settings.yaml b/openapi/paths/email-delivery-settings.yaml index 5e9b4aefb5..273e424e9b 100644 --- a/openapi/paths/email-delivery-settings.yaml +++ b/openapi/paths/email-delivery-settings.yaml @@ -52,6 +52,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -63,6 +67,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/email-delivery-settings@{id}.yaml b/openapi/paths/email-delivery-settings@{id}.yaml index 7be15bcccd..617c3cac4a 100644 --- a/openapi/paths/email-delivery-settings@{id}.yaml +++ b/openapi/paths/email-delivery-settings@{id}.yaml @@ -36,8 +36,15 @@ delete: responses: '204': description: Email delivery setting deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml patch: x-products: - Users @@ -58,6 +65,11 @@ patch: responses: '200': description: Email delivery setting updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,3 +83,5 @@ patch: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/email-delivery-settings@{id}@resend-email-verification.yaml b/openapi/paths/email-delivery-settings@{id}@resend-email-verification.yaml index 2babd8af3d..4cda8b1b2e 100644 --- a/openapi/paths/email-delivery-settings@{id}@resend-email-verification.yaml +++ b/openapi/paths/email-delivery-settings@{id}@resend-email-verification.yaml @@ -12,6 +12,11 @@ post: responses: '200': description: Verification email sent. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -25,3 +30,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/email-messages.yaml b/openapi/paths/email-messages.yaml index 3ba7309ffc..ab5042458c 100644 --- a/openapi/paths/email-messages.yaml +++ b/openapi/paths/email-messages.yaml @@ -48,6 +48,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -58,6 +62,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/email-messages@{id}.yaml b/openapi/paths/email-messages@{id}.yaml index a0bbb27595..cef5b3aa4d 100644 --- a/openapi/paths/email-messages@{id}.yaml +++ b/openapi/paths/email-messages@{id}.yaml @@ -34,8 +34,15 @@ delete: responses: '204': description: Email message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml patch: x-products: - Users @@ -48,6 +55,11 @@ patch: responses: '200': description: Email message accepted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -60,6 +72,8 @@ patch: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/events@{eventType}@rules.yaml b/openapi/paths/events@{eventType}@rules.yaml index 65794d467a..6a7f189674 100644 --- a/openapi/paths/events@{eventType}@rules.yaml +++ b/openapi/paths/events@{eventType}@rules.yaml @@ -38,6 +38,11 @@ put: responses: '200': description: Rules updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -50,6 +55,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/RuleSet.yaml x-codeSamples: diff --git a/openapi/paths/events@{eventType}@rules@drafts.yaml b/openapi/paths/events@{eventType}@rules@drafts.yaml index c5ac9db041..3af72a2012 100644 --- a/openapi/paths/events@{eventType}@rules@drafts.yaml +++ b/openapi/paths/events@{eventType}@rules@drafts.yaml @@ -55,6 +55,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,5 +71,7 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/RuleSetDraft.yaml diff --git a/openapi/paths/events@{eventType}@rules@drafts@{id}.yaml b/openapi/paths/events@{eventType}@rules@drafts@{id}.yaml index 7bccddf3ec..6907344906 100644 --- a/openapi/paths/events@{eventType}@rules@drafts@{id}.yaml +++ b/openapi/paths/events@{eventType}@rules@drafts@{id}.yaml @@ -37,10 +37,17 @@ delete: responses: '204': description: Draft ruleset deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml put: x-products: - Users @@ -53,6 +60,11 @@ put: responses: '200': description: Draft ruleset updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -62,6 +74,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -74,5 +90,7 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/RuleSetDraft.yaml diff --git a/openapi/paths/events@{eventType}@timeline.yaml b/openapi/paths/events@{eventType}@timeline.yaml index 7ccc5ba17f..8c93fe1988 100644 --- a/openapi/paths/events@{eventType}@timeline.yaml +++ b/openapi/paths/events@{eventType}@timeline.yaml @@ -57,6 +57,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,3 +71,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/events@{eventType}@timeline@{messageId}.yaml b/openapi/paths/events@{eventType}@timeline@{messageId}.yaml index 6e4ded8853..f79530e879 100644 --- a/openapi/paths/events@{eventType}@timeline@{messageId}.yaml +++ b/openapi/paths/events@{eventType}@timeline@{messageId}.yaml @@ -40,6 +40,11 @@ delete: responses: '204': description: Rules engine timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -48,3 +53,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/external-services-settings.yaml b/openapi/paths/external-services-settings.yaml index 2b4bf4cc7b..36a5afc0e6 100644 --- a/openapi/paths/external-services-settings.yaml +++ b/openapi/paths/external-services-settings.yaml @@ -36,6 +36,11 @@ put: responses: '200': description: External service settings updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -46,3 +51,5 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/fees.yaml b/openapi/paths/fees.yaml index f9b8894bc9..dea98a3ef5 100644 --- a/openapi/paths/fees.yaml +++ b/openapi/paths/fees.yaml @@ -68,6 +68,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -85,3 +89,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/fees@{id}.yaml b/openapi/paths/fees@{id}.yaml index d95e2ce1bd..1fc2917f49 100644 --- a/openapi/paths/fees@{id}.yaml +++ b/openapi/paths/fees@{id}.yaml @@ -78,6 +78,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -95,6 +99,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml patch: x-badges: - name: Experimental @@ -141,6 +147,8 @@ patch: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-badges: - name: Experimental @@ -157,9 +165,16 @@ delete: responses: '204': description: Fee deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/files.yaml b/openapi/paths/files.yaml index 7763f7622f..76b9f3192c 100644 --- a/openapi/paths/files.yaml +++ b/openapi/paths/files.yaml @@ -87,6 +87,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -97,6 +101,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/files@{id}.yaml b/openapi/paths/files@{id}.yaml index 39c558bae9..af4795747c 100644 --- a/openapi/paths/files@{id}.yaml +++ b/openapi/paths/files@{id}.yaml @@ -56,6 +56,11 @@ put: responses: '200': description: File updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,6 +73,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -91,12 +98,19 @@ delete: responses: '204': description: File deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/gateway-accounts.yaml b/openapi/paths/gateway-accounts.yaml index 096486fdab..82f5f7cdbd 100644 --- a/openapi/paths/gateway-accounts.yaml +++ b/openapi/paths/gateway-accounts.yaml @@ -62,6 +62,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -76,6 +80,8 @@ post: application/json: schema: $ref: ../components/schemas/InvalidError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/gateway-accounts@{id}.yaml b/openapi/paths/gateway-accounts@{id}.yaml index e23e7579c1..6ce6f3cc3e 100644 --- a/openapi/paths/gateway-accounts@{id}.yaml +++ b/openapi/paths/gateway-accounts@{id}.yaml @@ -47,6 +47,11 @@ put: responses: '200': description: Gateway account updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -56,6 +61,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,6 +77,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -93,6 +104,11 @@ patch: responses: '200': description: Gateway account updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -105,6 +121,8 @@ patch: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: @@ -121,6 +139,11 @@ delete: responses: '204': description: Gateway account deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -129,6 +152,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/gateway-accounts@{id}@check-credentials.yaml b/openapi/paths/gateway-accounts@{id}@check-credentials.yaml index 726724e949..1f7920a31f 100644 --- a/openapi/paths/gateway-accounts@{id}@check-credentials.yaml +++ b/openapi/paths/gateway-accounts@{id}@check-credentials.yaml @@ -12,6 +12,11 @@ post: responses: '204': description: Supplied credentials are valid. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -22,3 +27,5 @@ post: $ref: ../components/responses/Conflict.yaml '422': description: Supplied credentials are not valid. + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/gateway-accounts@{id}@close.yaml b/openapi/paths/gateway-accounts@{id}@close.yaml index 07fb6cbba2..d285213d59 100644 --- a/openapi/paths/gateway-accounts@{id}@close.yaml +++ b/openapi/paths/gateway-accounts@{id}@close.yaml @@ -22,6 +22,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -32,6 +36,8 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/gateway-accounts@{id}@disable.yaml b/openapi/paths/gateway-accounts@{id}@disable.yaml index e032463df7..04244f981d 100644 --- a/openapi/paths/gateway-accounts@{id}@disable.yaml +++ b/openapi/paths/gateway-accounts@{id}@disable.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -31,6 +35,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': description: Gateway account is pending activation and cannot be disabled. + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/gateway-accounts@{id}@downtime-schedules.yaml b/openapi/paths/gateway-accounts@{id}@downtime-schedules.yaml index 8d06cd18c3..c854d1e9c7 100644 --- a/openapi/paths/gateway-accounts@{id}@downtime-schedules.yaml +++ b/openapi/paths/gateway-accounts@{id}@downtime-schedules.yaml @@ -58,6 +58,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -70,6 +74,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/GatewayAccountDowntimeSchedule.yaml x-codeSamples: diff --git a/openapi/paths/gateway-accounts@{id}@downtime-schedules@{downtimeId}.yaml b/openapi/paths/gateway-accounts@{id}@downtime-schedules@{downtimeId}.yaml index 6dd6cc2c4d..0a16d095d4 100644 --- a/openapi/paths/gateway-accounts@{id}@downtime-schedules@{downtimeId}.yaml +++ b/openapi/paths/gateway-accounts@{id}@downtime-schedules@{downtimeId}.yaml @@ -45,6 +45,11 @@ put: responses: '200': description: Gateway account downtime schedule updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -59,6 +64,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/GatewayAccountDowntimeSchedule.yaml x-codeSamples: @@ -78,6 +85,11 @@ delete: responses: '204': description: Gateway account downtime schedule deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': diff --git a/openapi/paths/gateway-accounts@{id}@enable.yaml b/openapi/paths/gateway-accounts@{id}@enable.yaml index 0a52954f00..162b180cd6 100644 --- a/openapi/paths/gateway-accounts@{id}@enable.yaml +++ b/openapi/paths/gateway-accounts@{id}@enable.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -31,6 +35,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': description: Gateway account is pending activation and cannot be enabled. + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/gateway-accounts@{id}@financial-settings.yaml b/openapi/paths/gateway-accounts@{id}@financial-settings.yaml index 1d4c167cd6..30d80e25c5 100644 --- a/openapi/paths/gateway-accounts@{id}@financial-settings.yaml +++ b/openapi/paths/gateway-accounts@{id}@financial-settings.yaml @@ -50,6 +50,11 @@ put: responses: '200': description: Gateway account financial settings updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -59,6 +64,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,3 +80,5 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/gateway-accounts@{id}@limits@{limitId}.yaml b/openapi/paths/gateway-accounts@{id}@limits@{limitId}.yaml index e32b31905f..80702c935d 100644 --- a/openapi/paths/gateway-accounts@{id}@limits@{limitId}.yaml +++ b/openapi/paths/gateway-accounts@{id}@limits@{limitId}.yaml @@ -54,6 +54,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,6 +72,8 @@ put: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -85,6 +91,11 @@ delete: responses: '204': description: Gateway account limit deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': diff --git a/openapi/paths/gateway-accounts@{id}@timeline.yaml b/openapi/paths/gateway-accounts@{id}@timeline.yaml index a58cfb83de..ab99254d95 100644 --- a/openapi/paths/gateway-accounts@{id}@timeline.yaml +++ b/openapi/paths/gateway-accounts@{id}@timeline.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/gateway-accounts@{id}@timeline@{messageId}.yaml b/openapi/paths/gateway-accounts@{id}@timeline@{messageId}.yaml index 4d3e1d6cab..79dc7f9148 100644 --- a/openapi/paths/gateway-accounts@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/gateway-accounts@{id}@timeline@{messageId}.yaml @@ -45,6 +45,11 @@ delete: responses: '204': description: Gateway account timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -53,6 +58,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/grid-segments.yaml b/openapi/paths/grid-segments.yaml index b88681932a..723d65b1e8 100644 --- a/openapi/paths/grid-segments.yaml +++ b/openapi/paths/grid-segments.yaml @@ -46,6 +46,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -54,5 +58,7 @@ post: $ref: ../components/responses/ValidationError.yaml '403': $ref: ../components/responses/Forbidden.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: $ref: ../components/requestBodies/GridSegment.yaml diff --git a/openapi/paths/grid-segments@{id}.yaml b/openapi/paths/grid-segments@{id}.yaml index e89a7a7ae3..aeb1e2844f 100644 --- a/openapi/paths/grid-segments@{id}.yaml +++ b/openapi/paths/grid-segments@{id}.yaml @@ -39,6 +39,11 @@ put: responses: '200': description: Segment updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -49,6 +54,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -70,7 +77,14 @@ delete: responses: '204': description: Segment deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml index 8315ad1f68..ff849d4d6c 100644 --- a/openapi/paths/invoices.yaml +++ b/openapi/paths/invoices.yaml @@ -66,6 +66,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -76,6 +80,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/invoices@{id}.yaml b/openapi/paths/invoices@{id}.yaml index accd92e895..469d3fc622 100644 --- a/openapi/paths/invoices@{id}.yaml +++ b/openapi/paths/invoices@{id}.yaml @@ -57,6 +57,11 @@ put: responses: '200': description: Invoice updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +71,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -78,6 +87,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/invoices@{id}@abandon.yaml b/openapi/paths/invoices@{id}@abandon.yaml index c5e5a12831..7a47ed0685 100644 --- a/openapi/paths/invoices@{id}@abandon.yaml +++ b/openapi/paths/invoices@{id}@abandon.yaml @@ -15,6 +15,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -25,6 +29,8 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/invoices@{id}@issue.yaml b/openapi/paths/invoices@{id}@issue.yaml index e091833efd..cab27f9c94 100644 --- a/openapi/paths/invoices@{id}@issue.yaml +++ b/openapi/paths/invoices@{id}@issue.yaml @@ -24,6 +24,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,6 +40,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/invoices@{id}@items.yaml b/openapi/paths/invoices@{id}@items.yaml index 1cca566225..b561001343 100644 --- a/openapi/paths/invoices@{id}@items.yaml +++ b/openapi/paths/invoices@{id}@items.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -69,6 +73,8 @@ post: $ref: ../components/responses/Unauthorized.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/invoices@{id}@items@{itemId}.yaml b/openapi/paths/invoices@{id}@items@{itemId}.yaml index aeb7391fc4..3b37f6d33e 100644 --- a/openapi/paths/invoices@{id}@items@{itemId}.yaml +++ b/openapi/paths/invoices@{id}@items@{itemId}.yaml @@ -56,6 +56,11 @@ put: responses: '200': description: Invoice item updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -64,6 +69,8 @@ put: $ref: ../components/responses/Unauthorized.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -87,10 +94,17 @@ delete: responses: '204': description: Invoice item deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/invoices@{id}@recalculate.yaml b/openapi/paths/invoices@{id}@recalculate.yaml index 96b7950d30..b80316a171 100644 --- a/openapi/paths/invoices@{id}@recalculate.yaml +++ b/openapi/paths/invoices@{id}@recalculate.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -31,6 +35,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/invoices@{id}@reissue.yaml b/openapi/paths/invoices@{id}@reissue.yaml index 92528b6ad8..b7be79fea2 100644 --- a/openapi/paths/invoices@{id}@reissue.yaml +++ b/openapi/paths/invoices@{id}@reissue.yaml @@ -24,6 +24,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,6 +40,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/invoices@{id}@timeline.yaml b/openapi/paths/invoices@{id}@timeline.yaml index b5d4b192e2..92fb28e3f3 100644 --- a/openapi/paths/invoices@{id}@timeline.yaml +++ b/openapi/paths/invoices@{id}@timeline.yaml @@ -64,6 +64,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -74,6 +78,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/invoices@{id}@timeline@{messageId}.yaml b/openapi/paths/invoices@{id}@timeline@{messageId}.yaml index c7cd0ec73e..e3d7a5a2da 100644 --- a/openapi/paths/invoices@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/invoices@{id}@timeline@{messageId}.yaml @@ -47,6 +47,11 @@ delete: responses: '204': description: Invoice timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -55,6 +60,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/invoices@{id}@transaction.yaml b/openapi/paths/invoices@{id}@transaction.yaml index 7890d84e20..1f98896552 100644 --- a/openapi/paths/invoices@{id}@transaction.yaml +++ b/openapi/paths/invoices@{id}@transaction.yaml @@ -21,6 +21,11 @@ post: responses: '200': description: Transaction applied to invoice. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -33,6 +38,8 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/invoices@{id}@void.yaml b/openapi/paths/invoices@{id}@void.yaml index 0d2a8214fd..4ce143dd37 100644 --- a/openapi/paths/invoices@{id}@void.yaml +++ b/openapi/paths/invoices@{id}@void.yaml @@ -15,6 +15,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -25,6 +29,8 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/journal-accounts.yaml b/openapi/paths/journal-accounts.yaml index 8c3aa30de1..1be7973d76 100644 --- a/openapi/paths/journal-accounts.yaml +++ b/openapi/paths/journal-accounts.yaml @@ -54,6 +54,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -64,3 +68,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/journal-accounts@{id}.yaml b/openapi/paths/journal-accounts@{id}.yaml index c4270ae87a..cdf1268ff0 100644 --- a/openapi/paths/journal-accounts@{id}.yaml +++ b/openapi/paths/journal-accounts@{id}.yaml @@ -41,6 +41,11 @@ put: responses: '200': description: Journal account updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -50,6 +55,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -62,3 +71,5 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/journal-entries.yaml b/openapi/paths/journal-entries.yaml index 1b76ec7922..f6110ae46e 100644 --- a/openapi/paths/journal-entries.yaml +++ b/openapi/paths/journal-entries.yaml @@ -54,6 +54,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -64,3 +68,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/journal-entries@{id}.yaml b/openapi/paths/journal-entries@{id}.yaml index c73ba49386..fde795824d 100644 --- a/openapi/paths/journal-entries@{id}.yaml +++ b/openapi/paths/journal-entries@{id}.yaml @@ -41,6 +41,11 @@ put: responses: '200': description: Journal entry updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -50,6 +55,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -62,3 +71,5 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/journal-entries@{id}@records.yaml b/openapi/paths/journal-entries@{id}@records.yaml index 974b9aa722..941596174f 100644 --- a/openapi/paths/journal-entries@{id}@records.yaml +++ b/openapi/paths/journal-entries@{id}@records.yaml @@ -57,6 +57,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,3 +71,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/journal-entries@{id}@records@{journalRecordId}.yaml b/openapi/paths/journal-entries@{id}@records@{journalRecordId}.yaml index ef2e1be25e..0678af2d84 100644 --- a/openapi/paths/journal-entries@{id}@records@{journalRecordId}.yaml +++ b/openapi/paths/journal-entries@{id}@records@{journalRecordId}.yaml @@ -42,6 +42,11 @@ put: responses: '200': description: Journal record updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -51,6 +56,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -63,6 +72,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -75,6 +86,11 @@ delete: responses: '204': description: Journal record deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -83,3 +99,5 @@ delete: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/kyc-documents.yaml b/openapi/paths/kyc-documents.yaml index 356313d4fb..34cb3ec43e 100644 --- a/openapi/paths/kyc-documents.yaml +++ b/openapi/paths/kyc-documents.yaml @@ -59,6 +59,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -69,6 +73,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/kyc-documents@{id}.yaml b/openapi/paths/kyc-documents@{id}.yaml index 7f38b2b29a..c4a2c2a082 100644 --- a/openapi/paths/kyc-documents@{id}.yaml +++ b/openapi/paths/kyc-documents@{id}.yaml @@ -45,6 +45,11 @@ put: responses: '200': description: KYC document updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -54,6 +59,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +75,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/kyc-documents@{id}@acceptance.yaml b/openapi/paths/kyc-documents@{id}@acceptance.yaml index 1cc758277d..10a178bdb2 100644 --- a/openapi/paths/kyc-documents@{id}@acceptance.yaml +++ b/openapi/paths/kyc-documents@{id}@acceptance.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -29,6 +33,8 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/kyc-documents@{id}@matches.yaml b/openapi/paths/kyc-documents@{id}@matches.yaml index 0f3b0fa2b2..cf9f94efa9 100644 --- a/openapi/paths/kyc-documents@{id}@matches.yaml +++ b/openapi/paths/kyc-documents@{id}@matches.yaml @@ -24,9 +24,16 @@ post: responses: '204': description: Document matches updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/kyc-documents@{id}@rejection.yaml b/openapi/paths/kyc-documents@{id}@rejection.yaml index 2b533cedee..68ec745d27 100644 --- a/openapi/paths/kyc-documents@{id}@rejection.yaml +++ b/openapi/paths/kyc-documents@{id}@rejection.yaml @@ -26,6 +26,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -38,6 +42,8 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/kyc-documents@{id}@review.yaml b/openapi/paths/kyc-documents@{id}@review.yaml index 14a98f99c9..8f8ed27b12 100644 --- a/openapi/paths/kyc-documents@{id}@review.yaml +++ b/openapi/paths/kyc-documents@{id}@review.yaml @@ -16,6 +16,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -28,6 +32,8 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/kyc-documents@{id}@start-review.yaml b/openapi/paths/kyc-documents@{id}@start-review.yaml index 49bc686905..230d376440 100644 --- a/openapi/paths/kyc-documents@{id}@start-review.yaml +++ b/openapi/paths/kyc-documents@{id}@start-review.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -31,3 +35,5 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/kyc-documents@{id}@stop-review.yaml b/openapi/paths/kyc-documents@{id}@stop-review.yaml index 1facb445ce..d9bf816893 100644 --- a/openapi/paths/kyc-documents@{id}@stop-review.yaml +++ b/openapi/paths/kyc-documents@{id}@stop-review.yaml @@ -20,6 +20,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -32,3 +36,5 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/kyc-requests.yaml b/openapi/paths/kyc-requests.yaml index 951dbe8395..894513fe29 100644 --- a/openapi/paths/kyc-requests.yaml +++ b/openapi/paths/kyc-requests.yaml @@ -70,6 +70,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -80,6 +84,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml get: x-products: - Core diff --git a/openapi/paths/kyc-requests@{id}.yaml b/openapi/paths/kyc-requests@{id}.yaml index 9ae83076db..42bdf8b433 100644 --- a/openapi/paths/kyc-requests@{id}.yaml +++ b/openapi/paths/kyc-requests@{id}.yaml @@ -38,6 +38,11 @@ patch: responses: '200': description: KYC request updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -50,6 +55,8 @@ patch: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -62,7 +69,14 @@ delete: responses: '204': description: KYC request deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/kyc-settings.yaml b/openapi/paths/kyc-settings.yaml index b3d335ebd4..c1bfa57de3 100644 --- a/openapi/paths/kyc-settings.yaml +++ b/openapi/paths/kyc-settings.yaml @@ -39,6 +39,11 @@ put: responses: '200': description: KYC settings updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -49,3 +54,5 @@ put: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/lists.yaml b/openapi/paths/lists.yaml index e6af9fdf39..f5c9e506bd 100644 --- a/openapi/paths/lists.yaml +++ b/openapi/paths/lists.yaml @@ -55,6 +55,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -65,6 +69,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: diff --git a/openapi/paths/lists@{id}.yaml b/openapi/paths/lists@{id}.yaml index c2203c5102..77565d096a 100644 --- a/openapi/paths/lists@{id}.yaml +++ b/openapi/paths/lists@{id}.yaml @@ -45,6 +45,11 @@ put: responses: '200': description: List updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -54,6 +59,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +75,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: @@ -82,6 +93,11 @@ delete: responses: '204': description: List deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -90,6 +106,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': description: Specified list is in use in a rule and cannot be deleted. + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/memberships@{organizationId}@{userId}.yaml b/openapi/paths/memberships@{organizationId}@{userId}.yaml index d6664e395b..7f12863b55 100644 --- a/openapi/paths/memberships@{organizationId}@{userId}.yaml +++ b/openapi/paths/memberships@{organizationId}@{userId}.yaml @@ -56,6 +56,11 @@ put: responses: '200': description: Membership updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -65,6 +70,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -75,6 +84,8 @@ put: $ref: ../components/responses/Forbidden.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Users @@ -87,6 +98,11 @@ delete: responses: '204': description: Membership deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -95,3 +111,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/organization-exports.yaml b/openapi/paths/organization-exports.yaml index e9f15d7109..82bcc19d25 100644 --- a/openapi/paths/organization-exports.yaml +++ b/openapi/paths/organization-exports.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,3 +75,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/organizations.yaml b/openapi/paths/organizations.yaml index ad201376ae..63e8c1f314 100644 --- a/openapi/paths/organizations.yaml +++ b/openapi/paths/organizations.yaml @@ -50,6 +50,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -62,6 +66,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/organizations@{id}.yaml b/openapi/paths/organizations@{id}.yaml index 352c0f3c86..21733e02f7 100644 --- a/openapi/paths/organizations@{id}.yaml +++ b/openapi/paths/organizations@{id}.yaml @@ -44,6 +44,11 @@ patch: responses: '200': description: Organization updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -54,6 +59,8 @@ patch: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/password-tokens.yaml b/openapi/paths/password-tokens.yaml index 6d0529eee9..84a1036508 100644 --- a/openapi/paths/password-tokens.yaml +++ b/openapi/paths/password-tokens.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/password-tokens@{id}.yaml b/openapi/paths/password-tokens@{id}.yaml index 96aab07c2c..02af8bccd9 100644 --- a/openapi/paths/password-tokens@{id}.yaml +++ b/openapi/paths/password-tokens@{id}.yaml @@ -41,6 +41,11 @@ delete: responses: '204': description: Reset password token deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -49,6 +54,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/payment-instruments.yaml b/openapi/paths/payment-instruments.yaml index 426bdab624..6d0a0d653a 100644 --- a/openapi/paths/payment-instruments.yaml +++ b/openapi/paths/payment-instruments.yaml @@ -64,6 +64,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -73,6 +77,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -83,6 +91,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/payment-instruments@{id}.yaml b/openapi/paths/payment-instruments@{id}.yaml index f083f63e50..aece3fe318 100644 --- a/openapi/paths/payment-instruments@{id}.yaml +++ b/openapi/paths/payment-instruments@{id}.yaml @@ -47,6 +47,11 @@ patch: responses: '200': description: Payment instrument updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -59,6 +64,8 @@ patch: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/payment-instruments@{id}@deactivation.yaml b/openapi/paths/payment-instruments@{id}@deactivation.yaml index 094b65eb34..40ed2e69ba 100644 --- a/openapi/paths/payment-instruments@{id}@deactivation.yaml +++ b/openapi/paths/payment-instruments@{id}@deactivation.yaml @@ -15,6 +15,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -27,6 +31,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/payout-requests.yaml b/openapi/paths/payout-requests.yaml index 9d4187c7aa..5434512659 100644 --- a/openapi/paths/payout-requests.yaml +++ b/openapi/paths/payout-requests.yaml @@ -57,6 +57,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -67,3 +71,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/payout-requests@{id}.yaml b/openapi/paths/payout-requests@{id}.yaml index c41cf6b06a..20b1f4f6c1 100644 --- a/openapi/paths/payout-requests@{id}.yaml +++ b/openapi/paths/payout-requests@{id}.yaml @@ -10,17 +10,17 @@ get: x-sdk-operation-name: get description: Retrieves a payout request with a specified ID. responses: - 200: + '200': description: Payout request retrieved. content: application/json: schema: $ref: ../components/schemas/PayoutRequest.yaml - 401: + '401': $ref: ../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../components/responses/Forbidden.yaml - 404: + '404': $ref: ../components/responses/NotFound.yaml put: x-products: @@ -39,6 +39,11 @@ put: responses: '200': description: Payout request updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -48,6 +53,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -60,3 +69,5 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/payout-requests@{id}@cancel.yaml b/openapi/paths/payout-requests@{id}@cancel.yaml index 3a299a9345..46f11576bd 100644 --- a/openapi/paths/payout-requests@{id}@cancel.yaml +++ b/openapi/paths/payout-requests@{id}@cancel.yaml @@ -22,6 +22,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,3 +40,5 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/payout-requests@{id}@payment-instruments.yaml b/openapi/paths/payout-requests@{id}@payment-instruments.yaml index 28971dca9e..4faaef56a2 100644 --- a/openapi/paths/payout-requests@{id}@payment-instruments.yaml +++ b/openapi/paths/payout-requests@{id}@payment-instruments.yaml @@ -10,7 +10,7 @@ get: x-sdk-operation-name: getPaymentInstruments description: Retrieves the payment gateway and a list of payment instruments that are associated with a payout request with a specified ID. responses: - 200: + '200': description: Payout request associated payment instruments retrieved. content: application/json: @@ -52,9 +52,9 @@ get: description: Date and time when the last payout is created for the gateway and the payment instrument. type: string format: date-time - 401: + '401': $ref: ../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../components/responses/Forbidden.yaml - 404: + '404': $ref: ../components/responses/NotFound.yaml diff --git a/openapi/paths/payouts.yaml b/openapi/paths/payouts.yaml index 0d8f786f48..1a76ebab3d 100644 --- a/openapi/paths/payouts.yaml +++ b/openapi/paths/payouts.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -31,3 +35,5 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/permissions-emulation.yaml b/openapi/paths/permissions-emulation.yaml index 292bc25349..14f247319e 100644 --- a/openapi/paths/permissions-emulation.yaml +++ b/openapi/paths/permissions-emulation.yaml @@ -31,6 +31,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -41,6 +45,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Users @@ -60,6 +66,10 @@ delete: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,3 +78,5 @@ delete: $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/plans.yaml b/openapi/paths/plans.yaml index 341cc7fef3..c284bcf064 100644 --- a/openapi/paths/plans.yaml +++ b/openapi/paths/plans.yaml @@ -70,6 +70,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -80,6 +84,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/plans@{id}.yaml b/openapi/paths/plans@{id}.yaml index 6754acc8f2..80289c74d8 100644 --- a/openapi/paths/plans@{id}.yaml +++ b/openapi/paths/plans@{id}.yaml @@ -56,6 +56,11 @@ put: responses: '200': description: Plan updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -65,6 +70,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -77,6 +86,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -100,12 +111,19 @@ delete: responses: '204': description: Plan deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '404': $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/previews@orders.yaml b/openapi/paths/previews@orders.yaml index 3a1209d12f..f9096bfd23 100644 --- a/openapi/paths/previews@orders.yaml +++ b/openapi/paths/previews@orders.yaml @@ -15,15 +15,22 @@ post: schema: $ref: ../components/schemas/OrderPreview.yaml responses: - 200: + '200': description: Order preview retrieved. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../components/schemas/OrderPreview.yaml - 401: + '401': $ref: ../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../components/responses/Forbidden.yaml - 422: + '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/previews@rule-actions@send-email.yaml b/openapi/paths/previews@rule-actions@send-email.yaml index aa860a4eda..fc21e0f486 100644 --- a/openapi/paths/previews@rule-actions@send-email.yaml +++ b/openapi/paths/previews@rule-actions@send-email.yaml @@ -18,6 +18,11 @@ post: responses: '200': description: Test email sent. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -29,6 +34,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/previews@webhooks.yaml b/openapi/paths/previews@webhooks.yaml index 31fb24e758..8bcf6a292a 100644 --- a/openapi/paths/previews@webhooks.yaml +++ b/openapi/paths/previews@webhooks.yaml @@ -12,6 +12,11 @@ post: responses: '204': description: Test webhook triggered. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -22,6 +27,8 @@ post: application/json: schema: $ref: ../components/schemas/InvalidError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index a3e5add9c7..6282446d84 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/products@{id}.yaml b/openapi/paths/products@{id}.yaml index 9715a848f1..06bd32bd57 100644 --- a/openapi/paths/products@{id}.yaml +++ b/openapi/paths/products@{id}.yaml @@ -47,6 +47,11 @@ put: responses: '200': description: Product updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -56,6 +61,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +75,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: @@ -91,6 +102,8 @@ delete: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/profile.yaml b/openapi/paths/profile.yaml index 0cc46b8279..bf535acc76 100644 --- a/openapi/paths/profile.yaml +++ b/openapi/paths/profile.yaml @@ -43,6 +43,11 @@ put: responses: '200': description: Profile updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -55,6 +60,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/profile@mfa.yaml b/openapi/paths/profile@mfa.yaml index b46f6e5ac8..acfd35c83c 100644 --- a/openapi/paths/profile@mfa.yaml +++ b/openapi/paths/profile@mfa.yaml @@ -42,6 +42,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -52,6 +56,8 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: @@ -71,12 +77,19 @@ delete: responses: '204': description: User MFA deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/quotes.yaml b/openapi/paths/quotes.yaml index 6246b90810..8a0aa95771 100644 --- a/openapi/paths/quotes.yaml +++ b/openapi/paths/quotes.yaml @@ -58,6 +58,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,3 +72,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}.yaml b/openapi/paths/quotes@{id}.yaml index fc30fdb6c3..bd073bf7e8 100644 --- a/openapi/paths/quotes@{id}.yaml +++ b/openapi/paths/quotes@{id}.yaml @@ -53,6 +53,11 @@ put: responses: '200': description: Quote updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -62,6 +67,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -74,6 +83,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml patch: x-badges: - name: Experimental @@ -97,6 +108,11 @@ patch: responses: '200': description: Quote updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -109,3 +125,5 @@ patch: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@accept.yaml b/openapi/paths/quotes@{id}@accept.yaml index 9da5a8d0b5..ad6b4ada9f 100644 --- a/openapi/paths/quotes@{id}@accept.yaml +++ b/openapi/paths/quotes@{id}@accept.yaml @@ -14,6 +14,11 @@ post: responses: '200': description: Quote accepted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -26,3 +31,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@cancel.yaml b/openapi/paths/quotes@{id}@cancel.yaml index 00b6ab81b3..9b967275fb 100644 --- a/openapi/paths/quotes@{id}@cancel.yaml +++ b/openapi/paths/quotes@{id}@cancel.yaml @@ -14,6 +14,11 @@ post: responses: '200': description: Quote canceled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -26,3 +31,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@issue.yaml b/openapi/paths/quotes@{id}@issue.yaml index bc4aa278c5..ba61a3801b 100644 --- a/openapi/paths/quotes@{id}@issue.yaml +++ b/openapi/paths/quotes@{id}@issue.yaml @@ -14,6 +14,11 @@ post: responses: '200': description: Quote issued. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -26,3 +31,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@recall.yaml b/openapi/paths/quotes@{id}@recall.yaml index 606fe9f6eb..341aa82a20 100644 --- a/openapi/paths/quotes@{id}@recall.yaml +++ b/openapi/paths/quotes@{id}@recall.yaml @@ -16,6 +16,11 @@ post: responses: '200': description: Quote recalled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -28,3 +33,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@reject.yaml b/openapi/paths/quotes@{id}@reject.yaml index 8cf21b4c3c..ab778566f2 100644 --- a/openapi/paths/quotes@{id}@reject.yaml +++ b/openapi/paths/quotes@{id}@reject.yaml @@ -14,6 +14,11 @@ post: responses: '200': description: Quote rejected. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -26,3 +31,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@timeline.yaml b/openapi/paths/quotes@{id}@timeline.yaml index e29b536a3e..9e4b0d25fd 100644 --- a/openapi/paths/quotes@{id}@timeline.yaml +++ b/openapi/paths/quotes@{id}@timeline.yaml @@ -62,6 +62,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -72,3 +76,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/quotes@{id}@timeline@{messageId}.yaml b/openapi/paths/quotes@{id}@timeline@{messageId}.yaml index c7d48d0859..1ce9c34670 100644 --- a/openapi/paths/quotes@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/quotes@{id}@timeline@{messageId}.yaml @@ -44,6 +44,11 @@ delete: responses: '204': description: Quote timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -52,3 +57,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/ready-to-pay.yaml b/openapi/paths/ready-to-pay.yaml index f13a891477..42a558c80d 100644 --- a/openapi/paths/ready-to-pay.yaml +++ b/openapi/paths/ready-to-pay.yaml @@ -24,20 +24,27 @@ post: schema: $ref: ../components/requestBodies/PostReadyToPay.yaml responses: - 200: + '200': description: Payment methods retrieved. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: type: array items: $ref: ../components/schemas/ReadyToPayMethods.yaml - 401: + '401': $ref: ../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../components/responses/Forbidden.yaml - 422: + '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/risk-score-rules.yaml b/openapi/paths/risk-score-rules.yaml index 9fe8291a86..aa45d699c6 100644 --- a/openapi/paths/risk-score-rules.yaml +++ b/openapi/paths/risk-score-rules.yaml @@ -40,6 +40,11 @@ put: responses: '200': description: Risk score rules set. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -49,6 +54,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -59,3 +68,5 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/risk-score-rules@blocklists.yaml b/openapi/paths/risk-score-rules@blocklists.yaml index b43d4ce51c..0d1ea5935b 100644 --- a/openapi/paths/risk-score-rules@blocklists.yaml +++ b/openapi/paths/risk-score-rules@blocklists.yaml @@ -40,6 +40,11 @@ put: responses: '200': description: Risk score blocklist rules set. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -49,6 +54,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -59,3 +68,5 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/roles.yaml b/openapi/paths/roles.yaml index e7822b9c47..23b451d575 100644 --- a/openapi/paths/roles.yaml +++ b/openapi/paths/roles.yaml @@ -56,6 +56,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,3 +70,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/roles@{id}.yaml b/openapi/paths/roles@{id}.yaml index 93fb3a7187..685060987a 100644 --- a/openapi/paths/roles@{id}.yaml +++ b/openapi/paths/roles@{id}.yaml @@ -36,6 +36,11 @@ put: responses: '200': description: Role updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -45,6 +50,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -55,6 +64,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -80,3 +91,5 @@ delete: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/service-credentials@{type}.yaml b/openapi/paths/service-credentials@{type}.yaml index be5bf295fd..307e34c8ac 100644 --- a/openapi/paths/service-credentials@{type}.yaml +++ b/openapi/paths/service-credentials@{type}.yaml @@ -18,6 +18,11 @@ get: responses: '200': description: List of service credentials retrieved. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -51,6 +56,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -60,6 +69,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -70,13 +83,15 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: schema: $ref: ../components/schemas/ServiceCredential.yaml description: Service credential resource. - required: true + required: true x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/service-credentials@{type}@{id}.yaml b/openapi/paths/service-credentials@{type}@{id}.yaml index 381b3358bd..5f2f11ecf5 100644 --- a/openapi/paths/service-credentials@{type}@{id}.yaml +++ b/openapi/paths/service-credentials@{type}@{id}.yaml @@ -41,6 +41,11 @@ patch: responses: '200': description: Service credential updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -53,6 +58,8 @@ patch: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/shipping-rates.yaml b/openapi/paths/shipping-rates.yaml index 6147ef6096..1aa505cfba 100644 --- a/openapi/paths/shipping-rates.yaml +++ b/openapi/paths/shipping-rates.yaml @@ -59,6 +59,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -69,6 +73,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/shipping-rates@{id}.yaml b/openapi/paths/shipping-rates@{id}.yaml index 81f1ad5eb1..314dab2ac9 100644 --- a/openapi/paths/shipping-rates@{id}.yaml +++ b/openapi/paths/shipping-rates@{id}.yaml @@ -38,6 +38,11 @@ put: responses: '200': description: Shipping rate updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -47,6 +52,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -57,6 +66,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -80,12 +91,19 @@ delete: responses: '204': description: Shipping rate deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/storefront/account.yaml b/openapi/paths/storefront/account.yaml index 267dd5322f..bd9866a4a7 100644 --- a/openapi/paths/storefront/account.yaml +++ b/openapi/paths/storefront/account.yaml @@ -12,15 +12,15 @@ get: parameters: - $ref: ../../components/parameters/collectionExpand.yaml responses: - 200: + '200': description: Account retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontAccount.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml patch: x-products: @@ -40,15 +40,22 @@ patch: allOf: - $ref: ../../components/schemas/StorefrontAccount.yaml responses: - 200: + '200': description: Account updated. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontAccount.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/account@forgot-password.yaml b/openapi/paths/storefront/account@forgot-password.yaml index 8a31081b4f..b70dff1b22 100644 --- a/openapi/paths/storefront/account@forgot-password.yaml +++ b/openapi/paths/storefront/account@forgot-password.yaml @@ -21,11 +21,18 @@ post: description: Username of the account to which a verification email is sent. type: string responses: - 204: + '204': description: Email sent. - 401: + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/account@password.yaml b/openapi/paths/storefront/account@password.yaml index 6201960bf9..88cd383eb4 100644 --- a/openapi/paths/storefront/account@password.yaml +++ b/openapi/paths/storefront/account@password.yaml @@ -12,15 +12,22 @@ patch: requestBody: $ref: ../../components/requestBodies/storefront/PatchAccountPassword.yaml responses: - 200: + '200': description: Account password updated. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontAccount.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/account@resend-verification.yaml b/openapi/paths/storefront/account@resend-verification.yaml index f7dc77a973..7b79494e44 100644 --- a/openapi/paths/storefront/account@resend-verification.yaml +++ b/openapi/paths/storefront/account@resend-verification.yaml @@ -21,11 +21,18 @@ post: description: Username of the account to which a verification email is sent. type: string responses: - 204: + '204': description: Email sent. - 401: + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/account@reset-password@{token}.yaml b/openapi/paths/storefront/account@reset-password@{token}.yaml index 3c2ed919aa..b2e91cb179 100644 --- a/openapi/paths/storefront/account@reset-password@{token}.yaml +++ b/openapi/paths/storefront/account@reset-password@{token}.yaml @@ -24,18 +24,24 @@ post: example: 'newP@$$w0rd' description: New user account password. responses: - 201: + '201': description: Password reset. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontAccount.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/account@verification@{token}.yaml b/openapi/paths/storefront/account@verification@{token}.yaml index a575572854..1f65b24244 100644 --- a/openapi/paths/storefront/account@verification@{token}.yaml +++ b/openapi/paths/storefront/account@verification@{token}.yaml @@ -12,11 +12,18 @@ post: - PublishableApiKey: [] description: Verifies an account email. responses: - 204: + '204': description: Account verified. - 401: + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/deposit.yaml b/openapi/paths/storefront/deposit.yaml index 450a882384..95d13fb007 100644 --- a/openapi/paths/storefront/deposit.yaml +++ b/openapi/paths/storefront/deposit.yaml @@ -14,20 +14,26 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/PostDeposit.yaml responses: - 201: + '201': description: Transaction created. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/invoices.yaml b/openapi/paths/storefront/invoices.yaml index 083c3ba5bf..48321076ea 100644 --- a/openapi/paths/storefront/invoices.yaml +++ b/openapi/paths/storefront/invoices.yaml @@ -17,7 +17,7 @@ get: - $ref: ../../components/parameters/collectionQuery.yaml - $ref: ../../components/parameters/collectionExpand.yaml responses: - 200: + '200': description: Invoices retrieved. headers: Pagination-Total: @@ -32,7 +32,7 @@ get: type: array items: $ref: ../../components/schemas/StorefrontInvoice.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/invoices@{id}.yaml b/openapi/paths/storefront/invoices@{id}.yaml index d1952f1b10..e8b9fe051f 100644 --- a/openapi/paths/storefront/invoices@{id}.yaml +++ b/openapi/paths/storefront/invoices@{id}.yaml @@ -13,13 +13,13 @@ get: - CustomerJWT: [] description: Retrieves an invoice with a specified ID. responses: - 200: + '200': description: Invoice retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontInvoice.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/kyc-documents.yaml b/openapi/paths/storefront/kyc-documents.yaml index 4f44052493..65e1150468 100644 --- a/openapi/paths/storefront/kyc-documents.yaml +++ b/openapi/paths/storefront/kyc-documents.yaml @@ -13,7 +13,7 @@ get: - $ref: ../../components/parameters/collectionLimit.yaml - $ref: ../../components/parameters/collectionOffset.yaml responses: - 200: + '200': description: List of KYC documents retrieved. headers: Pagination-Total: @@ -28,9 +28,9 @@ get: type: array items: $ref: ../../components/schemas/StorefrontKycDocument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml post: x-products: @@ -51,18 +51,24 @@ post: description: KYC document resource. required: true responses: - 201: + '201': description: KYC document created. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontKycDocument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/kyc-documents@{id}.yaml b/openapi/paths/storefront/kyc-documents@{id}.yaml index 767004487a..4d9a972018 100644 --- a/openapi/paths/storefront/kyc-documents@{id}.yaml +++ b/openapi/paths/storefront/kyc-documents@{id}.yaml @@ -12,17 +12,17 @@ get: - CustomerJWT: [] description: Retrieves a KYC document with a specified ID. responses: - 200: + '200': description: KYC document retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontKycDocument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml patch: x-products: @@ -43,17 +43,24 @@ patch: description: KYC document resource. required: true responses: - 200: + '200': description: KYC document updated. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontKycDocument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/kyc-liveness-sessions.yaml b/openapi/paths/storefront/kyc-liveness-sessions.yaml index 695270055b..1cd5a7fe13 100644 --- a/openapi/paths/storefront/kyc-liveness-sessions.yaml +++ b/openapi/paths/storefront/kyc-liveness-sessions.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -29,3 +33,5 @@ post: $ref: ../../components/responses/Forbidden.yaml '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/kyc-liveness-sessions@{id}@finish.yaml b/openapi/paths/storefront/kyc-liveness-sessions@{id}@finish.yaml index df598a5967..f78d399ed1 100644 --- a/openapi/paths/storefront/kyc-liveness-sessions@{id}@finish.yaml +++ b/openapi/paths/storefront/kyc-liveness-sessions@{id}@finish.yaml @@ -17,6 +17,10 @@ post: headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -25,3 +29,5 @@ post: $ref: ../../components/responses/Unauthorized.yaml '403': $ref: ../../components/responses/Forbidden.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/kyc-requests@{id}.yaml b/openapi/paths/storefront/kyc-requests@{id}.yaml index 597ed085f1..f83f116941 100644 --- a/openapi/paths/storefront/kyc-requests@{id}.yaml +++ b/openapi/paths/storefront/kyc-requests@{id}.yaml @@ -14,15 +14,15 @@ get: parameters: - $ref: ../../components/parameters/collectionExpand.yaml responses: - 200: + '200': description: KYC request retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontKycRequest.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml diff --git a/openapi/paths/storefront/login.yaml b/openapi/paths/storefront/login.yaml index a3133ab61e..0c968df985 100644 --- a/openapi/paths/storefront/login.yaml +++ b/openapi/paths/storefront/login.yaml @@ -25,14 +25,20 @@ post: description: User's current password. type: string responses: - 201: + '201': description: Logged into account. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontCustomerJWT.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/logout.yaml b/openapi/paths/storefront/logout.yaml index 2947244126..03d36778c4 100644 --- a/openapi/paths/storefront/logout.yaml +++ b/openapi/paths/storefront/logout.yaml @@ -10,7 +10,14 @@ post: - CustomerJWT: [] description: Destroys the user's current session. responses: - 204: + '204': description: Account logged out. - 401: + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml + '401': $ref: ../../components/responses/Unauthorized.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/orders.yaml b/openapi/paths/storefront/orders.yaml index 89afb38e01..c4976cdad0 100644 --- a/openapi/paths/storefront/orders.yaml +++ b/openapi/paths/storefront/orders.yaml @@ -17,7 +17,7 @@ get: - $ref: ../../components/parameters/collectionQuery.yaml - $ref: ../../components/parameters/collectionExpand.yaml responses: - 200: + '200': description: List of orders retrieved. headers: Pagination-Total: @@ -32,7 +32,7 @@ get: type: array items: $ref: ../../components/schemas/StorefrontOrder.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/orders@{id}.yaml b/openapi/paths/storefront/orders@{id}.yaml index b3255c7d71..1e954c1946 100644 --- a/openapi/paths/storefront/orders@{id}.yaml +++ b/openapi/paths/storefront/orders@{id}.yaml @@ -14,17 +14,17 @@ get: - $ref: ../../components/parameters/collectionExpand.yaml description: Retrieve an order with a specified ID. responses: - 200: + '200': description: Order retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontOrder.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml patch: x-products: @@ -40,17 +40,24 @@ patch: requestBody: $ref: ../../components/requestBodies/storefront/PatchOrder.yaml responses: - 200: + '200': description: Order updated. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontOrder.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/orders@{id}@cancellation.yaml b/openapi/paths/storefront/orders@{id}@cancellation.yaml index 6f66729763..80e7bf4378 100644 --- a/openapi/paths/storefront/orders@{id}@cancellation.yaml +++ b/openapi/paths/storefront/orders@{id}@cancellation.yaml @@ -14,22 +14,28 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/PostOrderCancellation.yaml responses: - 201: + '201': description: Order canceled. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontOrder.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 409: + '409': $ref: ../../components/responses/Conflict.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/orders@{id}@pause.yaml b/openapi/paths/storefront/orders@{id}@pause.yaml index 198769ca0d..87a77e443f 100644 --- a/openapi/paths/storefront/orders@{id}@pause.yaml +++ b/openapi/paths/storefront/orders@{id}@pause.yaml @@ -14,22 +14,28 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/PostOrderPause.yaml responses: - 201: + '201': description: Order paused. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontOrder.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 409: + '409': $ref: ../../components/responses/Conflict.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/orders@{id}@upcoming-invoice.yaml b/openapi/paths/storefront/orders@{id}@upcoming-invoice.yaml index 3b4d588d87..1551e91040 100644 --- a/openapi/paths/storefront/orders@{id}@upcoming-invoice.yaml +++ b/openapi/paths/storefront/orders@{id}@upcoming-invoice.yaml @@ -18,15 +18,15 @@ get: It functions as a preview of the next invoice for the order. For more information, see [Invoices](https://www.rebilly.com/docs/dev-docs/invoices/). responses: - 200: + '200': description: Upcoming invoice retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontUpcomingInvoice.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml diff --git a/openapi/paths/storefront/payment-instruments.yaml b/openapi/paths/storefront/payment-instruments.yaml index 586d715cb1..1a30b80907 100644 --- a/openapi/paths/storefront/payment-instruments.yaml +++ b/openapi/paths/storefront/payment-instruments.yaml @@ -16,7 +16,7 @@ get: - $ref: ../../components/parameters/collectionOffset.yaml - $ref: ../../components/parameters/collectionQuery.yaml responses: - 200: + '200': description: List of payment instruments retrieved. headers: Pagination-Total: @@ -31,9 +31,9 @@ get: type: array items: $ref: ../../components/schemas/StorefrontPaymentInstrument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml post: x-products: @@ -55,18 +55,24 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/StorefrontPostPaymentInstrument.yaml responses: - 201: + '201': description: Payment instrument created. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontPaymentInstrument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/payment-instruments@{id}.yaml b/openapi/paths/storefront/payment-instruments@{id}.yaml index 86b44e8b16..56286e9cec 100644 --- a/openapi/paths/storefront/payment-instruments@{id}.yaml +++ b/openapi/paths/storefront/payment-instruments@{id}.yaml @@ -15,7 +15,7 @@ get: - $ref: ../../components/parameters/collectionLimit.yaml - $ref: ../../components/parameters/collectionOffset.yaml responses: - 200: + '200': description: Payment instrument retrieved. headers: Pagination-Total: @@ -28,11 +28,11 @@ get: application/json: schema: $ref: ../../components/schemas/StorefrontPaymentInstrument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml patch: x-products: @@ -52,17 +52,24 @@ patch: requestBody: $ref: ../../components/requestBodies/storefront/StorefrontPatchPaymentInstrument.yaml responses: - 200: + '200': description: Payment instrument updated. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontPaymentInstrument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/payment-instruments@{id}@deactivation.yaml b/openapi/paths/storefront/payment-instruments@{id}@deactivation.yaml index e7da429a83..ca5b90a4e1 100644 --- a/openapi/paths/storefront/payment-instruments@{id}@deactivation.yaml +++ b/openapi/paths/storefront/payment-instruments@{id}@deactivation.yaml @@ -12,23 +12,29 @@ post: - CustomerJWT: [] description: Deactivates a payment instrument with a specified ID. responses: - 201: + '201': description: Payment instrument deactivated. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontPaymentInstrument.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/storefront/payment-instruments@{id}@setup.yaml b/openapi/paths/storefront/payment-instruments@{id}@setup.yaml index e79618a736..c81e2e6bd1 100644 --- a/openapi/paths/storefront/payment-instruments@{id}@setup.yaml +++ b/openapi/paths/storefront/payment-instruments@{id}@setup.yaml @@ -15,17 +15,17 @@ get: For more information, see [Transactions](#Transactions). responses: - 200: + '200': description: Setup transaction retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml post: x-products: @@ -46,20 +46,26 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/SetupPaymentInstrumentRequest.yaml responses: - 201: + '201': description: Setup transaction created. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/payment.yaml b/openapi/paths/storefront/payment.yaml index b0f5c89696..0086481c44 100644 --- a/openapi/paths/storefront/payment.yaml +++ b/openapi/paths/storefront/payment.yaml @@ -18,28 +18,39 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/PostPayment.yaml responses: - 200: + '200': description: Transaction created. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 201: + '201': description: Transaction updated. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 409: + '409': $ref: ../../components/responses/Conflict.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/payout-requests.yaml b/openapi/paths/storefront/payout-requests.yaml index a6b75d0e31..ed021a6859 100644 --- a/openapi/paths/storefront/payout-requests.yaml +++ b/openapi/paths/storefront/payout-requests.yaml @@ -16,7 +16,7 @@ get: - $ref: ../../components/parameters/collectionOffset.yaml - $ref: ../../components/parameters/collectionQuery.yaml responses: - 200: + '200': description: List of payout requests retrieved. headers: Pagination-Total: @@ -31,7 +31,7 @@ get: type: array items: $ref: ../../components/schemas/StorefrontPayoutRequest.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/payout-requests@{id}.yaml b/openapi/paths/storefront/payout-requests@{id}.yaml index 64ed63efd8..ab65ed10fa 100644 --- a/openapi/paths/storefront/payout-requests@{id}.yaml +++ b/openapi/paths/storefront/payout-requests@{id}.yaml @@ -12,17 +12,17 @@ get: - CustomerJWT: [] description: Retrieves a payout request with a specified ID. responses: - 200: + '200': description: Payout request retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontPayoutRequest.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml patch: x-products: @@ -49,17 +49,24 @@ patch: maxLength: 50 example: inst_0YVB8KPKNXCBR9EDX7JHSED75N responses: - 200: + '200': description: Payout request updated. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontPayoutRequest.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/plans.yaml b/openapi/paths/storefront/plans.yaml index 011bd6ca98..4343b703a3 100644 --- a/openapi/paths/storefront/plans.yaml +++ b/openapi/paths/storefront/plans.yaml @@ -17,7 +17,7 @@ get: - $ref: ../../components/parameters/collectionQuery.yaml - $ref: ../../components/parameters/collectionExpand.yaml responses: - 200: + '200': description: List of plans retrieved. headers: Pagination-Total: @@ -32,7 +32,7 @@ get: type: array items: $ref: ../../components/schemas/StorefrontPlan.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/plans@{id}.yaml b/openapi/paths/storefront/plans@{id}.yaml index 55e2cda46b..1b517a86b6 100644 --- a/openapi/paths/storefront/plans@{id}.yaml +++ b/openapi/paths/storefront/plans@{id}.yaml @@ -14,15 +14,15 @@ get: parameters: - $ref: ../../components/parameters/collectionExpand.yaml responses: - 200: + '200': description: Plan retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontPlan.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml diff --git a/openapi/paths/storefront/preview-purchase.yaml b/openapi/paths/storefront/preview-purchase.yaml index 9fdc7440f3..c065d93bf9 100644 --- a/openapi/paths/storefront/preview-purchase.yaml +++ b/openapi/paths/storefront/preview-purchase.yaml @@ -26,15 +26,22 @@ post: schema: $ref: ../../components/schemas/StorefrontOrderPreview.yaml responses: - 200: + '200': description: Purchase preview retrieved. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontOrderPreview.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/products.yaml b/openapi/paths/storefront/products.yaml index a7c315c030..12ac6bb428 100644 --- a/openapi/paths/storefront/products.yaml +++ b/openapi/paths/storefront/products.yaml @@ -16,7 +16,7 @@ get: - $ref: ../../components/parameters/collectionOffset.yaml - $ref: ../../components/parameters/collectionQuery.yaml responses: - 200: + '200': description: List of products retrieved. headers: Pagination-Total: @@ -31,7 +31,7 @@ get: type: array items: $ref: ../../components/schemas/StorefrontProduct.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/products@{id}.yaml b/openapi/paths/storefront/products@{id}.yaml index e224f90f81..ab1138f8df 100644 --- a/openapi/paths/storefront/products@{id}.yaml +++ b/openapi/paths/storefront/products@{id}.yaml @@ -12,15 +12,15 @@ get: - CustomerJWT: [] description: Retrieves a product with a specified ID. responses: - 200: + '200': description: Product retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontProduct.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml diff --git a/openapi/paths/storefront/purchase.yaml b/openapi/paths/storefront/purchase.yaml index 6fe4755b8f..34b06e8bb0 100644 --- a/openapi/paths/storefront/purchase.yaml +++ b/openapi/paths/storefront/purchase.yaml @@ -23,18 +23,24 @@ post: schema: $ref: ../../components/schemas/StorefrontPurchase.yaml responses: - 201: + '201': description: Order created. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontPurchase.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/quotes@{id}@accept.yaml b/openapi/paths/storefront/quotes@{id}@accept.yaml index ea8ab9a706..ac0906a3fd 100644 --- a/openapi/paths/storefront/quotes@{id}@accept.yaml +++ b/openapi/paths/storefront/quotes@{id}@accept.yaml @@ -16,6 +16,11 @@ post: responses: '200': description: Quote accepted. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -28,3 +33,5 @@ post: $ref: ../../components/responses/NotFound.yaml '409': $ref: ../../components/responses/Conflict.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/quotes@{id}@reject.yaml b/openapi/paths/storefront/quotes@{id}@reject.yaml index c4bfee5ff5..56c0727b8a 100644 --- a/openapi/paths/storefront/quotes@{id}@reject.yaml +++ b/openapi/paths/storefront/quotes@{id}@reject.yaml @@ -16,6 +16,11 @@ post: responses: '200': description: Quote rejected. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -28,3 +33,5 @@ post: $ref: ../../components/responses/NotFound.yaml '409': $ref: ../../components/responses/Conflict.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/ready-to-pay.yaml b/openapi/paths/storefront/ready-to-pay.yaml index 5a28056e69..a8ccd28774 100644 --- a/openapi/paths/storefront/ready-to-pay.yaml +++ b/openapi/paths/storefront/ready-to-pay.yaml @@ -29,15 +29,22 @@ post: schema: $ref: ../../components/schemas/ReadyToPay.yaml responses: - 200: + '200': description: Payment methods retrieved. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/ReadyToPayMethods.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/ready-to-payout.yaml b/openapi/paths/storefront/ready-to-payout.yaml index dcd99dc0ea..ed59a768aa 100644 --- a/openapi/paths/storefront/ready-to-payout.yaml +++ b/openapi/paths/storefront/ready-to-payout.yaml @@ -26,15 +26,22 @@ post: schema: $ref: ../../components/schemas/ReadyToPayout.yaml responses: - 200: + '200': description: Payment methods retrieved. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/ReadyToPayoutMethods.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/register.yaml b/openapi/paths/storefront/register.yaml index ce3ca67b47..c66b2ff3d7 100644 --- a/openapi/paths/storefront/register.yaml +++ b/openapi/paths/storefront/register.yaml @@ -12,18 +12,24 @@ post: requestBody: $ref: ../../components/requestBodies/storefront/PostRegister.yaml responses: - 201: + '201': description: Account registered. headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontAccount.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 422: + '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/subscriptions.yaml b/openapi/paths/storefront/subscriptions.yaml index ab2bb7cad9..2def749f2d 100644 --- a/openapi/paths/storefront/subscriptions.yaml +++ b/openapi/paths/storefront/subscriptions.yaml @@ -24,6 +24,10 @@ post: headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -36,3 +40,5 @@ post: $ref: ../../components/responses/NotFound.yaml '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/subscriptions@{id}@change-items.yaml b/openapi/paths/storefront/subscriptions@{id}@change-items.yaml index 0bf32a304c..aea9ad009f 100644 --- a/openapi/paths/storefront/subscriptions@{id}@change-items.yaml +++ b/openapi/paths/storefront/subscriptions@{id}@change-items.yaml @@ -28,6 +28,10 @@ post: headers: Location: $ref: ../../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -40,3 +44,5 @@ post: $ref: ../../components/responses/NotFound.yaml '422': $ref: ../../components/responses/ValidationError.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/transactions.yaml b/openapi/paths/storefront/transactions.yaml index 5def791ca7..10546f5219 100644 --- a/openapi/paths/storefront/transactions.yaml +++ b/openapi/paths/storefront/transactions.yaml @@ -16,7 +16,7 @@ get: - $ref: ../../components/parameters/collectionQuery.yaml - $ref: ../../components/parameters/collectionSort.yaml responses: - 200: + '200': description: Transactions retrieved. headers: Pagination-Total: @@ -31,7 +31,7 @@ get: type: array items: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml diff --git a/openapi/paths/storefront/transactions@{id}.yaml b/openapi/paths/storefront/transactions@{id}.yaml index e7f7de5edd..9fce1369b7 100644 --- a/openapi/paths/storefront/transactions@{id}.yaml +++ b/openapi/paths/storefront/transactions@{id}.yaml @@ -12,15 +12,15 @@ get: - CustomerJWT: [] description: Retrieves a transaction with a specified ID. responses: - 200: + '200': description: Transaction retrieved. content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml diff --git a/openapi/paths/storefront/transactions@{id}@{token}@bypass.yaml b/openapi/paths/storefront/transactions@{id}@{token}@bypass.yaml index 6240d4db68..64c3c4d40f 100644 --- a/openapi/paths/storefront/transactions@{id}@{token}@bypass.yaml +++ b/openapi/paths/storefront/transactions@{id}@{token}@bypass.yaml @@ -16,15 +16,22 @@ post: Use this operation to skip a KYC request that has been marked as optional in a transaction flow, so that you can further process the transaction. responses: - 200: + '200': description: KYC verification skipped. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/transactions@{id}@{token}@continue.yaml b/openapi/paths/storefront/transactions@{id}@{token}@continue.yaml index aef9be7312..04865f6e73 100644 --- a/openapi/paths/storefront/transactions@{id}@{token}@continue.yaml +++ b/openapi/paths/storefront/transactions@{id}@{token}@continue.yaml @@ -16,17 +16,24 @@ post: Use this operation to process the transaction after all documents of the KYC request with a specified token have been uploaded. responses: - 200: + '200': description: KYC verification finished. + headers: + X-RateLimit-Limit: + $ref: ../../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: $ref: ../../components/schemas/StorefrontTransaction.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml - 409: + '409': $ref: ../../components/responses/Conflict.yaml + '429': + $ref: ../../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/storefront/websites@{id}.yaml b/openapi/paths/storefront/websites@{id}.yaml index cb6209a5c0..a52c3f0273 100644 --- a/openapi/paths/storefront/websites@{id}.yaml +++ b/openapi/paths/storefront/websites@{id}.yaml @@ -14,15 +14,15 @@ get: Retrieves a website with a specified ID. Use this operation to find the website name, logo, or more. responses: - 200: + '200': description: Website retrieved. content: application/json: schema: $ref: ../../components/schemas/Website.yaml - 401: + '401': $ref: ../../components/responses/Unauthorized.yaml - 403: + '403': $ref: ../../components/responses/Forbidden.yaml - 404: + '404': $ref: ../../components/responses/NotFound.yaml diff --git a/openapi/paths/subscription-cancellations.yaml b/openapi/paths/subscription-cancellations.yaml index 86f6ac6d99..6eebd8e707 100644 --- a/openapi/paths/subscription-cancellations.yaml +++ b/openapi/paths/subscription-cancellations.yaml @@ -53,6 +53,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -63,6 +67,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/subscription-cancellations@{id}.yaml b/openapi/paths/subscription-cancellations@{id}.yaml index 7d1e8a5c1b..c79d50944f 100644 --- a/openapi/paths/subscription-cancellations@{id}.yaml +++ b/openapi/paths/subscription-cancellations@{id}.yaml @@ -40,6 +40,11 @@ put: responses: '200': description: Cancellation updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -49,6 +54,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -59,6 +68,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: @@ -93,6 +104,11 @@ patch: responses: '200': description: Cancellation updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -103,6 +119,8 @@ patch: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: @@ -122,6 +140,11 @@ delete: responses: '204': description: Subscription order cancellation deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -130,6 +153,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/subscription-pauses.yaml b/openapi/paths/subscription-pauses.yaml index 592e6f237b..233660327e 100644 --- a/openapi/paths/subscription-pauses.yaml +++ b/openapi/paths/subscription-pauses.yaml @@ -54,6 +54,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -64,3 +68,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscription-pauses@{id}.yaml b/openapi/paths/subscription-pauses@{id}.yaml index 907021dccf..1683128df1 100644 --- a/openapi/paths/subscription-pauses@{id}.yaml +++ b/openapi/paths/subscription-pauses@{id}.yaml @@ -39,6 +39,11 @@ put: responses: '200': description: Pause updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -48,6 +53,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -58,6 +67,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -73,6 +84,11 @@ delete: responses: '204': description: Subscription order pause revoked or finished. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -81,3 +97,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscription-reactivations.yaml b/openapi/paths/subscription-reactivations.yaml index 2866437c83..0912f4d41a 100644 --- a/openapi/paths/subscription-reactivations.yaml +++ b/openapi/paths/subscription-reactivations.yaml @@ -60,6 +60,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -72,6 +76,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/subscriptions.yaml b/openapi/paths/subscriptions.yaml index 39a17c0c3c..7c4a8b9312 100644 --- a/openapi/paths/subscriptions.yaml +++ b/openapi/paths/subscriptions.yaml @@ -71,6 +71,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -81,6 +85,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/subscriptions@{id}.yaml b/openapi/paths/subscriptions@{id}.yaml index 944e9a43ac..bfda8359e8 100644 --- a/openapi/paths/subscriptions@{id}.yaml +++ b/openapi/paths/subscriptions@{id}.yaml @@ -55,6 +55,11 @@ put: responses: '200': description: Order updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -76,6 +81,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -99,6 +106,11 @@ delete: responses: '204': description: Pending order deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -107,6 +119,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/subscriptions@{id}@change-items.yaml b/openapi/paths/subscriptions@{id}@change-items.yaml index 763bf9c5aa..32d3242043 100644 --- a/openapi/paths/subscriptions@{id}@change-items.yaml +++ b/openapi/paths/subscriptions@{id}@change-items.yaml @@ -24,6 +24,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -34,3 +38,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscriptions@{id}@interim-invoice.yaml b/openapi/paths/subscriptions@{id}@interim-invoice.yaml index 84f4d8da3f..cc3d8cc40f 100644 --- a/openapi/paths/subscriptions@{id}@interim-invoice.yaml +++ b/openapi/paths/subscriptions@{id}@interim-invoice.yaml @@ -31,6 +31,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -41,3 +45,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscriptions@{id}@items@{itemId}.yaml b/openapi/paths/subscriptions@{id}@items@{itemId}.yaml index a5072c7b46..b4889b2371 100644 --- a/openapi/paths/subscriptions@{id}@items@{itemId}.yaml +++ b/openapi/paths/subscriptions@{id}@items@{itemId}.yaml @@ -27,6 +27,11 @@ patch: responses: '200': description: Order item updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -37,3 +42,5 @@ patch: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscriptions@{id}@timeline.yaml b/openapi/paths/subscriptions@{id}@timeline.yaml index c5a4aca402..cf47a3bf83 100644 --- a/openapi/paths/subscriptions@{id}@timeline.yaml +++ b/openapi/paths/subscriptions@{id}@timeline.yaml @@ -59,6 +59,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -69,6 +73,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/subscriptions@{id}@timeline@{messageId}.yaml b/openapi/paths/subscriptions@{id}@timeline@{messageId}.yaml index d305b8fe3b..a38061dfb9 100644 --- a/openapi/paths/subscriptions@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/subscriptions@{id}@timeline@{messageId}.yaml @@ -45,6 +45,11 @@ delete: responses: '204': description: Order timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -53,6 +58,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/subscriptions@{id}@upcoming-invoice@issue.yaml b/openapi/paths/subscriptions@{id}@upcoming-invoice@issue.yaml index a0881dca17..ee3f68bd83 100644 --- a/openapi/paths/subscriptions@{id}@upcoming-invoice@issue.yaml +++ b/openapi/paths/subscriptions@{id}@upcoming-invoice@issue.yaml @@ -22,6 +22,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -34,3 +38,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscriptions@{id}@upcoming-invoices@{invoiceId}@issue.yaml b/openapi/paths/subscriptions@{id}@upcoming-invoices@{invoiceId}@issue.yaml index 1463f38e6e..6f5c256ffa 100644 --- a/openapi/paths/subscriptions@{id}@upcoming-invoices@{invoiceId}@issue.yaml +++ b/openapi/paths/subscriptions@{id}@upcoming-invoices@{invoiceId}@issue.yaml @@ -33,6 +33,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -45,3 +49,5 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/subscriptions@{id}@void.yaml b/openapi/paths/subscriptions@{id}@void.yaml index 3350acb8fe..3e2efc7f34 100644 --- a/openapi/paths/subscriptions@{id}@void.yaml +++ b/openapi/paths/subscriptions@{id}@void.yaml @@ -15,6 +15,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -27,6 +31,8 @@ post: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/tags-rules.yaml b/openapi/paths/tags-rules.yaml index 39ff5c5027..6a7104de7d 100644 --- a/openapi/paths/tags-rules.yaml +++ b/openapi/paths/tags-rules.yaml @@ -55,6 +55,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -65,3 +69,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags-rules@{id}.yaml b/openapi/paths/tags-rules@{id}.yaml index ba6a3595df..8abe2560ce 100644 --- a/openapi/paths/tags-rules@{id}.yaml +++ b/openapi/paths/tags-rules@{id}.yaml @@ -34,6 +34,11 @@ put: responses: '200': description: Tags rule updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -43,6 +48,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -53,6 +62,8 @@ put: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml requestBody: content: application/json: @@ -72,9 +83,16 @@ delete: responses: '204': description: Tags rule deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags.yaml b/openapi/paths/tags.yaml index c26f9362ee..023d65b20a 100644 --- a/openapi/paths/tags.yaml +++ b/openapi/paths/tags.yaml @@ -54,6 +54,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +70,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP source: diff --git a/openapi/paths/tags@{tag}.yaml b/openapi/paths/tags@{tag}.yaml index f9d1750f60..2a6aa876f1 100644 --- a/openapi/paths/tags@{tag}.yaml +++ b/openapi/paths/tags@{tag}.yaml @@ -36,6 +36,11 @@ patch: responses: '200': description: Tag updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -50,6 +55,8 @@ patch: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -64,9 +71,16 @@ delete: responses: '204': description: Tag deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags@{tag}@aml-checks.yaml b/openapi/paths/tags@{tag}@aml-checks.yaml index 922886bf39..573ee5ed3b 100644 --- a/openapi/paths/tags@{tag}@aml-checks.yaml +++ b/openapi/paths/tags@{tag}@aml-checks.yaml @@ -33,12 +33,19 @@ post: responses: '204': description: AML checks tagging process has been scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -72,9 +79,16 @@ delete: responses: '204': description: AML checks untagging process has been scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml b/openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml index a6c502540b..e4179f8015 100644 --- a/openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml +++ b/openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml @@ -21,12 +21,19 @@ post: responses: '204': description: AML check tagged. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -42,9 +49,16 @@ delete: responses: '204': description: AML check untagged. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags@{tag}@customers.yaml b/openapi/paths/tags@{tag}@customers.yaml index 077c1cbcce..8c34e7be2d 100644 --- a/openapi/paths/tags@{tag}@customers.yaml +++ b/openapi/paths/tags@{tag}@customers.yaml @@ -32,12 +32,19 @@ post: responses: '204': description: Customers tagging process has been scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -70,9 +77,16 @@ delete: responses: '204': description: Customers untagging process has been scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags@{tag}@customers@{customerId}.yaml b/openapi/paths/tags@{tag}@customers@{customerId}.yaml index 69aa13458f..e8748ab874 100644 --- a/openapi/paths/tags@{tag}@customers@{customerId}.yaml +++ b/openapi/paths/tags@{tag}@customers@{customerId}.yaml @@ -13,12 +13,19 @@ post: responses: '204': description: Customer tagged. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -31,9 +38,16 @@ delete: responses: '204': description: Customer untagged. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags@{tag}@kyc-documents.yaml b/openapi/paths/tags@{tag}@kyc-documents.yaml index 139227fa2b..10b0aaa43e 100644 --- a/openapi/paths/tags@{tag}@kyc-documents.yaml +++ b/openapi/paths/tags@{tag}@kyc-documents.yaml @@ -33,12 +33,19 @@ post: responses: '204': description: KYC documents tagging process has been scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -72,9 +79,16 @@ delete: responses: '204': description: KYC documents untagging process has been scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tags@{tag}@kyc-documents@{kycDocumentId}.yaml b/openapi/paths/tags@{tag}@kyc-documents@{kycDocumentId}.yaml index 6e6ad2dff2..d37e9d2e15 100644 --- a/openapi/paths/tags@{tag}@kyc-documents@{kycDocumentId}.yaml +++ b/openapi/paths/tags@{tag}@kyc-documents@{kycDocumentId}.yaml @@ -13,12 +13,19 @@ post: responses: '204': description: KYC document tagged. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -31,9 +38,16 @@ delete: responses: '204': description: KYC document untagged. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/tokens.yaml b/openapi/paths/tokens.yaml index bf7567942b..a35659f86e 100644 --- a/openapi/paths/tokens.yaml +++ b/openapi/paths/tokens.yaml @@ -29,6 +29,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -39,6 +43,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/tracking@webhooks@{id}@resend.yaml b/openapi/paths/tracking@webhooks@{id}@resend.yaml index c3858b6fcb..bbea023efd 100644 --- a/openapi/paths/tracking@webhooks@{id}@resend.yaml +++ b/openapi/paths/tracking@webhooks@{id}@resend.yaml @@ -14,9 +14,16 @@ post: responses: '204': description: Webhook resend attempt scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/transactions.yaml b/openapi/paths/transactions.yaml index 35e2c9a968..b8cc54a835 100644 --- a/openapi/paths/transactions.yaml +++ b/openapi/paths/transactions.yaml @@ -40,6 +40,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -52,6 +56,8 @@ post: $ref: ../components/responses/Conflict.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/transactions@{id}.yaml b/openapi/paths/transactions@{id}.yaml index 5f3a3edacc..bec334b61b 100644 --- a/openapi/paths/transactions@{id}.yaml +++ b/openapi/paths/transactions@{id}.yaml @@ -53,6 +53,11 @@ patch: responses: '200': description: Transaction updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -63,6 +68,8 @@ patch: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/transactions@{id}@query.yaml b/openapi/paths/transactions@{id}@query.yaml index 5cef2c6c74..18c89f10d2 100644 --- a/openapi/paths/transactions@{id}@query.yaml +++ b/openapi/paths/transactions@{id}@query.yaml @@ -19,6 +19,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -29,3 +33,5 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/transactions@{id}@refund.yaml b/openapi/paths/transactions@{id}@refund.yaml index a51571944e..588f593834 100644 --- a/openapi/paths/transactions@{id}@refund.yaml +++ b/openapi/paths/transactions@{id}@refund.yaml @@ -25,6 +25,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -35,6 +39,8 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/transactions@{id}@timeline.yaml b/openapi/paths/transactions@{id}@timeline.yaml index 316cee3aad..3f28737dce 100644 --- a/openapi/paths/transactions@{id}@timeline.yaml +++ b/openapi/paths/transactions@{id}@timeline.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/transactions@{id}@timeline@{messageId}.yaml b/openapi/paths/transactions@{id}@timeline@{messageId}.yaml index 4c106a5530..e470fceec5 100644 --- a/openapi/paths/transactions@{id}@timeline@{messageId}.yaml +++ b/openapi/paths/transactions@{id}@timeline@{messageId}.yaml @@ -45,6 +45,11 @@ delete: responses: '204': description: Transaction timeline message deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -53,6 +58,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/transactions@{id}@update.yaml b/openapi/paths/transactions@{id}@update.yaml index dbc70b7fb0..63149dedd5 100644 --- a/openapi/paths/transactions@{id}@update.yaml +++ b/openapi/paths/transactions@{id}@update.yaml @@ -20,6 +20,11 @@ post: responses: '200': description: Transaction updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -30,3 +35,5 @@ post: $ref: ../components/responses/Forbidden.yaml '404': $ref: ../components/responses/NotFound.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/usages.yaml b/openapi/paths/usages.yaml index d7afa5d9e2..0ae553aa3b 100644 --- a/openapi/paths/usages.yaml +++ b/openapi/paths/usages.yaml @@ -54,6 +54,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -64,3 +68,5 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/usages@{id}.yaml b/openapi/paths/usages@{id}.yaml index 4b72888537..6b28d468ba 100644 --- a/openapi/paths/usages@{id}.yaml +++ b/openapi/paths/usages@{id}.yaml @@ -43,6 +43,11 @@ put: responses: '200': description: Usage record updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -52,6 +57,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -64,6 +73,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Core @@ -76,6 +87,11 @@ delete: responses: '204': description: Usage record deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -84,3 +100,5 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/users.yaml b/openapi/paths/users.yaml index c57abfd1cd..e8905d8094 100644 --- a/openapi/paths/users.yaml +++ b/openapi/paths/users.yaml @@ -61,6 +61,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +75,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/users@{id}.yaml b/openapi/paths/users@{id}.yaml index 83aed17b2a..8b15bebe06 100644 --- a/openapi/paths/users@{id}.yaml +++ b/openapi/paths/users@{id}.yaml @@ -47,6 +47,11 @@ put: responses: '200': description: User updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -56,6 +61,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -68,6 +77,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/webhooks.yaml b/openapi/paths/webhooks.yaml index 3ad6572537..cec333f60c 100644 --- a/openapi/paths/webhooks.yaml +++ b/openapi/paths/webhooks.yaml @@ -56,6 +56,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -66,6 +70,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: JavaScript source: diff --git a/openapi/paths/webhooks@{id}.yaml b/openapi/paths/webhooks@{id}.yaml index 80ee1af095..4d08893f53 100644 --- a/openapi/paths/webhooks@{id}.yaml +++ b/openapi/paths/webhooks@{id}.yaml @@ -48,6 +48,11 @@ put: responses: '200': description: Webhook updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -57,6 +62,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,3 +80,5 @@ put: application/json: schema: $ref: ../components/schemas/InvalidError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml diff --git a/openapi/paths/websites.yaml b/openapi/paths/websites.yaml index a65dfedf4c..a2f48b01d3 100644 --- a/openapi/paths/websites.yaml +++ b/openapi/paths/websites.yaml @@ -65,6 +65,10 @@ post: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -75,6 +79,8 @@ post: $ref: ../components/responses/Forbidden.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/websites@{id}.yaml b/openapi/paths/websites@{id}.yaml index 626a7e71c9..6cd84fbd6d 100644 --- a/openapi/paths/websites@{id}.yaml +++ b/openapi/paths/websites@{id}.yaml @@ -51,6 +51,11 @@ put: responses: '200': description: Website updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -60,6 +65,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -72,6 +81,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 @@ -103,6 +114,8 @@ delete: $ref: ../components/responses/NotFound.yaml '409': $ref: ../components/responses/Conflict.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml x-codeSamples: - lang: PHP label: PHP-SDK-2.0 diff --git a/openapi/paths/{resource}@{resourceId}@external-identifiers@{service}.yaml b/openapi/paths/{resource}@{resourceId}@external-identifiers@{service}.yaml index f4253fca45..a70cdf7643 100644 --- a/openapi/paths/{resource}@{resourceId}@external-identifiers@{service}.yaml +++ b/openapi/paths/{resource}@{resourceId}@external-identifiers@{service}.yaml @@ -36,6 +36,11 @@ post: responses: '204': description: External identifier sync scheduled. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -44,6 +49,8 @@ post: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml put: x-products: - Users @@ -62,6 +69,11 @@ put: responses: '200': description: External identifier updated. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -71,6 +83,10 @@ put: headers: Location: $ref: ../components/headers/Location.yaml + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml content: application/json: schema: @@ -83,6 +99,8 @@ put: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml delete: x-products: - Users @@ -95,6 +113,11 @@ delete: responses: '204': description: External identifier deleted. + headers: + X-RateLimit-Limit: + $ref: ../components/headers/X-RateLimit-Limit.yaml + X-RateLimit-Remaining: + $ref: ../components/headers/X-RateLimit-Remaining.yaml '401': $ref: ../components/responses/Unauthorized.yaml '403': @@ -103,3 +126,5 @@ delete: $ref: ../components/responses/NotFound.yaml '422': $ref: ../components/responses/ValidationError.yaml + '429': + $ref: ../components/responses/TooManyRequests.yaml