From 3c95de63940ea539343f5a6e9d3b409d530e3055 Mon Sep 17 00:00:00 2001 From: autobot Date: Wed, 19 Jul 2023 21:16:44 +0000 Subject: [PATCH] Generated PR for Release: 29.0.0 --- doc/api/customers.md | 8 +- doc/api/invoices.md | 1 + doc/api/refunds.md | 2 +- doc/api/subscriptions.md | 27 ++- doc/client.md | 6 +- doc/models/accept-dispute-response.md | 12 +- .../accumulate-loyalty-points-response.md | 12 +- doc/models/add-group-to-customer-response.md | 12 +- doc/models/additional-recipient.md | 2 +- doc/models/adjust-loyalty-points-response.md | 12 +- doc/models/bank-account.md | 2 +- .../batch-delete-catalog-objects-response.md | 12 +- ...batch-retrieve-catalog-objects-response.md | 12 +- doc/models/batch-retrieve-orders-response.md | 12 +- .../batch-upsert-catalog-objects-response.md | 12 +- ...ooking-custom-attribute-upsert-response.md | 12 +- .../bulk-create-team-members-response.md | 28 +-- doc/models/bulk-create-vendors-response.md | 12 +- ...ete-location-custom-attributes-response.md | 12 +- ...ete-merchant-custom-attributes-response.md | 12 +- ...delete-order-custom-attributes-response.md | 24 +-- doc/models/bulk-retrieve-vendors-response.md | 12 +- .../bulk-update-team-members-response.md | 28 +-- doc/models/bulk-update-vendors-response.md | 24 +-- ...sert-booking-custom-attributes-response.md | 36 ++-- ...stomer-custom-attribute-upsert-response.md | 12 +- ...ert-customer-custom-attributes-response.md | 36 ++-- ...cation-custom-attribute-upsert-response.md | 12 +- ...ert-location-custom-attributes-response.md | 36 ++-- ...rchant-custom-attribute-upsert-response.md | 12 +- ...ert-merchant-custom-attributes-response.md | 36 ++-- ...upsert-order-custom-attributes-response.md | 36 ++-- doc/models/business-appointment-settings.md | 4 +- .../calculate-loyalty-points-request.md | 2 +- .../calculate-loyalty-points-response.md | 12 +- doc/models/calculate-order-response.md | 12 +- doc/models/cancel-invoice-response.md | 13 +- .../cancel-loyalty-promotion-response.md | 12 +- ...cel-payment-by-idempotency-key-response.md | 12 +- doc/models/cancel-payment-response.md | 12 +- doc/models/cancel-subscription-response.md | 33 ++-- doc/models/cancel-terminal-action-response.md | 12 +- .../cancel-terminal-checkout-response.md | 13 +- doc/models/cancel-terminal-refund-response.md | 12 +- doc/models/capture-transaction-response.md | 12 +- doc/models/cash-drawer-shift-event.md | 2 +- doc/models/cash-payment-details.md | 4 +- doc/models/catalog-discount.md | 2 +- doc/models/catalog-info-response.md | 12 +- doc/models/catalog-modifier.md | 8 +- doc/models/catalog-quick-amount.md | 2 +- doc/models/catalog-quick-amounts-settings.md | 4 +- .../catalog-subscription-plan-variation.md | 4 +- doc/models/catalog-subscription-plan.md | 8 +- .../charge-request-additional-recipient.md | 2 +- doc/models/charge-response.md | 36 ++-- doc/models/clone-order-response.md | 12 +- doc/models/complete-payment-response.md | 14 +- doc/models/create-break-type-response.md | 12 +- doc/models/create-card-response.md | 12 +- doc/models/create-catalog-image-response.md | 12 +- doc/models/create-checkout-response.md | 12 +- doc/models/create-customer-card-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- doc/models/create-customer-group-response.md | 12 +- doc/models/create-customer-response.md | 12 +- doc/models/create-device-code-request.md | 2 +- doc/models/create-device-code-response.md | 12 +- .../create-dispute-evidence-file-response.md | 12 +- .../create-dispute-evidence-text-response.md | 12 +- .../create-gift-card-activity-request.md | 2 +- .../create-gift-card-activity-response.md | 12 +- doc/models/create-gift-card-request.md | 2 +- doc/models/create-gift-card-response.md | 12 +- doc/models/create-invoice-request.md | 1 + doc/models/create-invoice-response.md | 13 +- ...on-custom-attribute-definition-response.md | 12 +- doc/models/create-location-response.md | 12 +- doc/models/create-loyalty-account-response.md | 12 +- .../create-loyalty-promotion-response.md | 12 +- doc/models/create-loyalty-reward-response.md | 12 +- ...nt-custom-attribute-definition-response.md | 12 +- ...eate-mobile-authorization-code-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- doc/models/create-order-response.md | 12 +- doc/models/create-payment-link-response.md | 12 +- doc/models/create-payment-request.md | 2 +- doc/models/create-payment-response.md | 14 +- doc/models/create-refund-response.md | 14 +- doc/models/create-shift-response.md | 13 +- doc/models/create-subscription-request.md | 22 +-- doc/models/create-subscription-response.md | 38 ++-- doc/models/create-team-member-request.md | 2 +- doc/models/create-team-member-response.md | 12 +- doc/models/create-terminal-action-request.md | 2 +- doc/models/create-terminal-action-response.md | 12 +- .../create-terminal-checkout-request.md | 2 +- .../create-terminal-checkout-response.md | 13 +- doc/models/create-terminal-refund-request.md | 2 +- doc/models/create-terminal-refund-response.md | 12 +- doc/models/create-vendor-response.md | 12 +- .../create-webhook-subscription-response.md | 12 +- doc/models/currency.md | 1 + doc/models/delete-break-type-response.md | 12 +- doc/models/delete-catalog-object-response.md | 12 +- doc/models/delete-customer-card-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- ...lete-customer-custom-attribute-response.md | 12 +- doc/models/delete-customer-group-response.md | 12 +- doc/models/delete-customer-response.md | 12 +- .../delete-dispute-evidence-response.md | 12 +- doc/models/delete-invoice-response.md | 12 +- ...on-custom-attribute-definition-response.md | 12 +- ...lete-location-custom-attribute-response.md | 12 +- doc/models/delete-loyalty-reward-response.md | 12 +- ...nt-custom-attribute-definition-response.md | 12 +- ...lete-merchant-custom-attribute-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- .../delete-order-custom-attribute-response.md | 12 +- doc/models/delete-payment-link-response.md | 12 +- doc/models/delete-shift-response.md | 12 +- doc/models/delete-snippet-response.md | 12 +- .../delete-subscription-action-response.md | 36 ++-- .../delete-webhook-subscription-response.md | 12 +- ...d-create-dispute-evidence-file-response.md | 12 +- ...d-create-dispute-evidence-text-response.md | 12 +- doc/models/disable-card-response.md | 12 +- .../dismiss-terminal-action-response.md | 12 +- doc/models/dispute.md | 2 +- doc/models/employee-wage.md | 2 +- doc/models/error-category.md | 1 + doc/models/error-code.md | 4 + doc/models/error.md | 4 +- doc/models/external-payment-details.md | 2 +- .../get-bank-account-by-v1-id-response.md | 12 +- doc/models/get-bank-account-response.md | 12 +- doc/models/get-break-type-response.md | 12 +- doc/models/get-device-code-response.md | 12 +- doc/models/get-employee-wage-response.md | 12 +- doc/models/get-invoice-response.md | 13 +- doc/models/get-payment-refund-response.md | 12 +- doc/models/get-payment-response.md | 14 +- doc/models/get-payout-response.md | 14 +- doc/models/get-shift-response.md | 13 +- doc/models/get-team-member-wage-response.md | 16 +- doc/models/get-terminal-action-response.md | 12 +- doc/models/get-terminal-checkout-response.md | 13 +- doc/models/get-terminal-refund-response.md | 12 +- doc/models/gift-card-activity-activate.md | 2 +- .../gift-card-activity-adjust-decrement.md | 2 +- .../gift-card-activity-adjust-increment.md | 2 +- .../gift-card-activity-import-reversal.md | 2 +- doc/models/gift-card-activity-import.md | 2 +- doc/models/gift-card-activity-load.md | 2 +- doc/models/gift-card-activity-redeem.md | 2 +- doc/models/gift-card-activity-refund.md | 2 +- ...ift-card-activity-transfer-balance-from.md | 2 +- .../gift-card-activity-transfer-balance-to.md | 2 +- ...-card-activity-unlinked-activity-refund.md | 2 +- doc/models/gift-card-activity.md | 2 +- doc/models/gift-card.md | 2 +- .../invoice-accepted-payment-methods.md | 4 +- doc/models/invoice-payment-request.md | 2 +- .../item-variation-location-overrides.md | 2 +- doc/models/job-assignment.md | 4 +- .../link-customer-to-gift-card-response.md | 12 +- doc/models/list-bank-accounts-response.md | 12 +- ...list-booking-custom-attributes-response.md | 12 +- doc/models/list-bookings-response.md | 12 +- doc/models/list-break-types-response.md | 12 +- doc/models/list-cards-response.md | 12 +- .../list-cash-drawer-shift-events-response.md | 12 +- .../list-cash-drawer-shifts-response.md | 12 +- doc/models/list-catalog-response.md | 12 +- ...r-custom-attribute-definitions-response.md | 12 +- ...ist-customer-custom-attributes-response.md | 12 +- doc/models/list-customer-groups-response.md | 12 +- doc/models/list-customer-segments-response.md | 12 +- doc/models/list-customers-request.md | 4 +- doc/models/list-customers-response.md | 18 +- doc/models/list-device-codes-response.md | 12 +- doc/models/list-dispute-evidence-response.md | 12 +- doc/models/list-disputes-response.md | 12 +- doc/models/list-employee-wages-response.md | 12 +- doc/models/list-employees-response.md | 12 +- .../list-gift-card-activities-response.md | 12 +- doc/models/list-gift-cards-response.md | 12 +- doc/models/list-invoices-response.md | 14 +- ...n-custom-attribute-definitions-response.md | 12 +- ...ist-location-custom-attributes-response.md | 12 +- doc/models/list-locations-response.md | 12 +- doc/models/list-loyalty-programs-response.md | 16 +- .../list-loyalty-promotions-response.md | 12 +- ...t-custom-attribute-definitions-response.md | 12 +- ...ist-merchant-custom-attributes-response.md | 12 +- doc/models/list-merchants-response.md | 12 +- ...r-custom-attribute-definitions-response.md | 12 +- .../list-order-custom-attributes-response.md | 12 +- doc/models/list-payment-links-response.md | 12 +- doc/models/list-payment-refunds-request.md | 2 +- doc/models/list-payment-refunds-response.md | 12 +- doc/models/list-payments-response.md | 14 +- doc/models/list-payout-entries-response.md | 24 +-- doc/models/list-payouts-response.md | 16 +- doc/models/list-refunds-response.md | 14 +- doc/models/list-sites-response.md | 12 +- .../list-subscription-events-response.md | 184 +++++++++++++++--- doc/models/list-team-member-wages-response.md | 28 +-- doc/models/list-transactions-response.md | 12 +- .../list-webhook-event-types-response.md | 12 +- .../list-webhook-subscriptions-response.md | 12 +- doc/models/list-workweek-configs-response.md | 12 +- ...loyalty-program-accrual-rule-spend-data.md | 2 +- ...loyalty-program-accrual-rule-visit-data.md | 2 +- doc/models/loyalty-program-accrual-rule.md | 4 +- .../loyalty-program-reward-definition.md | 4 +- doc/models/loyalty-program-reward-tier.md | 4 +- doc/models/loyalty-program.md | 8 +- doc/models/merchant.md | 2 +- doc/models/modifier-location-overrides.md | 2 +- doc/models/money.md | 2 +- .../order-line-item-applied-discount.md | 2 +- .../order-line-item-applied-service-charge.md | 2 +- doc/models/order-line-item-applied-tax.md | 2 +- doc/models/order-money-amounts.md | 10 +- doc/models/order-rounding-adjustment.md | 2 +- doc/models/pause-subscription-response.md | 40 ++-- doc/models/pay-order-response.md | 12 +- doc/models/payment-refund.md | 2 +- doc/models/payment.md | 4 +- doc/models/payout-entry.md | 6 +- doc/models/payout-fee.md | 2 +- doc/models/payout.md | 2 +- doc/models/processing-fee.md | 2 +- doc/models/publish-invoice-response.md | 13 +- doc/models/quick-pay.md | 2 +- doc/models/redeem-loyalty-reward-response.md | 12 +- doc/models/refund-payment-response.md | 12 +- doc/models/refund.md | 10 +- doc/models/register-domain-response.md | 12 +- .../remove-group-from-customer-response.md | 12 +- doc/models/resume-subscription-response.md | 40 ++-- ...rieve-booking-custom-attribute-response.md | 12 +- doc/models/retrieve-card-response.md | 12 +- .../retrieve-cash-drawer-shift-response.md | 12 +- .../retrieve-catalog-object-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- ...ieve-customer-custom-attribute-response.md | 12 +- .../retrieve-customer-group-response.md | 12 +- doc/models/retrieve-customer-response.md | 12 +- .../retrieve-customer-segment-response.md | 12 +- .../retrieve-dispute-evidence-response.md | 12 +- doc/models/retrieve-dispute-response.md | 12 +- doc/models/retrieve-employee-response.md | 12 +- .../retrieve-gift-card-from-gan-response.md | 12 +- .../retrieve-gift-card-from-nonce-response.md | 12 +- doc/models/retrieve-gift-card-response.md | 12 +- ...on-custom-attribute-definition-response.md | 12 +- ...ieve-location-custom-attribute-response.md | 12 +- doc/models/retrieve-location-response.md | 12 +- .../retrieve-loyalty-account-response.md | 12 +- .../retrieve-loyalty-program-response.md | 16 +- .../retrieve-loyalty-promotion-response.md | 12 +- .../retrieve-loyalty-reward-response.md | 12 +- ...nt-custom-attribute-definition-response.md | 12 +- ...ieve-merchant-custom-attribute-response.md | 12 +- doc/models/retrieve-merchant-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- ...etrieve-order-custom-attribute-response.md | 12 +- doc/models/retrieve-order-response.md | 12 +- doc/models/retrieve-payment-link-response.md | 12 +- doc/models/retrieve-snippet-response.md | 12 +- doc/models/retrieve-subscription-response.md | 36 ++-- doc/models/retrieve-team-member-response.md | 12 +- doc/models/retrieve-token-status-response.md | 12 +- doc/models/retrieve-transaction-response.md | 36 ++-- doc/models/retrieve-vendor-response.md | 12 +- doc/models/retrieve-wage-setting-response.md | 12 +- .../retrieve-webhook-subscription-response.md | 12 +- doc/models/revoke-token-response.md | 12 +- doc/models/search-catalog-items-response.md | 12 +- doc/models/search-catalog-objects-response.md | 12 +- doc/models/search-customers-request.md | 4 +- doc/models/search-customers-response.md | 18 +- doc/models/search-invoices-response.md | 14 +- .../search-loyalty-accounts-response.md | 12 +- doc/models/search-loyalty-events-response.md | 12 +- doc/models/search-loyalty-rewards-response.md | 12 +- doc/models/search-orders-response.md | 12 +- doc/models/search-shifts-response.md | 14 +- doc/models/search-subscriptions-response.md | 66 ++++--- doc/models/search-team-members-response.md | 12 +- .../search-terminal-actions-response.md | 12 +- .../search-terminal-checkouts-response.md | 12 +- .../search-terminal-refunds-response.md | 12 +- doc/models/search-vendors-response.md | 12 +- doc/models/shift-wage.md | 2 +- doc/models/shipping-fee.md | 2 +- doc/models/snippet-response.md | 12 +- doc/models/submit-evidence-response.md | 12 +- doc/models/subscription-phase.md | 4 +- doc/models/subscription-pricing.md | 2 +- doc/models/swap-plan-request.md | 10 +- doc/models/swap-plan-response.md | 28 ++- doc/models/team-member-wage.md | 2 +- doc/models/tender-cash-details.md | 4 +- doc/models/terminal-action.md | 1 + doc/models/terminal-checkout.md | 4 +- doc/models/terminal-refund.md | 4 +- .../test-webhook-subscription-response.md | 12 +- doc/models/transaction.md | 24 +-- ...unlink-customer-from-gift-card-response.md | 12 +- doc/models/update-break-type-response.md | 12 +- doc/models/update-catalog-image-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- doc/models/update-customer-group-response.md | 12 +- doc/models/update-customer-response.md | 12 +- doc/models/update-invoice-response.md | 13 +- .../update-item-modifier-lists-response.md | 12 +- doc/models/update-item-taxes-response.md | 12 +- ...on-custom-attribute-definition-response.md | 12 +- doc/models/update-location-response.md | 12 +- ...nt-custom-attribute-definition-response.md | 12 +- ...er-custom-attribute-definition-response.md | 12 +- doc/models/update-order-response.md | 12 +- doc/models/update-payment-link-response.md | 12 +- doc/models/update-payment-response.md | 12 +- doc/models/update-shift-response.md | 13 +- doc/models/update-subscription-request.md | 8 +- doc/models/update-subscription-response.md | 41 ++-- doc/models/update-team-member-response.md | 12 +- doc/models/update-wage-setting-request.md | 4 +- doc/models/update-wage-setting-response.md | 14 +- .../update-webhook-subscription-response.md | 12 +- ...ook-subscription-signature-key-response.md | 12 +- doc/models/update-workweek-config-response.md | 12 +- ...psert-booking-custom-attribute-response.md | 12 +- doc/models/upsert-catalog-object-response.md | 12 +- ...sert-customer-custom-attribute-response.md | 12 +- ...sert-location-custom-attribute-response.md | 12 +- ...sert-merchant-custom-attribute-response.md | 12 +- .../upsert-order-custom-attribute-response.md | 12 +- doc/models/upsert-snippet-response.md | 12 +- doc/models/v1-create-refund-request.md | 2 +- doc/models/v1-list-orders-response.md | 16 +- doc/models/v1-list-refunds-response.md | 12 +- doc/models/v1-list-settlements-response.md | 4 +- doc/models/v1-money.md | 2 +- doc/models/v1-order.md | 12 +- doc/models/v1-payment-discount.md | 2 +- doc/models/v1-payment-modifier.md | 2 +- doc/models/v1-payment-surcharge.md | 4 +- doc/models/v1-payment-tax.md | 14 +- doc/models/v1-refund.md | 6 +- doc/models/v1-settlement-entry.md | 4 +- doc/models/v1-settlement.md | 2 +- doc/models/void-transaction-response.md | 12 +- doc/models/wage-setting.md | 12 +- jest.config.js | 1 - package.json | 2 +- src/api/customersApi.ts | 27 +-- src/api/refundsApi.ts | 2 +- src/client.ts | 4 +- src/defaultConfiguration.ts | 2 +- src/errors/apiError.ts | 2 +- src/models/businessAppointmentSettings.ts | 4 +- src/models/createDeviceCodeRequest.ts | 2 +- src/models/createSubscriptionRequest.ts | 9 - src/models/createTeamMemberRequest.ts | 2 +- src/models/createTerminalActionRequest.ts | 2 +- src/models/createTerminalCheckoutRequest.ts | 2 +- src/models/createTerminalRefundRequest.ts | 2 +- src/models/invoiceAcceptedPaymentMethods.ts | 6 + src/models/listCustomersRequest.ts | 16 +- src/models/listCustomersResponse.ts | 23 ++- src/models/listPaymentRefundsRequest.ts | 2 +- src/models/searchCustomersRequest.ts | 16 +- src/models/searchCustomersResponse.ts | 23 ++- src/models/terminalAction.ts | 3 + src/types.d.ts | 1 - 380 files changed, 2309 insertions(+), 2063 deletions(-) delete mode 100644 src/types.d.ts diff --git a/doc/api/customers.md b/doc/api/customers.md index a5d8d961..13ce617f 100644 --- a/doc/api/customers.md +++ b/doc/api/customers.md @@ -36,6 +36,7 @@ async listCustomers( limit?: number, sortField?: string, sortOrder?: string, + count?: boolean, requestOptions?: RequestOptions ): Promise> ``` @@ -48,6 +49,7 @@ async listCustomers( | `limit` | `number \| undefined` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `sortField` | [`string \| undefined`](../../doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.

The default value is `DEFAULT`. | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or
descending (`DESC`) order.

The default value is `ASC`. | +| `count` | `boolean \| undefined` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.

The default value is `false`.
**Default**: `false` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -57,8 +59,12 @@ async listCustomers( ## Example Usage ```ts +const count = false; + try { - const { result, ...httpResponse } = await customersApi.listCustomers(); + const { result, ...httpResponse } = await customersApi.listCustomers( + count + ); // Get more response info... // const { statusCode, headers } = httpResponse; } catch (error) { diff --git a/doc/api/invoices.md b/doc/api/invoices.md index 6b3f90a4..1b6b2071 100644 --- a/doc/api/invoices.md +++ b/doc/api/invoices.md @@ -126,6 +126,7 @@ const body: CreateInvoiceRequest = { squareGiftCard: false, bankAccount: false, buyNowPayLater: false, + cashAppPay: false, }, customFields: [ { diff --git a/doc/api/refunds.md b/doc/api/refunds.md index 840f5851..6109deae 100644 --- a/doc/api/refunds.md +++ b/doc/api/refunds.md @@ -42,7 +42,7 @@ async listPaymentRefunds( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `beginTime` | `string \| undefined` | Query, Optional | Indicates the start of the time range to retrieve each PaymentRefund`for, in RFC 3339 format. The range is determined using the`created_at`field for each`PaymentRefund`.

Default: The current time minus one year. | +| `beginTime` | `string \| undefined` | Query, Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339
format. The range is determined using the `created_at` field for each `PaymentRefund`.

Default: The current time minus one year. | | `endTime` | `string \| undefined` | Query, Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339
format. The range is determined using the `created_at` field for each `PaymentRefund`.

Default: The current time. | | `sortOrder` | `string \| undefined` | Query, Optional | The order in which results are listed by `PaymentRefund.created_at`:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | | `cursor` | `string \| undefined` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | diff --git a/doc/api/subscriptions.md b/doc/api/subscriptions.md index 9168e3e3..ee9548df 100644 --- a/doc/api/subscriptions.md +++ b/doc/api/subscriptions.md @@ -58,18 +58,19 @@ const body: CreateSubscriptionRequest = { locationId: 'S8GWD5R9QB376', customerId: 'CHFGVKYY8RSV93M5KCYTG4PN0G', idempotencyKey: '8193148c-9586-11e6-99f9-28cfe92138cf', - planId: '6JHXF3B2CW3YKHDV4XEM674H', - startDate: '2021-10-20', - taxPercentage: '5', - priceOverrideMoney: { - amount: BigInt(100), - currency: 'USD', - }, + planVariationId: '6JHXF3B2CW3YKHDV4XEM674H', + startDate: '2023-06-20', cardId: 'ccof:qy5x8hHGYsgLrp4Q4GB', timezone: 'America/Los_Angeles', source: { - name: 'My App', + name: 'My Application', }, + phases: [ + { + ordinal: 0, + orderTemplateId: 'U2NaowWxzXwpsZU697x7ZHOAnCNZY', + } + ], }; try { @@ -501,7 +502,15 @@ async swapPlan( ```ts const subscriptionId = 'subscription_id0'; -const body: SwapPlanRequest = {}; +const body: SwapPlanRequest = { + newPlanVariationId: 'FQ7CDXXWSLUJRPM3GFJSJGZ7', + phases: [ + { + ordinal: 0, + orderTemplateId: 'uhhnjH9osVv3shUADwaC0b3hNxQZY', + } + ], +}; try { const { result, ...httpResponse } = await subscriptionsApi.swapPlan( diff --git a/doc/client.md b/doc/client.md index 6eea0810..c2b5d406 100644 --- a/doc/client.md +++ b/doc/client.md @@ -5,7 +5,7 @@ The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | -| `squareVersion` | `string` | Square Connect API versions
*Default*: `'2023-06-08'` | +| `squareVersion` | `string` | Square Connect API versions
*Default*: `'2023-07-20'` | | `customUrl` | `string` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
*Default*: `'https://connect.squareup.com'` | | `environment` | `string` | The API environment.
**Default: `production`** | | `additionalHeaders` | `Readonly>` | Additional headers to add to each API call
*Default*: `{}` | @@ -40,7 +40,7 @@ The API client can be initialized as follows: ```ts const client = new Client({ - squareVersion: '2023-06-08', + squareVersion: '2023-07-20', timeout: 60000, additionalHeaders: {}, userAgentDetail: '', @@ -55,7 +55,7 @@ const client = new Client({ import { ApiError, Client } from 'square'; const client = new Client({ - squareVersion: '2023-06-08', + squareVersion: '2023-07-20', timeout: 60000, additionalHeaders: {}, userAgentDetail: '', diff --git a/doc/models/accept-dispute-response.md b/doc/models/accept-dispute-response.md index db0bc923..35108e38 100644 --- a/doc/models/accept-dispute-response.md +++ b/doc/models/accept-dispute-response.md @@ -41,20 +41,20 @@ Defines the fields in an `AcceptDispute` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/accumulate-loyalty-points-response.md b/doc/models/accumulate-loyalty-points-response.md index f68bdc0f..0baa7df5 100644 --- a/doc/models/accumulate-loyalty-points-response.md +++ b/doc/models/accumulate-loyalty-points-response.md @@ -56,20 +56,20 @@ Represents an [AccumulateLoyaltyPoints](../../doc/api/loyalty.md#accumulate-loya ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/add-group-to-customer-response.md b/doc/models/add-group-to-customer-response.md index 416e6e72..873d2507 100644 --- a/doc/models/add-group-to-customer-response.md +++ b/doc/models/add-group-to-customer-response.md @@ -20,20 +20,20 @@ a request to the [AddGroupToCustomer](../../doc/api/customers.md#add-group-to-cu { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/additional-recipient.md b/doc/models/additional-recipient.md index ad83eb62..36a63e7b 100644 --- a/doc/models/additional-recipient.md +++ b/doc/models/additional-recipient.md @@ -24,7 +24,7 @@ Represents an additional recipient (other than the merchant) receiving a portion "description": "description0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "receivable_id": "receivable_id0" } diff --git a/doc/models/adjust-loyalty-points-response.md b/doc/models/adjust-loyalty-points-response.md index 4ab2c49d..f5585c24 100644 --- a/doc/models/adjust-loyalty-points-response.md +++ b/doc/models/adjust-loyalty-points-response.md @@ -52,20 +52,20 @@ Represents an [AdjustLoyaltyPoints](../../doc/api/loyalty.md#adjust-loyalty-poin }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bank-account.md b/doc/models/bank-account.md index 038c3fdf..5522aa2e 100644 --- a/doc/models/bank-account.md +++ b/doc/models/bank-account.md @@ -38,7 +38,7 @@ linking a bank account to a Square account, see "id": "id0", "account_number_suffix": "account_number_suffix8", "country": "FO", - "currency": "YER", + "currency": "SLL", "account_type": "BUSINESS_CHECKING", "holder_name": "holder_name4", "primary_bank_identification_number": "primary_bank_identification_number8", diff --git a/doc/models/batch-delete-catalog-objects-response.md b/doc/models/batch-delete-catalog-objects-response.md index 56a8a89f..bb0b2c26 100644 --- a/doc/models/batch-delete-catalog-objects-response.md +++ b/doc/models/batch-delete-catalog-objects-response.md @@ -24,20 +24,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/batch-retrieve-catalog-objects-response.md b/doc/models/batch-retrieve-catalog-objects-response.md index 5e82afc6..798adcd3 100644 --- a/doc/models/batch-retrieve-catalog-objects-response.md +++ b/doc/models/batch-retrieve-catalog-objects-response.md @@ -236,20 +236,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/batch-retrieve-orders-response.md b/doc/models/batch-retrieve-orders-response.md index dd5b7601..2d4b80a2 100644 --- a/doc/models/batch-retrieve-orders-response.md +++ b/doc/models/batch-retrieve-orders-response.md @@ -98,20 +98,20 @@ a request to the `BatchRetrieveOrders` endpoint. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/batch-upsert-catalog-objects-response.md b/doc/models/batch-upsert-catalog-objects-response.md index 0462729a..a8c89407 100644 --- a/doc/models/batch-upsert-catalog-objects-response.md +++ b/doc/models/batch-upsert-catalog-objects-response.md @@ -273,20 +273,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/booking-custom-attribute-upsert-response.md b/doc/models/booking-custom-attribute-upsert-response.md index cc382dff..e51e2441 100644 --- a/doc/models/booking-custom-attribute-upsert-response.md +++ b/doc/models/booking-custom-attribute-upsert-response.md @@ -41,20 +41,20 @@ Represents a response for an individual upsert request in a [BulkUpsertBookingCu }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-create-team-members-response.md b/doc/models/bulk-create-team-members-response.md index 436b79c8..61e3aefe 100644 --- a/doc/models/bulk-create-team-members-response.md +++ b/doc/models/bulk-create-team-members-response.md @@ -39,20 +39,20 @@ Represents a response from a bulk create request containing the created `TeamMem }, "errors": [ { - "category": "MERCHANT_SUBSCRIPTION_ERROR", - "code": "GENERIC_DECLINE", + "category": "PAYMENT_METHOD_ERROR", + "code": "REQUEST_TIMEOUT", "detail": "detail8", "field": "field6" }, { - "category": "API_ERROR", - "code": "CVV_FAILURE", + "category": "REFUND_ERROR", + "code": "CONFLICT", "detail": "detail9", "field": "field7" }, { - "category": "AUTHENTICATION_ERROR", - "code": "ADDRESS_VERIFICATION_FAILURE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "GONE", "detail": "detail0", "field": "field8" } @@ -74,8 +74,8 @@ Represents a response from a bulk create request containing the created `TeamMem }, "errors": [ { - "category": "API_ERROR", - "code": "CVV_FAILURE", + "category": "REFUND_ERROR", + "code": "CONFLICT", "detail": "detail9", "field": "field7" } @@ -84,20 +84,20 @@ Represents a response from a bulk create request containing the created `TeamMem }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-create-vendors-response.md b/doc/models/bulk-create-vendors-response.md index 0b2f01e5..8c312e2d 100644 --- a/doc/models/bulk-create-vendors-response.md +++ b/doc/models/bulk-create-vendors-response.md @@ -71,20 +71,20 @@ Represents an output from a call to [BulkCreateVendors](../../doc/api/vendors.md "key0": { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "INVALID_EMAIL_ADDRESS", + "category": "PAYMENT_METHOD_ERROR", + "code": "INVALID_CARD", "detail": "detail8", "field": "field6" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "INVALID_PHONE_NUMBER", + "category": "REFUND_ERROR", + "code": "PAYMENT_AMOUNT_MISMATCH", "detail": "detail9", "field": "field7" }, { - "category": "RATE_LIMIT_ERROR", - "code": "CHECKOUT_EXPIRED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "GENERIC_DECLINE", "detail": "detail0", "field": "field8" } diff --git a/doc/models/bulk-delete-location-custom-attributes-response.md b/doc/models/bulk-delete-location-custom-attributes-response.md index 2d4e550d..fc232820 100644 --- a/doc/models/bulk-delete-location-custom-attributes-response.md +++ b/doc/models/bulk-delete-location-custom-attributes-response.md @@ -35,20 +35,20 @@ which contains a map of responses that each corresponds to an individual delete }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-delete-merchant-custom-attributes-response.md b/doc/models/bulk-delete-merchant-custom-attributes-response.md index fc981d59..d7517218 100644 --- a/doc/models/bulk-delete-merchant-custom-attributes-response.md +++ b/doc/models/bulk-delete-merchant-custom-attributes-response.md @@ -31,20 +31,20 @@ which contains a map of responses that each corresponds to an individual delete }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-delete-order-custom-attributes-response.md b/doc/models/bulk-delete-order-custom-attributes-response.md index f85126ea..1ffd55ea 100644 --- a/doc/models/bulk-delete-order-custom-attributes-response.md +++ b/doc/models/bulk-delete-order-custom-attributes-response.md @@ -22,8 +22,8 @@ Represents a response from deleting one or more order custom attributes. "cover-count": { "errors": [ { - "category": "API_ERROR", - "code": "INVALID_FEES", + "category": "REFUND_ERROR", + "code": "INVALID_ENUM_VALUE", "detail": "detail1", "field": "field9" } @@ -32,14 +32,14 @@ Represents a response from deleting one or more order custom attributes. "table-number": { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_CONTENT_TYPE", "detail": "detail2", "field": "field0" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" } @@ -48,20 +48,20 @@ Represents a response from deleting one or more order custom attributes. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-retrieve-vendors-response.md b/doc/models/bulk-retrieve-vendors-response.md index 59ce60a7..b823c26f 100644 --- a/doc/models/bulk-retrieve-vendors-response.md +++ b/doc/models/bulk-retrieve-vendors-response.md @@ -53,20 +53,20 @@ Represents an output from a call to [BulkRetrieveVendors](../../doc/api/vendors. "key0": { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "INVALID_EMAIL_ADDRESS", + "category": "PAYMENT_METHOD_ERROR", + "code": "INVALID_CARD", "detail": "detail8", "field": "field6" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "INVALID_PHONE_NUMBER", + "category": "REFUND_ERROR", + "code": "PAYMENT_AMOUNT_MISMATCH", "detail": "detail9", "field": "field7" }, { - "category": "RATE_LIMIT_ERROR", - "code": "CHECKOUT_EXPIRED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "GENERIC_DECLINE", "detail": "detail0", "field": "field8" } diff --git a/doc/models/bulk-update-team-members-response.md b/doc/models/bulk-update-team-members-response.md index dbb9b73a..d8bd16b4 100644 --- a/doc/models/bulk-update-team-members-response.md +++ b/doc/models/bulk-update-team-members-response.md @@ -37,20 +37,20 @@ Represents a response from a bulk update request containing the updated `TeamMem }, "errors": [ { - "category": "MERCHANT_SUBSCRIPTION_ERROR", - "code": "GENERIC_DECLINE", + "category": "PAYMENT_METHOD_ERROR", + "code": "REQUEST_TIMEOUT", "detail": "detail8", "field": "field6" }, { - "category": "API_ERROR", - "code": "CVV_FAILURE", + "category": "REFUND_ERROR", + "code": "CONFLICT", "detail": "detail9", "field": "field7" }, { - "category": "AUTHENTICATION_ERROR", - "code": "ADDRESS_VERIFICATION_FAILURE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "GONE", "detail": "detail0", "field": "field8" } @@ -78,8 +78,8 @@ Represents a response from a bulk update request containing the updated `TeamMem }, "errors": [ { - "category": "API_ERROR", - "code": "CVV_FAILURE", + "category": "REFUND_ERROR", + "code": "CONFLICT", "detail": "detail9", "field": "field7" } @@ -88,20 +88,20 @@ Represents a response from a bulk update request containing the updated `TeamMem }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-update-vendors-response.md b/doc/models/bulk-update-vendors-response.md index 9cd25b78..3dd9ce04 100644 --- a/doc/models/bulk-update-vendors-response.md +++ b/doc/models/bulk-update-vendors-response.md @@ -73,20 +73,20 @@ Represents an output from a call to [BulkUpdateVendors](../../doc/api/vendors.md }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } @@ -95,20 +95,20 @@ Represents an output from a call to [BulkUpdateVendors](../../doc/api/vendors.md "key0": { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "INVALID_EMAIL_ADDRESS", + "category": "PAYMENT_METHOD_ERROR", + "code": "INVALID_CARD", "detail": "detail8", "field": "field6" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "INVALID_PHONE_NUMBER", + "category": "REFUND_ERROR", + "code": "PAYMENT_AMOUNT_MISMATCH", "detail": "detail9", "field": "field7" }, { - "category": "RATE_LIMIT_ERROR", - "code": "CHECKOUT_EXPIRED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "GENERIC_DECLINE", "detail": "detail0", "field": "field8" } diff --git a/doc/models/bulk-upsert-booking-custom-attributes-response.md b/doc/models/bulk-upsert-booking-custom-attributes-response.md index 7035e277..1f34f14b 100644 --- a/doc/models/bulk-upsert-booking-custom-attributes-response.md +++ b/doc/models/bulk-upsert-booking-custom-attributes-response.md @@ -43,8 +43,8 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "API_ERROR", - "code": "INVALID_FEES", + "category": "REFUND_ERROR", + "code": "INVALID_ENUM_VALUE", "detail": "detail1", "field": "field9" } @@ -73,14 +73,14 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_CONTENT_TYPE", "detail": "detail2", "field": "field0" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" } @@ -109,20 +109,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" }, { - "category": "RATE_LIMIT_ERROR", - "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "category": "API_ERROR", + "code": "CUSTOMER_NOT_FOUND", "detail": "detail4", "field": "field2" }, { - "category": "PAYMENT_METHOD_ERROR", - "code": "ACCOUNT_UNUSABLE", + "category": "AUTHENTICATION_ERROR", + "code": "ONE_INSTRUMENT_EXPECTED", "detail": "detail5", "field": "field3" } @@ -131,20 +131,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md b/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md index ee428c6a..52047ae0 100644 --- a/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md +++ b/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md @@ -41,20 +41,20 @@ Represents a response for an individual upsert request in a [BulkUpsertCustomerC }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-customer-custom-attributes-response.md b/doc/models/bulk-upsert-customer-custom-attributes-response.md index 2c3e0e28..745eba12 100644 --- a/doc/models/bulk-upsert-customer-custom-attributes-response.md +++ b/doc/models/bulk-upsert-customer-custom-attributes-response.md @@ -43,8 +43,8 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "API_ERROR", - "code": "INVALID_FEES", + "category": "REFUND_ERROR", + "code": "INVALID_ENUM_VALUE", "detail": "detail1", "field": "field9" } @@ -73,14 +73,14 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_CONTENT_TYPE", "detail": "detail2", "field": "field0" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" } @@ -109,20 +109,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" }, { - "category": "RATE_LIMIT_ERROR", - "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "category": "API_ERROR", + "code": "CUSTOMER_NOT_FOUND", "detail": "detail4", "field": "field2" }, { - "category": "PAYMENT_METHOD_ERROR", - "code": "ACCOUNT_UNUSABLE", + "category": "AUTHENTICATION_ERROR", + "code": "ONE_INSTRUMENT_EXPECTED", "detail": "detail5", "field": "field3" } @@ -131,20 +131,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md b/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md index c133130e..a02fbc87 100644 --- a/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md +++ b/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md @@ -41,20 +41,20 @@ Represents a response for an individual upsert request in a [BulkUpsertLocationC }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-location-custom-attributes-response.md b/doc/models/bulk-upsert-location-custom-attributes-response.md index b8371781..3d1a33af 100644 --- a/doc/models/bulk-upsert-location-custom-attributes-response.md +++ b/doc/models/bulk-upsert-location-custom-attributes-response.md @@ -43,8 +43,8 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "API_ERROR", - "code": "INVALID_FEES", + "category": "REFUND_ERROR", + "code": "INVALID_ENUM_VALUE", "detail": "detail1", "field": "field9" } @@ -73,14 +73,14 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_CONTENT_TYPE", "detail": "detail2", "field": "field0" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" } @@ -109,20 +109,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" }, { - "category": "RATE_LIMIT_ERROR", - "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "category": "API_ERROR", + "code": "CUSTOMER_NOT_FOUND", "detail": "detail4", "field": "field2" }, { - "category": "PAYMENT_METHOD_ERROR", - "code": "ACCOUNT_UNUSABLE", + "category": "AUTHENTICATION_ERROR", + "code": "ONE_INSTRUMENT_EXPECTED", "detail": "detail5", "field": "field3" } @@ -131,20 +131,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md b/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md index 0aed9125..8ff58435 100644 --- a/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md +++ b/doc/models/bulk-upsert-merchant-custom-attributes-response-merchant-custom-attribute-upsert-response.md @@ -41,20 +41,20 @@ Represents a response for an individual upsert request in a [BulkUpsertMerchantC }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-merchant-custom-attributes-response.md b/doc/models/bulk-upsert-merchant-custom-attributes-response.md index 9a73b12b..7ca71768 100644 --- a/doc/models/bulk-upsert-merchant-custom-attributes-response.md +++ b/doc/models/bulk-upsert-merchant-custom-attributes-response.md @@ -43,8 +43,8 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "API_ERROR", - "code": "INVALID_FEES", + "category": "REFUND_ERROR", + "code": "INVALID_ENUM_VALUE", "detail": "detail1", "field": "field9" } @@ -73,14 +73,14 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_CONTENT_TYPE", "detail": "detail2", "field": "field0" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" } @@ -109,20 +109,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" }, { - "category": "RATE_LIMIT_ERROR", - "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "category": "API_ERROR", + "code": "CUSTOMER_NOT_FOUND", "detail": "detail4", "field": "field2" }, { - "category": "PAYMENT_METHOD_ERROR", - "code": "ACCOUNT_UNUSABLE", + "category": "AUTHENTICATION_ERROR", + "code": "ONE_INSTRUMENT_EXPECTED", "detail": "detail5", "field": "field3" } @@ -131,20 +131,20 @@ which contains a map of responses that each corresponds to an individual upsert }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/bulk-upsert-order-custom-attributes-response.md b/doc/models/bulk-upsert-order-custom-attributes-response.md index 25167928..9fe79b0a 100644 --- a/doc/models/bulk-upsert-order-custom-attributes-response.md +++ b/doc/models/bulk-upsert-order-custom-attributes-response.md @@ -20,20 +20,20 @@ Represents a response from a bulk upsert of order custom attributes. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } @@ -61,8 +61,8 @@ Represents a response from a bulk upsert of order custom attributes. }, "errors": [ { - "category": "API_ERROR", - "code": "INVALID_FEES", + "category": "REFUND_ERROR", + "code": "INVALID_ENUM_VALUE", "detail": "detail1", "field": "field9" } @@ -90,14 +90,14 @@ Represents a response from a bulk upsert of order custom attributes. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_CONTENT_TYPE", "detail": "detail2", "field": "field0" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" } @@ -125,20 +125,20 @@ Represents a response from a bulk upsert of order custom attributes. }, "errors": [ { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_LIMIT_EXCEEDED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "INVALID_FORM_VALUE", "detail": "detail3", "field": "field1" }, { - "category": "RATE_LIMIT_ERROR", - "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "category": "API_ERROR", + "code": "CUSTOMER_NOT_FOUND", "detail": "detail4", "field": "field2" }, { - "category": "PAYMENT_METHOD_ERROR", - "code": "ACCOUNT_UNUSABLE", + "category": "AUTHENTICATION_ERROR", + "code": "ONE_INSTRUMENT_EXPECTED", "detail": "detail5", "field": "field3" } diff --git a/doc/models/business-appointment-settings.md b/doc/models/business-appointment-settings.md index f8d84c2d..78d3a254 100644 --- a/doc/models/business-appointment-settings.md +++ b/doc/models/business-appointment-settings.md @@ -13,8 +13,8 @@ The service appointment settings, including where and how the service is provide | --- | --- | --- | --- | | `locationTypes` | [`string[] \| undefined`](../../doc/models/business-appointment-settings-booking-location-type.md) | Optional | Types of the location allowed for bookings.
See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values | | `alignmentTime` | [`string \| undefined`](../../doc/models/business-appointment-settings-alignment-time.md) | Optional | Time units of a service duration for bookings. | -| `minBookingLeadTimeSeconds` | `number \| undefined` | Optional | The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time. | -| `maxBookingLeadTimeSeconds` | `number \| undefined` | Optional | The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's starting time. | +| `minBookingLeadTimeSeconds` | `number \| undefined` | Optional | The minimum lead time in seconds before a service can be booked. A booking must be created at least this amount of time before its starting time. | +| `maxBookingLeadTimeSeconds` | `number \| undefined` | Optional | The maximum lead time in seconds before a service can be booked. A booking must be created at most this amount of time before its starting time. | | `anyTeamMemberBookingEnabled` | `boolean \| undefined` | Optional | Indicates whether a customer can choose from all available time slots and have a staff member assigned
automatically (`true`) or not (`false`). | | `multipleServiceBookingEnabled` | `boolean \| undefined` | Optional | Indicates whether a customer can book multiple services in a single online booking. | | `maxAppointmentsPerDayLimitType` | [`string \| undefined`](../../doc/models/business-appointment-settings-max-appointments-per-day-limit-type.md) | Optional | Types of daily appointment limits. | diff --git a/doc/models/calculate-loyalty-points-request.md b/doc/models/calculate-loyalty-points-request.md index 1db4891d..f896d587 100644 --- a/doc/models/calculate-loyalty-points-request.md +++ b/doc/models/calculate-loyalty-points-request.md @@ -23,7 +23,7 @@ Represents a [CalculateLoyaltyPoints](../../doc/api/loyalty.md#calculate-loyalty "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY", "transaction_amount_money": { "amount": 64, - "currency": "UYU" + "currency": "KWD" } } ``` diff --git a/doc/models/calculate-loyalty-points-response.md b/doc/models/calculate-loyalty-points-response.md index 3a9ac08b..a45433be 100644 --- a/doc/models/calculate-loyalty-points-response.md +++ b/doc/models/calculate-loyalty-points-response.md @@ -23,20 +23,20 @@ Represents a [CalculateLoyaltyPoints](../../doc/api/loyalty.md#calculate-loyalty "promotion_points": 12, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/calculate-order-response.md b/doc/models/calculate-order-response.md index 781882d2..d20eb3d0 100644 --- a/doc/models/calculate-order-response.md +++ b/doc/models/calculate-order-response.md @@ -208,20 +208,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-invoice-response.md b/doc/models/cancel-invoice-response.md index 4acd220a..c4573452 100644 --- a/doc/models/cancel-invoice-response.md +++ b/doc/models/cancel-invoice-response.md @@ -23,6 +23,7 @@ The response returned by the `CancelInvoice` request. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -94,20 +95,20 @@ The response returned by the `CancelInvoice` request. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-loyalty-promotion-response.md b/doc/models/cancel-loyalty-promotion-response.md index e607157b..18da3af4 100644 --- a/doc/models/cancel-loyalty-promotion-response.md +++ b/doc/models/cancel-loyalty-promotion-response.md @@ -57,20 +57,20 @@ Either `loyalty_promotion` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-payment-by-idempotency-key-response.md b/doc/models/cancel-payment-by-idempotency-key-response.md index a66cea54..f34e0561 100644 --- a/doc/models/cancel-payment-by-idempotency-key-response.md +++ b/doc/models/cancel-payment-by-idempotency-key-response.md @@ -21,20 +21,20 @@ On success, `errors` is empty. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-payment-response.md b/doc/models/cancel-payment-response.md index a5059fcf..f24c2c97 100644 --- a/doc/models/cancel-payment-response.md +++ b/doc/models/cancel-payment-response.md @@ -81,20 +81,20 @@ Defines the response returned by [CancelPayment](../../doc/api/payments.md#cance }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-subscription-response.md b/doc/models/cancel-subscription-response.md index b03146c2..1d6cbc4c 100644 --- a/doc/models/cancel-subscription-response.md +++ b/doc/models/cancel-subscription-response.md @@ -21,39 +21,42 @@ Defines output parameters in a response from the ```json { "subscription": { - "canceled_date": "2021-10-20", + "canceled_date": "2023-06-05", "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", - "created_at": "2021-10-20T21:53:10Z", + "created_at": "2022-01-19T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", - "id": "910afd30-464a-4e00-a8d8-2296eEXAMPLE", + "id": "910afd30-464a-4e00-a8d8-2296e", + "invoice_ids": [ + "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA" + ], "location_id": "S8GWD5R9QB376", - "paid_until_date": "2021-11-20", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", + "paid_until_date": "2023-12-31", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": { - "name": "My App" + "name": "My Application" }, - "start_date": "2021-10-20", + "start_date": "2022-01-19", "status": "ACTIVE", "timezone": "America/Los_Angeles", - "version": 1594311617331, - "plan_variation_id": "plan_variation_id8" + "version": 3 }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-terminal-action-response.md b/doc/models/cancel-terminal-action-response.md index a75af3b6..3ccd9473 100644 --- a/doc/models/cancel-terminal-action-response.md +++ b/doc/models/cancel-terminal-action-response.md @@ -34,20 +34,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-terminal-checkout-response.md b/doc/models/cancel-terminal-checkout-response.md index 8d2e41ba..ac4a1a86 100644 --- a/doc/models/cancel-terminal-checkout-response.md +++ b/doc/models/cancel-terminal-checkout-response.md @@ -43,6 +43,7 @@ "show_itemized_cart": false }, "id": "S1yDlPQx7slqO", + "location_id": "LOCATION_ID", "reference_id": "id36815", "status": "CANCELED", "updated_at": "2020-03-16T15:31:45.787Z", @@ -57,20 +58,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cancel-terminal-refund-response.md b/doc/models/cancel-terminal-refund-response.md index 1ee05ae1..97ad54e6 100644 --- a/doc/models/cancel-terminal-refund-response.md +++ b/doc/models/cancel-terminal-refund-response.md @@ -46,20 +46,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/capture-transaction-response.md b/doc/models/capture-transaction-response.md index 223ed1c4..2d4f0212 100644 --- a/doc/models/capture-transaction-response.md +++ b/doc/models/capture-transaction-response.md @@ -20,20 +20,20 @@ a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransacti { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/cash-drawer-shift-event.md b/doc/models/cash-drawer-shift-event.md index 39004702..78a96192 100644 --- a/doc/models/cash-drawer-shift-event.md +++ b/doc/models/cash-drawer-shift-event.md @@ -24,7 +24,7 @@ "event_type": "OTHER_TENDER_CANCELLED_PAYMENT", "event_money": { "amount": 148, - "currency": "HTG" + "currency": "AMD" }, "created_at": "created_at2", "description": "description0" diff --git a/doc/models/cash-payment-details.md b/doc/models/cash-payment-details.md index 8143ebf2..ed5331a8 100644 --- a/doc/models/cash-payment-details.md +++ b/doc/models/cash-payment-details.md @@ -21,11 +21,11 @@ Stores details about a cash payment. Contains only non-confidential information. { "buyer_supplied_money": { "amount": 114, - "currency": "UNKNOWN_CURRENCY" + "currency": "ZMK" }, "change_back_money": { "amount": 78, - "currency": "MUR" + "currency": "DJF" } } ``` diff --git a/doc/models/catalog-discount.md b/doc/models/catalog-discount.md index 8bdae23a..7124b6c1 100644 --- a/doc/models/catalog-discount.md +++ b/doc/models/catalog-discount.md @@ -41,7 +41,7 @@ A discount applicable to items. "percentage": "percentage8", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "pin_required": false } diff --git a/doc/models/catalog-info-response.md b/doc/models/catalog-info-response.md index 31725957..746d6724 100644 --- a/doc/models/catalog-info-response.md +++ b/doc/models/catalog-info-response.md @@ -32,20 +32,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/catalog-modifier.md b/doc/models/catalog-modifier.md index a679a6c3..f0597543 100644 --- a/doc/models/catalog-modifier.md +++ b/doc/models/catalog-modifier.md @@ -36,7 +36,7 @@ A modifier applicable to items at the time of sale. An example of a modifier is "name": "name0", "price_money": { "amount": 202, - "currency": "BBD" + "currency": "CNY" }, "ordinal": 80, "modifier_list_id": "modifier_list_id6", @@ -45,21 +45,21 @@ A modifier applicable to items at the time of sale. An example of a modifier is "location_id": "location_id5", "price_money": { "amount": 155, - "currency": "GYD" + "currency": "XPT" } }, { "location_id": "location_id6", "price_money": { "amount": 156, - "currency": "HKD" + "currency": "XTS" } }, { "location_id": "location_id7", "price_money": { "amount": 157, - "currency": "HNL" + "currency": "XXX" } } ] diff --git a/doc/models/catalog-quick-amount.md b/doc/models/catalog-quick-amount.md index 9df1497b..85788a22 100644 --- a/doc/models/catalog-quick-amount.md +++ b/doc/models/catalog-quick-amount.md @@ -23,7 +23,7 @@ Represents a Quick Amount in the Catalog. "type": "QUICK_AMOUNT_TYPE_MANUAL", "amount": { "amount": 0, - "currency": "NOK" + "currency": "MNT" }, "score": 148, "ordinal": 80 diff --git a/doc/models/catalog-quick-amounts-settings.md b/doc/models/catalog-quick-amounts-settings.md index 6cb42851..453bac7f 100644 --- a/doc/models/catalog-quick-amounts-settings.md +++ b/doc/models/catalog-quick-amounts-settings.md @@ -26,7 +26,7 @@ A parent Catalog Object model represents a set of Quick Amounts and the settings "type": "QUICK_AMOUNT_TYPE_MANUAL", "amount": { "amount": 244, - "currency": "AWG" + "currency": "SRD" }, "score": 228, "ordinal": 160 @@ -35,7 +35,7 @@ A parent Catalog Object model represents a set of Quick Amounts and the settings "type": "QUICK_AMOUNT_TYPE_AUTO", "amount": { "amount": 245, - "currency": "AZN" + "currency": "SSP" }, "score": 229, "ordinal": 161 diff --git a/doc/models/catalog-subscription-plan-variation.md b/doc/models/catalog-subscription-plan-variation.md index b52d6faa..a243c83d 100644 --- a/doc/models/catalog-subscription-plan-variation.md +++ b/doc/models/catalog-subscription-plan-variation.md @@ -28,7 +28,7 @@ For more information, see [Subscription Plans and Variations](https://developer. "periods": 241, "recurring_price_money": { "amount": 193, - "currency": "MOP" + "currency": "CHE" }, "ordinal": 207, "pricing": { @@ -40,7 +40,7 @@ For more information, see [Subscription Plans and Variations](https://developer. ], "price_money": { "amount": 251, - "currency": "SLL" + "currency": "NZD" } } } diff --git a/doc/models/catalog-subscription-plan.md b/doc/models/catalog-subscription-plan.md index 23c55773..2fb26ebe 100644 --- a/doc/models/catalog-subscription-plan.md +++ b/doc/models/catalog-subscription-plan.md @@ -31,7 +31,7 @@ For more information, see [Subscription Plans and Variations](https://developer. "periods": 241, "recurring_price_money": { "amount": 193, - "currency": "MOP" + "currency": "CHE" }, "ordinal": 207, "pricing": { @@ -43,7 +43,7 @@ For more information, see [Subscription Plans and Variations](https://developer. ], "price_money": { "amount": 251, - "currency": "SLL" + "currency": "NZD" } } }, @@ -53,7 +53,7 @@ For more information, see [Subscription Plans and Variations](https://developer. "periods": 242, "recurring_price_money": { "amount": 194, - "currency": "MRO" + "currency": "CHF" }, "ordinal": 208, "pricing": { @@ -64,7 +64,7 @@ For more information, see [Subscription Plans and Variations](https://developer. ], "price_money": { "amount": 252, - "currency": "SOS" + "currency": "OMR" } } } diff --git a/doc/models/charge-request-additional-recipient.md b/doc/models/charge-request-additional-recipient.md index 71eec654..497aac7f 100644 --- a/doc/models/charge-request-additional-recipient.md +++ b/doc/models/charge-request-additional-recipient.md @@ -24,7 +24,7 @@ Support is currently limited to USD, CAD and GBP currencies "description": "description0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/charge-response.md b/doc/models/charge-response.md index 1cda9259..1cea334b 100644 --- a/doc/models/charge-response.md +++ b/doc/models/charge-response.md @@ -70,12 +70,12 @@ One of `errors` or `transaction` is present in a given response (never both). "reason": "reason8", "amount_money": { "amount": 162, - "currency": "AOA" + "currency": "XPF" }, "status": "PENDING", "processing_fee_money": { "amount": 88, - "currency": "HUF" + "currency": "COU" }, "additional_recipients": [ { @@ -83,7 +83,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description5", "amount_money": { "amount": 59, - "currency": "LAK" + "currency": "BOB" }, "receivable_id": "receivable_id5" } @@ -98,12 +98,12 @@ One of `errors` or `transaction` is present in a given response (never both). "reason": "reason7", "amount_money": { "amount": 163, - "currency": "ARS" + "currency": "XPT" }, "status": "FAILED", "processing_fee_money": { "amount": 89, - "currency": "IDR" + "currency": "CRC" }, "additional_recipients": [ { @@ -111,7 +111,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description6", "amount_money": { "amount": 60, - "currency": "LBP" + "currency": "BOV" }, "receivable_id": "receivable_id6" }, @@ -120,7 +120,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description7", "amount_money": { "amount": 61, - "currency": "LKR" + "currency": "BRL" }, "receivable_id": "receivable_id7" } @@ -135,12 +135,12 @@ One of `errors` or `transaction` is present in a given response (never both). "reason": "reason6", "amount_money": { "amount": 164, - "currency": "AUD" + "currency": "XTS" }, "status": "REJECTED", "processing_fee_money": { "amount": 90, - "currency": "ILS" + "currency": "CUC" }, "additional_recipients": [ { @@ -148,7 +148,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description7", "amount_money": { "amount": 61, - "currency": "LKR" + "currency": "BRL" }, "receivable_id": "receivable_id7" }, @@ -157,7 +157,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description8", "amount_money": { "amount": 62, - "currency": "LRD" + "currency": "BSD" }, "receivable_id": "receivable_id8" }, @@ -166,7 +166,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description9", "amount_money": { "amount": 63, - "currency": "LSL" + "currency": "BTN" }, "receivable_id": "receivable_id9" } @@ -176,20 +176,20 @@ One of `errors` or `transaction` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/clone-order-response.md b/doc/models/clone-order-response.md index bfb73c40..ad4f3cf3 100644 --- a/doc/models/clone-order-response.md +++ b/doc/models/clone-order-response.md @@ -310,20 +310,20 @@ a request to the [CloneOrder](../../doc/api/orders.md#clone-order) endpoint. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/complete-payment-response.md b/doc/models/complete-payment-response.md index af5e20b9..1eb4183d 100644 --- a/doc/models/complete-payment-response.md +++ b/doc/models/complete-payment-response.md @@ -85,25 +85,25 @@ Defines the response returned by[CompletePayment](../../doc/api/payments.md#comp "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o", "tip_money": { "amount": 174, - "currency": "PAB" + "currency": "LYD" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-break-type-response.md b/doc/models/create-break-type-response.md index faeed609..91421a80 100644 --- a/doc/models/create-break-type-response.md +++ b/doc/models/create-break-type-response.md @@ -32,20 +32,20 @@ the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-card-response.md b/doc/models/create-card-response.md index a130b2dc..5f1564a1 100644 --- a/doc/models/create-card-response.md +++ b/doc/models/create-card-response.md @@ -49,20 +49,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-catalog-image-response.md b/doc/models/create-catalog-image-response.md index 9fe3dad2..04fa28e8 100644 --- a/doc/models/create-catalog-image-response.md +++ b/doc/models/create-catalog-image-response.md @@ -59,20 +59,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-checkout-response.md b/doc/models/create-checkout-response.md index 192edcf7..4efe079b 100644 --- a/doc/models/create-checkout-response.md +++ b/doc/models/create-checkout-response.md @@ -155,20 +155,20 @@ a request to the `CreateCheckout` endpoint. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-customer-card-response.md b/doc/models/create-customer-card-response.md index dd6bbe61..e5ff2b14 100644 --- a/doc/models/create-customer-card-response.md +++ b/doc/models/create-customer-card-response.md @@ -39,20 +39,20 @@ Either `errors` or `card` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-customer-custom-attribute-definition-response.md b/doc/models/create-customer-custom-attribute-definition-response.md index edbb644d..58722784 100644 --- a/doc/models/create-customer-custom-attribute-definition-response.md +++ b/doc/models/create-customer-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-customer-group-response.md b/doc/models/create-customer-group-response.md index 2a57b1ad..487b5192 100644 --- a/doc/models/create-customer-group-response.md +++ b/doc/models/create-customer-group-response.md @@ -29,20 +29,20 @@ Either `errors` or `group` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-customer-response.md b/doc/models/create-customer-response.md index b4d1528f..f209c1de 100644 --- a/doc/models/create-customer-response.md +++ b/doc/models/create-customer-response.md @@ -56,20 +56,20 @@ Either `errors` or `customer` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-device-code-request.md b/doc/models/create-device-code-request.md index b8672f06..af7ce924 100644 --- a/doc/models/create-device-code-request.md +++ b/doc/models/create-device-code-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string` | Required | A unique string that identifies this CreateDeviceCode request. Keys can
be any valid string but must be unique for every CreateDeviceCode request.

See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | +| `idempotencyKey` | `string` | Required | A unique string that identifies this CreateDeviceCode request. Keys can
be any valid string but must be unique for every CreateDeviceCode request.

See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | | `deviceCode` | [`DeviceCode`](../../doc/models/device-code.md) | Required | - | ## Example (as JSON) diff --git a/doc/models/create-device-code-response.md b/doc/models/create-device-code-response.md index 2a2ccd3b..2cfeb02c 100644 --- a/doc/models/create-device-code-response.md +++ b/doc/models/create-device-code-response.md @@ -30,20 +30,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-dispute-evidence-file-response.md b/doc/models/create-dispute-evidence-file-response.md index 4ab62022..bae66b2c 100644 --- a/doc/models/create-dispute-evidence-file-response.md +++ b/doc/models/create-dispute-evidence-file-response.md @@ -31,20 +31,20 @@ Defines the fields in a `CreateDisputeEvidenceFile` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-dispute-evidence-text-response.md b/doc/models/create-dispute-evidence-text-response.md index 5d45786b..1a1b6051 100644 --- a/doc/models/create-dispute-evidence-text-response.md +++ b/doc/models/create-dispute-evidence-text-response.md @@ -32,20 +32,20 @@ Defines the fields in a `CreateDisputeEvidenceText` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-gift-card-activity-request.md b/doc/models/create-gift-card-activity-request.md index 7abb68ca..026fa2c3 100644 --- a/doc/models/create-gift-card-activity-request.md +++ b/doc/models/create-gift-card-activity-request.md @@ -31,7 +31,7 @@ A request to create a gift card activity. "gift_card_gan": "gift_card_gan2", "gift_card_balance_money": { "amount": 172, - "currency": "XXX" + "currency": "WST" } }, "idempotency_key": "U16kfr-kA70er-q4Rsym-7U7NnY" diff --git a/doc/models/create-gift-card-activity-response.md b/doc/models/create-gift-card-activity-response.md index c120890b..ec1aa395 100644 --- a/doc/models/create-gift-card-activity-response.md +++ b/doc/models/create-gift-card-activity-response.md @@ -41,20 +41,20 @@ The response might contain a set of `Error` objects if the request resulted in e }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-gift-card-request.md b/doc/models/create-gift-card-request.md index fc99055c..1c7b115a 100644 --- a/doc/models/create-gift-card-request.md +++ b/doc/models/create-gift-card-request.md @@ -26,7 +26,7 @@ Represents a [CreateGiftCard](../../doc/api/gift-cards.md#create-gift-card) requ "state": "ACTIVE", "balance_money": { "amount": 250, - "currency": "DKK" + "currency": "CHF" }, "gan": "gan6" }, diff --git a/doc/models/create-gift-card-response.md b/doc/models/create-gift-card-response.md index bf9c7b24..5b71019c 100644 --- a/doc/models/create-gift-card-response.md +++ b/doc/models/create-gift-card-response.md @@ -33,20 +33,20 @@ resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-invoice-request.md b/doc/models/create-invoice-request.md index c1e70ae1..e649c1f7 100644 --- a/doc/models/create-invoice-request.md +++ b/doc/models/create-invoice-request.md @@ -24,6 +24,7 @@ Describes a `CreateInvoice` request. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "custom_fields": [ diff --git a/doc/models/create-invoice-response.md b/doc/models/create-invoice-response.md index 991b3acd..1c4b2cba 100644 --- a/doc/models/create-invoice-response.md +++ b/doc/models/create-invoice-response.md @@ -23,6 +23,7 @@ The response returned by the `CreateInvoice` request. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -94,20 +95,20 @@ The response returned by the `CreateInvoice` request. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-location-custom-attribute-definition-response.md b/doc/models/create-location-custom-attribute-definition-response.md index 2926edf7..565c704b 100644 --- a/doc/models/create-location-custom-attribute-definition-response.md +++ b/doc/models/create-location-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-location-response.md b/doc/models/create-location-response.md index 30d128e9..68a4a22f 100644 --- a/doc/models/create-location-response.md +++ b/doc/models/create-location-response.md @@ -51,20 +51,20 @@ The response object returned by the [CreateLocation](../../doc/api/locations.md# }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-loyalty-account-response.md b/doc/models/create-loyalty-account-response.md index 42f9f7c1..0487ce10 100644 --- a/doc/models/create-loyalty-account-response.md +++ b/doc/models/create-loyalty-account-response.md @@ -35,20 +35,20 @@ A response that includes loyalty account created. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-loyalty-promotion-response.md b/doc/models/create-loyalty-promotion-response.md index 260eddee..71b99a63 100644 --- a/doc/models/create-loyalty-promotion-response.md +++ b/doc/models/create-loyalty-promotion-response.md @@ -57,20 +57,20 @@ Either `loyalty_promotion` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-loyalty-reward-response.md b/doc/models/create-loyalty-reward-response.md index fe69017a..15b0972a 100644 --- a/doc/models/create-loyalty-reward-response.md +++ b/doc/models/create-loyalty-reward-response.md @@ -30,20 +30,20 @@ A response that includes the loyalty reward created. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-merchant-custom-attribute-definition-response.md b/doc/models/create-merchant-custom-attribute-definition-response.md index 34587908..b83ab70f 100644 --- a/doc/models/create-merchant-custom-attribute-definition-response.md +++ b/doc/models/create-merchant-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-mobile-authorization-code-response.md b/doc/models/create-mobile-authorization-code-response.md index 22505aa0..95b2fb99 100644 --- a/doc/models/create-mobile-authorization-code-response.md +++ b/doc/models/create-mobile-authorization-code-response.md @@ -24,20 +24,20 @@ a request to the `CreateMobileAuthorizationCode` endpoint. "expires_at": "2019-01-10T19:42:08Z", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-order-custom-attribute-definition-response.md b/doc/models/create-order-custom-attribute-definition-response.md index d12c7bd8..2324de3d 100644 --- a/doc/models/create-order-custom-attribute-definition-response.md +++ b/doc/models/create-order-custom-attribute-definition-response.md @@ -33,20 +33,20 @@ Represents a response from creating an order custom attribute definition. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-order-response.md b/doc/models/create-order-response.md index daf0a97c..1b16bde5 100644 --- a/doc/models/create-order-response.md +++ b/doc/models/create-order-response.md @@ -312,20 +312,20 @@ Either `errors` or `order` is present in a given response, but never both. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-payment-link-response.md b/doc/models/create-payment-link-response.md index 7f0afa82..e8bf62fe 100644 --- a/doc/models/create-payment-link-response.md +++ b/doc/models/create-payment-link-response.md @@ -19,20 +19,20 @@ { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-payment-request.md b/doc/models/create-payment-request.md index 7271da92..f89451c9 100644 --- a/doc/models/create-payment-request.md +++ b/doc/models/create-payment-request.md @@ -56,7 +56,7 @@ Describes a request to create a payment using "source_id": "ccof:GaJGNaZa8x4OgDJn4GB", "tip_money": { "amount": 190, - "currency": "CHE" + "currency": "ZMK" }, "delay_duration": "delay_duration2", "delay_action": "delay_action0" diff --git a/doc/models/create-payment-response.md b/doc/models/create-payment-response.md index cb5745fe..b7957571 100644 --- a/doc/models/create-payment-response.md +++ b/doc/models/create-payment-response.md @@ -86,25 +86,25 @@ present, or it might be present with a status of `FAILED`. "version_token": "TPtNEOBOa6Qq6E3C3IjckSVOM6b3hMbfhjvTxHBQUsB6o", "tip_money": { "amount": 174, - "currency": "PAB" + "currency": "LYD" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-refund-response.md b/doc/models/create-refund-response.md index 77af77c4..7bcf3663 100644 --- a/doc/models/create-refund-response.md +++ b/doc/models/create-refund-response.md @@ -46,25 +46,25 @@ One of `errors` or `refund` is present in a given response (never both). "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF", "processing_fee_money": { "amount": 46, - "currency": "ILS" + "currency": "TMT" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-shift-response.md b/doc/models/create-shift-response.md index 046e55f7..404cd668 100644 --- a/doc/models/create-shift-response.md +++ b/doc/models/create-shift-response.md @@ -48,25 +48,26 @@ the request resulted in errors. "amount": 1100, "currency": "USD" }, + "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", "title": "Barista" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-subscription-request.md b/doc/models/create-subscription-request.md index 5fda2753..57ad846b 100644 --- a/doc/models/create-subscription-request.md +++ b/doc/models/create-subscription-request.md @@ -14,7 +14,6 @@ Defines input parameters in a request to the | --- | --- | --- | --- | | `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies this `CreateSubscription` request.
If you do not provide a unique string (or provide an empty string as the value),
the endpoint treats each request as independent.

For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). | | `locationId` | `string` | Required | The ID of the location the subscription is associated with.
**Constraints**: *Minimum Length*: `1` | -| `planId` | `string \| undefined` | Optional | The ID of the [subscription plan](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations) created using the Catalog API.

Deprecated in favour of `plan_variation_id`.

For more information, see
[Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan) and
[Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough). | | `planVariationId` | `string \| undefined` | Optional | The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. | | `customerId` | `string` | Required | The ID of the [customer](entity:Customer) subscribing to the subscription plan variation.
**Constraints**: *Minimum Length*: `1` | | `startDate` | `string \| undefined` | Optional | The `YYYY-MM-DD`-formatted date to start the subscription.
If it is unspecified, the subscription starts immediately. | @@ -34,19 +33,20 @@ Defines input parameters in a request to the "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", "location_id": "S8GWD5R9QB376", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", - "price_override_money": { - "amount": 100, - "currency": "USD" - }, + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0 + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": { - "name": "My App" + "name": "My Application" }, - "start_date": "2021-10-20", - "tax_percentage": "5", + "start_date": "2023-06-20", "timezone": "America/Los_Angeles", - "plan_variation_id": "plan_variation_id4", - "canceled_date": "canceled_date6" + "canceled_date": "canceled_date6", + "tax_percentage": "tax_percentage6" } ``` diff --git a/doc/models/create-subscription-response.md b/doc/models/create-subscription-response.md index 874a041c..3dfddbaf 100644 --- a/doc/models/create-subscription-response.md +++ b/doc/models/create-subscription-response.md @@ -21,41 +21,43 @@ Defines output parameters in a response from the { "subscription": { "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", - "created_at": "2021-10-20T21:53:10Z", + "created_at": "2023-06-20T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", "location_id": "S8GWD5R9QB376", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", - "price_override_money": { - "amount": 100, - "currency": "USD" - }, + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": { - "name": "My App" + "name": "My Application" }, - "start_date": "2021-10-20", - "status": "PENDING", - "tax_percentage": "5", + "start_date": "2023-06-20", + "status": "ACTIVE", "timezone": "America/Los_Angeles", - "version": 1594155459464, - "plan_variation_id": "plan_variation_id8" + "version": 1 }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-team-member-request.md b/doc/models/create-team-member-request.md index a4d2f433..6bf45cd5 100644 --- a/doc/models/create-team-member-request.md +++ b/doc/models/create-team-member-request.md @@ -11,7 +11,7 @@ Represents a create request for a `TeamMember` object. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies this `CreateTeamMember` request.
Keys can be any valid string, but must be unique for every request.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).

The minimum length is 1 and the maximum length is 45. | +| `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies this `CreateTeamMember` request.
Keys can be any valid string, but must be unique for every request.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).

The minimum length is 1 and the maximum length is 45. | | `teamMember` | [`TeamMember \| undefined`](../../doc/models/team-member.md) | Optional | A record representing an individual team member for a business. | ## Example (as JSON) diff --git a/doc/models/create-team-member-response.md b/doc/models/create-team-member-response.md index 0da45948..476f2ddb 100644 --- a/doc/models/create-team-member-response.md +++ b/doc/models/create-team-member-response.md @@ -39,20 +39,20 @@ Represents a response from a create request containing the created `TeamMember` }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-terminal-action-request.md b/doc/models/create-terminal-action-request.md index f4b4526d..39e1d1b5 100644 --- a/doc/models/create-terminal-action-request.md +++ b/doc/models/create-terminal-action-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateAction` request. Keys can be any valid string
but must be unique for every `CreateAction` request.

See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more
information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | +| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateAction` request. Keys can be any valid string
but must be unique for every `CreateAction` request.

See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more
information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | | `action` | [`TerminalAction`](../../doc/models/terminal-action.md) | Required | Represents an action processed by the Square Terminal. | ## Example (as JSON) diff --git a/doc/models/create-terminal-action-response.md b/doc/models/create-terminal-action-response.md index c8d44dfb..187bb71c 100644 --- a/doc/models/create-terminal-action-response.md +++ b/doc/models/create-terminal-action-response.md @@ -34,20 +34,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-terminal-checkout-request.md b/doc/models/create-terminal-checkout-request.md index e1540b50..b85cc778 100644 --- a/doc/models/create-terminal-checkout-request.md +++ b/doc/models/create-terminal-checkout-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but
must be unique for every `CreateCheckout` request.

See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | +| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but
must be unique for every `CreateCheckout` request.

See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | | `checkout` | [`TerminalCheckout`](../../doc/models/terminal-checkout.md) | Required | Represents a checkout processed by the Square Terminal. | ## Example (as JSON) diff --git a/doc/models/create-terminal-checkout-response.md b/doc/models/create-terminal-checkout-response.md index 7f086a85..872e0eca 100644 --- a/doc/models/create-terminal-checkout-response.md +++ b/doc/models/create-terminal-checkout-response.md @@ -42,6 +42,7 @@ "show_itemized_cart": false }, "id": "08YceKh7B3ZqO", + "location_id": "LOCATION_ID", "note": "A brief note", "payment_type": "CARD_PRESENT", "reference_id": "id11572", @@ -57,20 +58,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-terminal-refund-request.md b/doc/models/create-terminal-refund-request.md index 47a1cbf5..8126be2f 100644 --- a/doc/models/create-terminal-refund-request.md +++ b/doc/models/create-terminal-refund-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateRefund` request. Keys can be any valid string but
must be unique for every `CreateRefund` request.

See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | +| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateRefund` request. Keys can be any valid string but
must be unique for every `CreateRefund` request.

See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | | `refund` | [`TerminalRefund \| undefined`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. | ## Example (as JSON) diff --git a/doc/models/create-terminal-refund-response.md b/doc/models/create-terminal-refund-response.md index 48b1c3f2..c02aad7c 100644 --- a/doc/models/create-terminal-refund-response.md +++ b/doc/models/create-terminal-refund-response.md @@ -45,20 +45,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-vendor-response.md b/doc/models/create-vendor-response.md index a29ed23c..c5987cb2 100644 --- a/doc/models/create-vendor-response.md +++ b/doc/models/create-vendor-response.md @@ -20,20 +20,20 @@ Represents an output from a call to [CreateVendor](../../doc/api/vendors.md#crea { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/create-webhook-subscription-response.md b/doc/models/create-webhook-subscription-response.md index 76eb1f9f..812ea0b9 100644 --- a/doc/models/create-webhook-subscription-response.md +++ b/doc/models/create-webhook-subscription-response.md @@ -38,20 +38,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/currency.md b/doc/models/currency.md index 6dc03cf2..e22a6aab 100644 --- a/doc/models/currency.md +++ b/doc/models/currency.md @@ -193,4 +193,5 @@ to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). | `ZMK` | Zambian kwacha | | `ZMW` | Zambian kwacha | | `BTC` | Bitcoin | +| `XUS` | USD Coin | diff --git a/doc/models/delete-break-type-response.md b/doc/models/delete-break-type-response.md index 7d133c1f..91f719a1 100644 --- a/doc/models/delete-break-type-response.md +++ b/doc/models/delete-break-type-response.md @@ -20,20 +20,20 @@ of `Error` objects if the request resulted in errors. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-catalog-object-response.md b/doc/models/delete-catalog-object-response.md index 7c8d854e..4d1d68ed 100644 --- a/doc/models/delete-catalog-object-response.md +++ b/doc/models/delete-catalog-object-response.md @@ -24,20 +24,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-customer-card-response.md b/doc/models/delete-customer-card-response.md index 2cc49f4f..ac468a72 100644 --- a/doc/models/delete-customer-card-response.md +++ b/doc/models/delete-customer-card-response.md @@ -20,20 +20,20 @@ a request to the `DeleteCustomerCard` endpoint. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-customer-custom-attribute-definition-response.md b/doc/models/delete-customer-custom-attribute-definition-response.md index 16e427d5..462c5699 100644 --- a/doc/models/delete-customer-custom-attribute-definition-response.md +++ b/doc/models/delete-customer-custom-attribute-definition-response.md @@ -19,20 +19,20 @@ Represents a response from a delete request containing error messages if there a { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-customer-custom-attribute-response.md b/doc/models/delete-customer-custom-attribute-response.md index 9bbda4e3..c28600cc 100644 --- a/doc/models/delete-customer-custom-attribute-response.md +++ b/doc/models/delete-customer-custom-attribute-response.md @@ -20,20 +20,20 @@ Either an empty object `{}` (for a successful deletion) or `errors` is present i { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-customer-group-response.md b/doc/models/delete-customer-group-response.md index acc14d30..ac0b41af 100644 --- a/doc/models/delete-customer-group-response.md +++ b/doc/models/delete-customer-group-response.md @@ -20,20 +20,20 @@ a request to the [DeleteCustomerGroup](../../doc/api/customer-groups.md#delete-c { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-customer-response.md b/doc/models/delete-customer-response.md index 05a2421b..4ef87564 100644 --- a/doc/models/delete-customer-response.md +++ b/doc/models/delete-customer-response.md @@ -20,20 +20,20 @@ a request to the `DeleteCustomer` endpoint. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-dispute-evidence-response.md b/doc/models/delete-dispute-evidence-response.md index 86910a1c..e5bbd782 100644 --- a/doc/models/delete-dispute-evidence-response.md +++ b/doc/models/delete-dispute-evidence-response.md @@ -19,20 +19,20 @@ Defines the fields in a `DeleteDisputeEvidence` response. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-invoice-response.md b/doc/models/delete-invoice-response.md index 74661db4..466cf4ac 100644 --- a/doc/models/delete-invoice-response.md +++ b/doc/models/delete-invoice-response.md @@ -19,20 +19,20 @@ Describes a `DeleteInvoice` response. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-location-custom-attribute-definition-response.md b/doc/models/delete-location-custom-attribute-definition-response.md index a4b6eba6..57089121 100644 --- a/doc/models/delete-location-custom-attribute-definition-response.md +++ b/doc/models/delete-location-custom-attribute-definition-response.md @@ -19,20 +19,20 @@ Represents a response from a delete request containing error messages if there a { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-location-custom-attribute-response.md b/doc/models/delete-location-custom-attribute-response.md index 24d6158f..442748ab 100644 --- a/doc/models/delete-location-custom-attribute-response.md +++ b/doc/models/delete-location-custom-attribute-response.md @@ -20,20 +20,20 @@ Either an empty object `{}` (for a successful deletion) or `errors` is present i { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-loyalty-reward-response.md b/doc/models/delete-loyalty-reward-response.md index 40b8d1b1..9d9e0385 100644 --- a/doc/models/delete-loyalty-reward-response.md +++ b/doc/models/delete-loyalty-reward-response.md @@ -19,20 +19,20 @@ A response returned by the API call. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-merchant-custom-attribute-definition-response.md b/doc/models/delete-merchant-custom-attribute-definition-response.md index f2bc872e..9824d8c4 100644 --- a/doc/models/delete-merchant-custom-attribute-definition-response.md +++ b/doc/models/delete-merchant-custom-attribute-definition-response.md @@ -19,20 +19,20 @@ Represents a response from a delete request containing error messages if there a { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-merchant-custom-attribute-response.md b/doc/models/delete-merchant-custom-attribute-response.md index 81211783..dc34b566 100644 --- a/doc/models/delete-merchant-custom-attribute-response.md +++ b/doc/models/delete-merchant-custom-attribute-response.md @@ -20,20 +20,20 @@ Either an empty object `{}` (for a successful deletion) or `errors` is present i { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-order-custom-attribute-definition-response.md b/doc/models/delete-order-custom-attribute-definition-response.md index 78d651e6..a71598c5 100644 --- a/doc/models/delete-order-custom-attribute-definition-response.md +++ b/doc/models/delete-order-custom-attribute-definition-response.md @@ -19,20 +19,20 @@ Represents a response from deleting an order custom attribute definition. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-order-custom-attribute-response.md b/doc/models/delete-order-custom-attribute-response.md index c0f4c545..d5b0d700 100644 --- a/doc/models/delete-order-custom-attribute-response.md +++ b/doc/models/delete-order-custom-attribute-response.md @@ -19,20 +19,20 @@ Represents a response from deleting an order custom attribute. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-payment-link-response.md b/doc/models/delete-payment-link-response.md index 83c45c9f..8f2a27dc 100644 --- a/doc/models/delete-payment-link-response.md +++ b/doc/models/delete-payment-link-response.md @@ -21,20 +21,20 @@ "id": "MQASNYL6QB6DFCJ3", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-shift-response.md b/doc/models/delete-shift-response.md index 645898ef..6142a742 100644 --- a/doc/models/delete-shift-response.md +++ b/doc/models/delete-shift-response.md @@ -20,20 +20,20 @@ The response to a request to delete a `Shift`. The response might contain a set { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-snippet-response.md b/doc/models/delete-snippet-response.md index f4666782..d29611c5 100644 --- a/doc/models/delete-snippet-response.md +++ b/doc/models/delete-snippet-response.md @@ -19,20 +19,20 @@ Represents a `DeleteSnippet` response. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-subscription-action-response.md b/doc/models/delete-subscription-action-response.md index 700090ef..903d606a 100644 --- a/doc/models/delete-subscription-action-response.md +++ b/doc/models/delete-subscription-action-response.md @@ -20,45 +20,45 @@ endpoint. ```json { "subscription": { - "charged_through_date": "2021-11-20", - "created_at": "2021-10-20T21:53:10Z", - "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "charged_through_date": "2023-11-20", + "created_at": "2022-07-27T21:53:10Z", + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", "id": "8151fc89-da15-4eb9-a685-1a70883cebfc", "invoice_ids": [ - "grebK0Q_l8H4fqoMMVvt-Q", - "rcX_i3sNmHTGKhI4W2mceA" + "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA" ], "location_id": "S8GWD5R9QB376", - "paid_until_date": "2021-11-20", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", + "paid_until_date": "2024-08-01", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "price_override_money": { - "amount": 1000, + "amount": 25000, "currency": "USD" }, "source": { - "name": "My App" + "name": "My Application" }, - "start_date": "2021-10-20", + "start_date": "2022-07-27", "status": "ACTIVE", - "timezone": "America/Los_Angeles", - "plan_variation_id": "plan_variation_id8" + "timezone": "America/Los_Angeles" }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/delete-webhook-subscription-response.md b/doc/models/delete-webhook-subscription-response.md index 25862986..6ef54460 100644 --- a/doc/models/delete-webhook-subscription-response.md +++ b/doc/models/delete-webhook-subscription-response.md @@ -20,20 +20,20 @@ a request to the [DeleteWebhookSubscription](../../doc/api/webhook-subscriptions { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/deprecated-create-dispute-evidence-file-response.md b/doc/models/deprecated-create-dispute-evidence-file-response.md index 477ee505..c948b267 100644 --- a/doc/models/deprecated-create-dispute-evidence-file-response.md +++ b/doc/models/deprecated-create-dispute-evidence-file-response.md @@ -32,20 +32,20 @@ Defines the fields in a `DeprecatedCreateDisputeEvidenceFile` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/deprecated-create-dispute-evidence-text-response.md b/doc/models/deprecated-create-dispute-evidence-text-response.md index 0561afa8..560bd773 100644 --- a/doc/models/deprecated-create-dispute-evidence-text-response.md +++ b/doc/models/deprecated-create-dispute-evidence-text-response.md @@ -32,20 +32,20 @@ Defines the fields in a `DeprecatedCreateDisputeEvidenceText` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/disable-card-response.md b/doc/models/disable-card-response.md index e7429326..9d509b9a 100644 --- a/doc/models/disable-card-response.md +++ b/doc/models/disable-card-response.md @@ -49,20 +49,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/dismiss-terminal-action-response.md b/doc/models/dismiss-terminal-action-response.md index ea1031c1..0797b09c 100644 --- a/doc/models/dismiss-terminal-action-response.md +++ b/doc/models/dismiss-terminal-action-response.md @@ -40,20 +40,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/dispute.md b/doc/models/dispute.md index 8686c745..8b92fdae 100644 --- a/doc/models/dispute.md +++ b/doc/models/dispute.md @@ -36,7 +36,7 @@ Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview "id": "id0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reason": "NOT_AS_DESCRIBED", "state": "PROCESSING" diff --git a/doc/models/employee-wage.md b/doc/models/employee-wage.md index 591420d1..5b323df4 100644 --- a/doc/models/employee-wage.md +++ b/doc/models/employee-wage.md @@ -25,7 +25,7 @@ The hourly wage rate that an employee earns on a `Shift` for doing the job speci "title": "title4", "hourly_rate": { "amount": 172, - "currency": "TJS" + "currency": "OMR" } } ``` diff --git a/doc/models/error-category.md b/doc/models/error-category.md index 90648a1b..2fb6f113 100644 --- a/doc/models/error-category.md +++ b/doc/models/error-category.md @@ -19,4 +19,5 @@ request to the Connect API. | `PAYMENT_METHOD_ERROR` | An error occurred while processing a payment method. Most commonly,
the details of the payment method were invalid (such as a card's CVV
or expiration date). | | `REFUND_ERROR` | An error occurred while attempting to process a refund. | | `MERCHANT_SUBSCRIPTION_ERROR` | An error occurred when checking a merchant subscription status | +| `EXTERNAL_VENDOR_ERROR` | An error that is returned from an external vendor's API | diff --git a/doc/models/error-code.md b/doc/models/error-code.md index d768673d..40326f9a 100644 --- a/doc/models/error-code.md +++ b/doc/models/error-code.md @@ -68,6 +68,7 @@ Square API. | `INVALID_DATE` | The subscription cannot be paused/resumed on the given date. | | `UNSUPPORTED_COUNTRY` | The API request references an unsupported country. | | `UNSUPPORTED_CURRENCY` | The API request references an unsupported currency. | +| `APPLE_TTP_PIN_TOKEN` | The payment was declined by the card issuer during an Apple Tap to Pay (TTP)
transaction with a request for the card's PIN. This code will be returned alongside
`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an
issuer-provided token in the `details` field that is needed to initiate the PIN
collection flow on the iOS device. | | `CARD_EXPIRED` | The card issuer declined the request because the card is expired. | | `INVALID_EXPIRATION` | The expiration date for the payment card is invalid. For example,
it indicates a date in the past. | | `INVALID_EXPIRATION_YEAR` | The expiration year for the payment card is invalid. For example,
it indicates a year in the past or contains invalid characters. | @@ -131,6 +132,9 @@ Square API. | `CARD_PRESENCE_REQUIRED` | The transaction requires that a card be present. | | `UNSUPPORTED_SOURCE_TYPE` | The API request references an unsupported source type. | | `CARD_MISMATCH` | The provided card does not match what is expected. | +| `PLAID_ERROR` | Generic plaid error | +| `PLAID_ERROR_ITEM_LOGIN_REQUIRED` | Plaid error - ITEM_LOGIN_REQUIRED | +| `PLAID_ERROR_RATE_LIMIT` | Plaid error - RATE_LIMIT | | `CARD_DECLINED` | The card was declined. | | `VERIFY_CVV_FAILURE` | The CVV could not be verified. | | `VERIFY_AVS_FAILURE` | The AVS could not be verified. | diff --git a/doc/models/error.md b/doc/models/error.md index b53a0a17..cd3cbf6d 100644 --- a/doc/models/error.md +++ b/doc/models/error.md @@ -22,8 +22,8 @@ See [Handling errors](https://developer.squareup.com/docs/build-basics/handling- ```json { - "category": "RATE_LIMIT_ERROR", - "code": "UNEXPECTED_VALUE", + "category": "API_ERROR", + "code": "VERIFY_AVS_FAILURE", "detail": "detail6", "field": "field6" } diff --git a/doc/models/external-payment-details.md b/doc/models/external-payment-details.md index f509cd60..1a0b767c 100644 --- a/doc/models/external-payment-details.md +++ b/doc/models/external-payment-details.md @@ -27,7 +27,7 @@ For more information, see "source_id": "source_id6", "source_fee_money": { "amount": 130, - "currency": "JMD" + "currency": "BTC" } } ``` diff --git a/doc/models/get-bank-account-by-v1-id-response.md b/doc/models/get-bank-account-by-v1-id-response.md index 01d2b774..3e67dcc5 100644 --- a/doc/models/get-bank-account-by-v1-id-response.md +++ b/doc/models/get-bank-account-by-v1-id-response.md @@ -39,20 +39,20 @@ Response object returned by GetBankAccountByV1Id. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-bank-account-response.md b/doc/models/get-bank-account-response.md index 1a063ce2..1dc7cab8 100644 --- a/doc/models/get-bank-account-response.md +++ b/doc/models/get-bank-account-response.md @@ -39,20 +39,20 @@ Response object returned by `GetBankAccount`. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-break-type-response.md b/doc/models/get-break-type-response.md index b4cc6f3e..485efd54 100644 --- a/doc/models/get-break-type-response.md +++ b/doc/models/get-break-type-response.md @@ -32,20 +32,20 @@ the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-device-code-response.md b/doc/models/get-device-code-response.md index 6e1ebe2a..207ac77a 100644 --- a/doc/models/get-device-code-response.md +++ b/doc/models/get-device-code-response.md @@ -30,20 +30,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-employee-wage-response.md b/doc/models/get-employee-wage-response.md index c91d6977..16143611 100644 --- a/doc/models/get-employee-wage-response.md +++ b/doc/models/get-employee-wage-response.md @@ -31,20 +31,20 @@ the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-invoice-response.md b/doc/models/get-invoice-response.md index 3db0f4d5..0f4ff4d5 100644 --- a/doc/models/get-invoice-response.md +++ b/doc/models/get-invoice-response.md @@ -23,6 +23,7 @@ Describes a `GetInvoice` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -94,20 +95,20 @@ Describes a `GetInvoice` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-payment-refund-response.md b/doc/models/get-payment-refund-response.md index 7e1ce077..fb1e05e8 100644 --- a/doc/models/get-payment-refund-response.md +++ b/doc/models/get-payment-refund-response.md @@ -61,20 +61,20 @@ present or it might be present in a FAILED state. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-payment-response.md b/doc/models/get-payment-response.md index fcb9de73..b76e4025 100644 --- a/doc/models/get-payment-response.md +++ b/doc/models/get-payment-response.md @@ -85,25 +85,25 @@ Defines the response returned by [GetPayment](../../doc/api/payments.md#get-paym "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o", "tip_money": { "amount": 174, - "currency": "PAB" + "currency": "LYD" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-payout-response.md b/doc/models/get-payout-response.md index dc389726..80f37537 100644 --- a/doc/models/get-payout-response.md +++ b/doc/models/get-payout-response.md @@ -20,7 +20,7 @@ "amount_money": { "amount": -103, "currency_code": "USD", - "currency": "HKD" + "currency": "AFN" }, "arrival_date": "2022-03-24", "created_at": "2022-03-24T03:07:09Z", @@ -37,20 +37,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-shift-response.md b/doc/models/get-shift-response.md index 7a5e54d3..64ac21c9 100644 --- a/doc/models/get-shift-response.md +++ b/doc/models/get-shift-response.md @@ -48,25 +48,26 @@ the request resulted in errors. "amount": 1457, "currency": "USD" }, + "job_id": "N4YKVLzFj3oGtNocqoYHYpW3", "title": "Cashier" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-team-member-wage-response.md b/doc/models/get-team-member-wage-response.md index 917edaeb..6e4851c1 100644 --- a/doc/models/get-team-member-wage-response.md +++ b/doc/models/get-team-member-wage-response.md @@ -26,26 +26,26 @@ the request resulted in errors. "currency": "USD" }, "id": "pXS3qCv7BERPnEGedM4S8mhm", + "job_id": "jxJNN6eCJsLrhg5UFJrDWDGE", "team_member_id": "33fJchumvVdJwxV0H6L9", - "title": "Manager", - "job_id": "job_id4" + "title": "Manager" }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-terminal-action-response.md b/doc/models/get-terminal-action-response.md index a0c7812d..eed8ff66 100644 --- a/doc/models/get-terminal-action-response.md +++ b/doc/models/get-terminal-action-response.md @@ -34,20 +34,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-terminal-checkout-response.md b/doc/models/get-terminal-checkout-response.md index ee7b7467..14ea4750 100644 --- a/doc/models/get-terminal-checkout-response.md +++ b/doc/models/get-terminal-checkout-response.md @@ -42,6 +42,7 @@ "show_itemized_cart": false }, "id": "08YceKh7B3ZqO", + "location_id": "LOCATION_ID", "note": "A brief note", "reference_id": "id11572", "status": "IN_PROGRESS", @@ -56,20 +57,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/get-terminal-refund-response.md b/doc/models/get-terminal-refund-response.md index 8b2de349..fa8f4364 100644 --- a/doc/models/get-terminal-refund-response.md +++ b/doc/models/get-terminal-refund-response.md @@ -45,20 +45,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/gift-card-activity-activate.md b/doc/models/gift-card-activity-activate.md index a77fb029..f531b625 100644 --- a/doc/models/gift-card-activity-activate.md +++ b/doc/models/gift-card-activity-activate.md @@ -23,7 +23,7 @@ Represents details about an `ACTIVATE` [gift card activity type](../../doc/model { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "order_id": "order_id6", "line_item_uid": "line_item_uid0", diff --git a/doc/models/gift-card-activity-adjust-decrement.md b/doc/models/gift-card-activity-adjust-decrement.md index 52de6702..b097d8c9 100644 --- a/doc/models/gift-card-activity-adjust-decrement.md +++ b/doc/models/gift-card-activity-adjust-decrement.md @@ -20,7 +20,7 @@ Represents details about an `ADJUST_DECREMENT` [gift card activity type](../../d { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reason": "SUSPICIOUS_ACTIVITY" } diff --git a/doc/models/gift-card-activity-adjust-increment.md b/doc/models/gift-card-activity-adjust-increment.md index e4669cf5..162012f5 100644 --- a/doc/models/gift-card-activity-adjust-increment.md +++ b/doc/models/gift-card-activity-adjust-increment.md @@ -20,7 +20,7 @@ Represents details about an `ADJUST_INCREMENT` [gift card activity type](../../d { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reason": "SUPPORT_ISSUE" } diff --git a/doc/models/gift-card-activity-import-reversal.md b/doc/models/gift-card-activity-import-reversal.md index 2ac219e5..d7647835 100644 --- a/doc/models/gift-card-activity-import-reversal.md +++ b/doc/models/gift-card-activity-import-reversal.md @@ -19,7 +19,7 @@ Represents details about an `IMPORT_REVERSAL` [gift card activity type](../../do { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/gift-card-activity-import.md b/doc/models/gift-card-activity-import.md index a7b11abb..b3c6e0f4 100644 --- a/doc/models/gift-card-activity-import.md +++ b/doc/models/gift-card-activity-import.md @@ -21,7 +21,7 @@ This activity type is used when Square imports a third-party gift card, in which { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/gift-card-activity-load.md b/doc/models/gift-card-activity-load.md index 8982b6ba..9e4be49e 100644 --- a/doc/models/gift-card-activity-load.md +++ b/doc/models/gift-card-activity-load.md @@ -23,7 +23,7 @@ Represents details about a `LOAD` [gift card activity type](../../doc/models/gif { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "order_id": "order_id6", "line_item_uid": "line_item_uid0", diff --git a/doc/models/gift-card-activity-redeem.md b/doc/models/gift-card-activity-redeem.md index e34facb6..71186ac6 100644 --- a/doc/models/gift-card-activity-redeem.md +++ b/doc/models/gift-card-activity-redeem.md @@ -22,7 +22,7 @@ Represents details about a `REDEEM` [gift card activity type](../../doc/models/g { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "payment_id": "payment_id0", "reference_id": "reference_id2", diff --git a/doc/models/gift-card-activity-refund.md b/doc/models/gift-card-activity-refund.md index 7444353f..20677f1a 100644 --- a/doc/models/gift-card-activity-refund.md +++ b/doc/models/gift-card-activity-refund.md @@ -23,7 +23,7 @@ Represents details about a `REFUND` [gift card activity type](../../doc/models/g "redeem_activity_id": "redeem_activity_id0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reference_id": "reference_id2", "payment_id": "payment_id0" diff --git a/doc/models/gift-card-activity-transfer-balance-from.md b/doc/models/gift-card-activity-transfer-balance-from.md index 9400c78b..0f9bc820 100644 --- a/doc/models/gift-card-activity-transfer-balance-from.md +++ b/doc/models/gift-card-activity-transfer-balance-from.md @@ -21,7 +21,7 @@ Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](../ "transfer_to_gift_card_id": "transfer_to_gift_card_id6", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/gift-card-activity-transfer-balance-to.md b/doc/models/gift-card-activity-transfer-balance-to.md index 98bb12fd..d0ac6e09 100644 --- a/doc/models/gift-card-activity-transfer-balance-to.md +++ b/doc/models/gift-card-activity-transfer-balance-to.md @@ -21,7 +21,7 @@ Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](../.. "transfer_from_gift_card_id": "transfer_from_gift_card_id0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/gift-card-activity-unlinked-activity-refund.md b/doc/models/gift-card-activity-unlinked-activity-refund.md index 8f05bb63..da467051 100644 --- a/doc/models/gift-card-activity-unlinked-activity-refund.md +++ b/doc/models/gift-card-activity-unlinked-activity-refund.md @@ -21,7 +21,7 @@ Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type] { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reference_id": "reference_id2", "payment_id": "payment_id0" diff --git a/doc/models/gift-card-activity.md b/doc/models/gift-card-activity.md index b8ff0100..1658ef78 100644 --- a/doc/models/gift-card-activity.md +++ b/doc/models/gift-card-activity.md @@ -48,7 +48,7 @@ includes a `redeem_activity_details` field that contains information about the r "gift_card_gan": "gift_card_gan6", "gift_card_balance_money": { "amount": 82, - "currency": "LSL" + "currency": "KPW" } } ``` diff --git a/doc/models/gift-card.md b/doc/models/gift-card.md index f4afc14e..e02bf498 100644 --- a/doc/models/gift-card.md +++ b/doc/models/gift-card.md @@ -30,7 +30,7 @@ Represents a Square gift card. "state": "ACTIVE", "balance_money": { "amount": 146, - "currency": "ARS" + "currency": "MVR" }, "gan": "gan6" } diff --git a/doc/models/invoice-accepted-payment-methods.md b/doc/models/invoice-accepted-payment-methods.md index 6995ddd5..5d164e2e 100644 --- a/doc/models/invoice-accepted-payment-methods.md +++ b/doc/models/invoice-accepted-payment-methods.md @@ -15,6 +15,7 @@ The payment methods that customers can use to pay an [invoice](../../doc/models/ | `squareGiftCard` | `boolean \| undefined` | Optional | Indicates whether Square gift card payments are accepted. The default value is `false`. | | `bankAccount` | `boolean \| undefined` | Optional | Indicates whether ACH bank transfer payments are accepted. The default value is `false`. | | `buyNowPayLater` | `boolean \| undefined` | Optional | Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.

This option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is
supported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay
invoice payments are supported. As a best practice, consider enabling an additional payment method when allowing
`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see
[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later). | +| `cashAppPay` | `boolean \| undefined` | Optional | Indicates whether Cash App payments are accepted. The default value is `false`.

This payment method is supported only for seller [locations](entity:Location) in the United States. | ## Example (as JSON) @@ -23,7 +24,8 @@ The payment methods that customers can use to pay an [invoice](../../doc/models/ "card": false, "square_gift_card": false, "bank_account": false, - "buy_now_pay_later": false + "buy_now_pay_later": false, + "cash_app_pay": false } ``` diff --git a/doc/models/invoice-payment-request.md b/doc/models/invoice-payment-request.md index eb8f0e30..00ee73f4 100644 --- a/doc/models/invoice-payment-request.md +++ b/doc/models/invoice-payment-request.md @@ -40,7 +40,7 @@ Adding `INSTALLMENT` payment requests to an invoice requires an "due_date": "due_date8", "fixed_amount_requested_money": { "amount": 162, - "currency": "TOP" + "currency": "NIO" } } ``` diff --git a/doc/models/item-variation-location-overrides.md b/doc/models/item-variation-location-overrides.md index 3d7c7fd5..060aa4e9 100644 --- a/doc/models/item-variation-location-overrides.md +++ b/doc/models/item-variation-location-overrides.md @@ -27,7 +27,7 @@ Price and inventory alerting overrides for a `CatalogItemVariation` at a specifi "location_id": "location_id4", "price_money": { "amount": 202, - "currency": "BBD" + "currency": "CNY" }, "pricing_type": "FIXED_PRICING", "track_inventory": false, diff --git a/doc/models/job-assignment.md b/doc/models/job-assignment.md index 2a46e3da..b4e6e5d5 100644 --- a/doc/models/job-assignment.md +++ b/doc/models/job-assignment.md @@ -25,11 +25,11 @@ An object describing a job that a team member is assigned to. "pay_type": "NONE", "hourly_rate": { "amount": 172, - "currency": "TJS" + "currency": "OMR" }, "annual_rate": { "amount": 232, - "currency": "TOP" + "currency": "SBD" }, "weekly_hours": 156 } diff --git a/doc/models/link-customer-to-gift-card-response.md b/doc/models/link-customer-to-gift-card-response.md index 562920e6..e6fba89c 100644 --- a/doc/models/link-customer-to-gift-card-response.md +++ b/doc/models/link-customer-to-gift-card-response.md @@ -36,20 +36,20 @@ the response contains a set of `Error` objects. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-bank-accounts-response.md b/doc/models/list-bank-accounts-response.md index 4f60dce3..3c06fa42 100644 --- a/doc/models/list-bank-accounts-response.md +++ b/doc/models/list-bank-accounts-response.md @@ -61,20 +61,20 @@ Response object returned by ListBankAccounts. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-booking-custom-attributes-response.md b/doc/models/list-booking-custom-attributes-response.md index dcf851e9..26bb0792 100644 --- a/doc/models/list-booking-custom-attributes-response.md +++ b/doc/models/list-booking-custom-attributes-response.md @@ -83,20 +83,20 @@ results are available, the `cursor` field is also present along with `custom_att "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-bookings-response.md b/doc/models/list-bookings-response.md index 3861e0aa..37ff91bf 100644 --- a/doc/models/list-bookings-response.md +++ b/doc/models/list-bookings-response.md @@ -29,20 +29,20 @@ "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-break-types-response.md b/doc/models/list-break-types-response.md index 6e71bb39..39ced88a 100644 --- a/doc/models/list-break-types-response.md +++ b/doc/models/list-break-types-response.md @@ -46,20 +46,20 @@ the request resulted in errors. "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-cards-response.md b/doc/models/list-cards-response.md index 2e367773..c494d9a7 100644 --- a/doc/models/list-cards-response.md +++ b/doc/models/list-cards-response.md @@ -52,20 +52,20 @@ present. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-cash-drawer-shift-events-response.md b/doc/models/list-cash-drawer-shift-events-response.md index 877f232f..45aa50bd 100644 --- a/doc/models/list-cash-drawer-shift-events-response.md +++ b/doc/models/list-cash-drawer-shift-events-response.md @@ -88,20 +88,20 @@ "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-cash-drawer-shifts-response.md b/doc/models/list-cash-drawer-shifts-response.md index 62570e38..371dc38e 100644 --- a/doc/models/list-cash-drawer-shifts-response.md +++ b/doc/models/list-cash-drawer-shifts-response.md @@ -42,20 +42,20 @@ "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-catalog-response.md b/doc/models/list-catalog-response.md index 1eec2c7b..ebef8914 100644 --- a/doc/models/list-catalog-response.md +++ b/doc/models/list-catalog-response.md @@ -88,20 +88,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-customer-custom-attribute-definitions-response.md b/doc/models/list-customer-custom-attribute-definitions-response.md index aad08f0d..e7030165 100644 --- a/doc/models/list-customer-custom-attribute-definitions-response.md +++ b/doc/models/list-customer-custom-attribute-definitions-response.md @@ -52,20 +52,20 @@ If additional results are available, the `cursor` field is also present along wi ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-customer-custom-attributes-response.md b/doc/models/list-customer-custom-attributes-response.md index e2f59562..59560b71 100644 --- a/doc/models/list-customer-custom-attributes-response.md +++ b/doc/models/list-customer-custom-attributes-response.md @@ -83,20 +83,20 @@ results are available, the `cursor` field is also present along with `custom_att "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-customer-groups-response.md b/doc/models/list-customer-groups-response.md index 9e56e4b3..9ad0c53b 100644 --- a/doc/models/list-customer-groups-response.md +++ b/doc/models/list-customer-groups-response.md @@ -38,20 +38,20 @@ Either `errors` or `groups` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-customer-segments-response.md b/doc/models/list-customer-segments-response.md index 73ebfc37..4413d173 100644 --- a/doc/models/list-customer-segments-response.md +++ b/doc/models/list-customer-segments-response.md @@ -49,20 +49,20 @@ Either `errors` or `segments` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-customers-request.md b/doc/models/list-customers-request.md index d3b57a0f..8dd9abe9 100644 --- a/doc/models/list-customers-request.md +++ b/doc/models/list-customers-request.md @@ -16,6 +16,7 @@ Defines the query parameters that can be included in a request to the | `limit` | `number \| undefined` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | | `sortField` | [`string \| undefined`](../../doc/models/customer-sort-field.md) | Optional | Specifies customer attributes as the sort key to customer profiles returned from a search. | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | +| `count` | `boolean \| undefined` | Optional | Indicates whether to return the total count of customers in the `count` field of the response.

The default value is `false`. | ## Example (as JSON) @@ -24,7 +25,8 @@ Defines the query parameters that can be included in a request to the "cursor": "cursor6", "limit": 172, "sort_field": "DEFAULT", - "sort_order": "DESC" + "sort_order": "DESC", + "count": false } ``` diff --git a/doc/models/list-customers-response.md b/doc/models/list-customers-response.md index 3564bb16..19da63f2 100644 --- a/doc/models/list-customers-response.md +++ b/doc/models/list-customers-response.md @@ -15,8 +15,9 @@ Either `errors` or `customers` is present in a given response (never both). | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `customers` | [`Customer[] \| undefined`](../../doc/models/customer.md) | Optional | The customer profiles associated with the Square account or an empty object (`{}`) if none are found. | +| `customers` | [`Customer[] \| undefined`](../../doc/models/customer.md) | Optional | The customer profiles associated with the Square account or an empty object (`{}`) if none are found.
Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or
`phone_number`) are included in the response. | | `cursor` | `string \| undefined` | Optional | A pagination cursor to retrieve the next set of results for the
original query. A cursor is only present if the request succeeded and additional results
are available.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | +| `count` | `bigint \| undefined` | Optional | The total count of customers associated with the Square account. Only customer profiles with public information
(`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present
only if `count` is set to `true` in the request. | ## Example (as JSON) @@ -72,25 +73,26 @@ Either `errors` or `customers` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } ], - "cursor": "cursor6" + "cursor": "cursor6", + "count": 60 } ``` diff --git a/doc/models/list-device-codes-response.md b/doc/models/list-device-codes-response.md index 843c7b9a..ab859701 100644 --- a/doc/models/list-device-codes-response.md +++ b/doc/models/list-device-codes-response.md @@ -45,20 +45,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-dispute-evidence-response.md b/doc/models/list-dispute-evidence-response.md index 4ccf882a..db84fc53 100644 --- a/doc/models/list-dispute-evidence-response.md +++ b/doc/models/list-dispute-evidence-response.md @@ -43,20 +43,20 @@ Defines the fields in a `ListDisputeEvidence` response. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-disputes-response.md b/doc/models/list-disputes-response.md index ec916494..3f93f872 100644 --- a/doc/models/list-disputes-response.md +++ b/doc/models/list-disputes-response.md @@ -66,20 +66,20 @@ Defines fields in a `ListDisputes` response. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-employee-wages-response.md b/doc/models/list-employee-wages-response.md index f0027559..0085e651 100644 --- a/doc/models/list-employee-wages-response.md +++ b/doc/models/list-employee-wages-response.md @@ -61,20 +61,20 @@ a set of `EmployeeWage` objects. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-employees-response.md b/doc/models/list-employees-response.md index 4844db6e..26502c98 100644 --- a/doc/models/list-employees-response.md +++ b/doc/models/list-employees-response.md @@ -29,20 +29,20 @@ "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-gift-card-activities-response.md b/doc/models/list-gift-card-activities-response.md index ba877329..ff3c6c84 100644 --- a/doc/models/list-gift-card-activities-response.md +++ b/doc/models/list-gift-card-activities-response.md @@ -64,20 +64,20 @@ the response contains a set of `Error` objects. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-gift-cards-response.md b/doc/models/list-gift-cards-response.md index f25737c3..06ea8f08 100644 --- a/doc/models/list-gift-cards-response.md +++ b/doc/models/list-gift-cards-response.md @@ -49,20 +49,20 @@ the response contains a set of `Error` objects. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-invoices-response.md b/doc/models/list-invoices-response.md index 5c323b95..dee3f5eb 100644 --- a/doc/models/list-invoices-response.md +++ b/doc/models/list-invoices-response.md @@ -26,6 +26,7 @@ Describes a `ListInvoice` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -100,6 +101,7 @@ Describes a `ListInvoice` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": true }, "created_at": "2021-01-23T15:29:12Z", @@ -172,20 +174,20 @@ Describes a `ListInvoice` response. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-location-custom-attribute-definitions-response.md b/doc/models/list-location-custom-attribute-definitions-response.md index 1834fb95..d5b16ef4 100644 --- a/doc/models/list-location-custom-attribute-definitions-response.md +++ b/doc/models/list-location-custom-attribute-definitions-response.md @@ -52,20 +52,20 @@ If additional results are available, the `cursor` field is also present along wi ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-location-custom-attributes-response.md b/doc/models/list-location-custom-attributes-response.md index b2581d2e..d0550295 100644 --- a/doc/models/list-location-custom-attributes-response.md +++ b/doc/models/list-location-custom-attributes-response.md @@ -83,20 +83,20 @@ results are available, the `cursor` field is also present along with `custom_att "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-locations-response.md b/doc/models/list-locations-response.md index 1126a88e..0eb4e80f 100644 --- a/doc/models/list-locations-response.md +++ b/doc/models/list-locations-response.md @@ -82,20 +82,20 @@ Either `errors` or `locations` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-loyalty-programs-response.md b/doc/models/list-loyalty-programs-response.md index 907f5300..2a27f2e2 100644 --- a/doc/models/list-loyalty-programs-response.md +++ b/doc/models/list-loyalty-programs-response.md @@ -58,11 +58,11 @@ A response that contains all loyalty programs. ], "fixed_discount_money": { "amount": 100, - "currency": "INR" + "currency": "LTL" }, "max_discount_money": { "amount": 144, - "currency": "BZD" + "currency": "LTL" } }, "id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", @@ -87,20 +87,20 @@ A response that contains all loyalty programs. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-loyalty-promotions-response.md b/doc/models/list-loyalty-promotions-response.md index baad260c..960635cb 100644 --- a/doc/models/list-loyalty-promotions-response.md +++ b/doc/models/list-loyalty-promotions-response.md @@ -98,20 +98,20 @@ If additional results are available, the `cursor` field is also present along wi ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-merchant-custom-attribute-definitions-response.md b/doc/models/list-merchant-custom-attribute-definitions-response.md index fd6577af..f5063b72 100644 --- a/doc/models/list-merchant-custom-attribute-definitions-response.md +++ b/doc/models/list-merchant-custom-attribute-definitions-response.md @@ -52,20 +52,20 @@ If additional results are available, the `cursor` field is also present along wi ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-merchant-custom-attributes-response.md b/doc/models/list-merchant-custom-attributes-response.md index 73e46305..4787dc5c 100644 --- a/doc/models/list-merchant-custom-attributes-response.md +++ b/doc/models/list-merchant-custom-attributes-response.md @@ -83,20 +83,20 @@ results are available, the `cursor` field is also present along with `custom_att "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-merchants-response.md b/doc/models/list-merchants-response.md index 7910534b..7d607bac 100644 --- a/doc/models/list-merchants-response.md +++ b/doc/models/list-merchants-response.md @@ -33,20 +33,20 @@ The response object returned by the [ListMerchant](../../doc/api/merchants.md#li ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-order-custom-attribute-definitions-response.md b/doc/models/list-order-custom-attribute-definitions-response.md index a88f79ac..f1fdf230 100644 --- a/doc/models/list-order-custom-attribute-definitions-response.md +++ b/doc/models/list-order-custom-attribute-definitions-response.md @@ -63,20 +63,20 @@ Represents a response from listing order custom attribute definitions. "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-order-custom-attributes-response.md b/doc/models/list-order-custom-attributes-response.md index e3855aa8..59e312b2 100644 --- a/doc/models/list-order-custom-attributes-response.md +++ b/doc/models/list-order-custom-attributes-response.md @@ -81,20 +81,20 @@ Represents a response from listing order custom attributes. "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-payment-links-response.md b/doc/models/list-payment-links-response.md index a9ed39ed..b1e6bfc8 100644 --- a/doc/models/list-payment-links-response.md +++ b/doc/models/list-payment-links-response.md @@ -94,20 +94,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-payment-refunds-request.md b/doc/models/list-payment-refunds-request.md index 96917e29..7f123645 100644 --- a/doc/models/list-payment-refunds-request.md +++ b/doc/models/list-payment-refunds-request.md @@ -14,7 +14,7 @@ The maximum results per page is 100. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `beginTime` | `string \| undefined` | Optional | Indicates the start of the time range to retrieve each PaymentRefund`for, in RFC 3339 format. The range is determined using the`created_at`field for each`PaymentRefund`.

Default: The current time minus one year. | +| `beginTime` | `string \| undefined` | Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339
format. The range is determined using the `created_at` field for each `PaymentRefund`.

Default: The current time minus one year. | | `endTime` | `string \| undefined` | Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339
format. The range is determined using the `created_at` field for each `PaymentRefund`.

Default: The current time. | | `sortOrder` | `string \| undefined` | Optional | The order in which results are listed by `PaymentRefund.created_at`:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | | `cursor` | `string \| undefined` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | diff --git a/doc/models/list-payment-refunds-response.md b/doc/models/list-payment-refunds-response.md index 9ee25b29..9ba410a6 100644 --- a/doc/models/list-payment-refunds-response.md +++ b/doc/models/list-payment-refunds-response.md @@ -64,20 +64,20 @@ Either `errors` or `refunds` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-payments-response.md b/doc/models/list-payments-response.md index dc79e51f..e8567c14 100644 --- a/doc/models/list-payments-response.md +++ b/doc/models/list-payments-response.md @@ -87,26 +87,26 @@ Defines the response returned by [ListPayments](../../doc/api/payments.md#list-p "version_token": "vguW2km0KpVCdAXZcNTZ438qg5LlVPTP4HO5OpiHNfa6o", "tip_money": { "amount": 58, - "currency": "DZD" + "currency": "SRD" } } ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-payout-entries-response.md b/doc/models/list-payout-entries-response.md index 3289bf9e..393241c4 100644 --- a/doc/models/list-payout-entries-response.md +++ b/doc/models/list-payout-entries-response.md @@ -26,18 +26,18 @@ The response to retrieve payout records entries. "fee_amount_money": { "amount": -2, "currency_code": "USD", - "currency": "TMT" + "currency": "AZN" }, "gross_amount_money": { "amount": -50, "currency_code": "USD", - "currency": "MGA" + "currency": "NIO" }, "id": "poe_ZQWcw41d0SGJS6IWd4cSi8mKHk", "net_amount_money": { "amount": -48, "currency_code": "USD", - "currency": "TND" + "currency": "XPF" }, "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6", "type": "REFUND", @@ -51,18 +51,18 @@ The response to retrieve payout records entries. "fee_amount_money": { "amount": 19, "currency_code": "USD", - "currency": "TND" + "currency": "BAM" }, "gross_amount_money": { "amount": 100, "currency_code": "USD", - "currency": "MKD" + "currency": "NOK" }, "id": "poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk", "net_amount_money": { "amount": 81, "currency_code": "USD", - "currency": "TOP" + "currency": "XPT" }, "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6", "type": "CHARGE", @@ -73,20 +73,20 @@ The response to retrieve payout records entries. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-payouts-response.md b/doc/models/list-payouts-response.md index 07be65a8..8d13f0d9 100644 --- a/doc/models/list-payouts-response.md +++ b/doc/models/list-payouts-response.md @@ -25,7 +25,7 @@ The response to retrieve payout records entries. "amount_money": { "amount": 6259, "currency_code": "USD", - "currency": "XBA" + "currency": "HUF" }, "arrival_date": "2022-03-29", "created_at": "2022-03-29T16:12:31Z", @@ -55,7 +55,7 @@ The response to retrieve payout records entries. "amount_money": { "amount": -103, "currency_code": "USD", - "currency": "XBB" + "currency": "IDR" }, "arrival_date": "2022-03-24", "created_at": "2022-03-24T03:07:09Z", @@ -74,20 +74,20 @@ The response to retrieve payout records entries. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-refunds-response.md b/doc/models/list-refunds-response.md index 1fd21799..af381fb2 100644 --- a/doc/models/list-refunds-response.md +++ b/doc/models/list-refunds-response.md @@ -48,26 +48,26 @@ One of `errors` or `refunds` is present in a given response (never both). "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF", "processing_fee_money": { "amount": 112, - "currency": "GEL" + "currency": "LTL" } } ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-sites-response.md b/doc/models/list-sites-response.md index 89b3bc8a..cae42259 100644 --- a/doc/models/list-sites-response.md +++ b/doc/models/list-sites-response.md @@ -38,20 +38,20 @@ Represents a `ListSites` response. The response can include either `sites` or `e ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-subscription-events-response.md b/doc/models/list-subscription-events-response.md index 623d4ac2..8143b4b4 100644 --- a/doc/models/list-subscription-events-response.md +++ b/doc/models/list-subscription-events-response.md @@ -20,31 +20,12 @@ Defines output parameters in a response from the ```json { - "errors": [ - { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", - "detail": "detail1", - "field": "field9" - }, - { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", - "detail": "detail2", - "field": "field0" - }, - { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", - "detail": "detail3", - "field": "field1" - } - ], "subscription_events": [ { - "id": "id6", - "subscription_event_type": "STOP_SUBSCRIPTION", - "effective_date": "effective_date4", + "effective_date": "2020-04-24", + "id": "06809161-3867-4598-8269-8aea5be4f9de", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "START_SUBSCRIPTION", "info": { "detail": "detail2", "code": "CUSTOMER_NO_NAME" @@ -68,17 +49,17 @@ Defines output parameters in a response from the "order_template_id": "order_template_id1", "plan_phase_uid": "plan_phase_uid5" } - ], - "plan_variation_id": "plan_variation_id0" + ] }, { - "id": "id7", - "subscription_event_type": "PLAN_CHANGE", - "effective_date": "effective_date3", + "effective_date": "2020-05-01", + "id": "f2736603-cd2e-47ec-8675-f815fff54f88", "info": { - "detail": "detail3", - "code": "USER_PROVIDED" + "code": "CUSTOMER_NO_NAME", + "detail": "The customer with ID `V74BMG0GPS2KNCWJE1BTYJ37Y0` does not have a name on record." }, + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "DEACTIVATE_SUBSCRIPTION", "phases": [ { "uid": "uid2", @@ -92,8 +73,147 @@ Defines output parameters in a response from the "order_template_id": "order_template_id3", "plan_phase_uid": "plan_phase_uid7" } - ], - "plan_variation_id": "plan_variation_id1" + ] + }, + { + "effective_date": "2022-05-01", + "id": "b426fc85-6859-450b-b0d0-fe3a5d1b565f", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "RESUME_SUBSCRIPTION", + "info": { + "detail": "detail4", + "code": "LOCATION_NOT_ACTIVE" + }, + "phases": [ + { + "uid": "uid3", + "ordinal": 19, + "order_template_id": "order_template_id5", + "plan_phase_uid": "plan_phase_uid9" + } + ] + }, + { + "effective_date": "2022-09-01", + "id": "09f14de1-2f53-4dae-9091-49aa53f83d01", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "PAUSE_SUBSCRIPTION", + "info": { + "detail": "detail5", + "code": "LOCATION_CANNOT_ACCEPT_PAYMENT" + }, + "phases": [ + { + "uid": "uid4", + "ordinal": 20, + "order_template_id": "order_template_id6", + "plan_phase_uid": "plan_phase_uid0" + }, + { + "uid": "uid3", + "ordinal": 19, + "order_template_id": "order_template_id5", + "plan_phase_uid": "plan_phase_uid9" + }, + { + "uid": "uid2", + "ordinal": 18, + "order_template_id": "order_template_id4", + "plan_phase_uid": "plan_phase_uid8" + } + ] + }, + { + "effective_date": "2022-12-01", + "id": "f28a73ac-1a1b-4b0f-8eeb-709a72945776", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "RESUME_SUBSCRIPTION", + "info": { + "detail": "detail6", + "code": "CUSTOMER_DELETED" + }, + "phases": [ + { + "uid": "uid5", + "ordinal": 21, + "order_template_id": "order_template_id7", + "plan_phase_uid": "plan_phase_uid1" + }, + { + "uid": "uid4", + "ordinal": 20, + "order_template_id": "order_template_id6", + "plan_phase_uid": "plan_phase_uid0" + } + ] + }, + { + "effective_date": "2023-04-01", + "id": "1eee8790-472d-4efe-8c69-8ad84e9cefe0", + "plan_variation_id": "02CD53CFA4d1498AFAD42", + "subscription_event_type": "PLAN_CHANGE", + "info": { + "detail": "detail7", + "code": "CUSTOMER_NO_EMAIL" + }, + "phases": [ + { + "uid": "uid6", + "ordinal": 22, + "order_template_id": "order_template_id8", + "plan_phase_uid": "plan_phase_uid2" + } + ] + }, + { + "effective_date": "2023-06-21", + "id": "a0c08083-5db0-4800-85c7-d398de4fbb6e", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", + "subscription_event_type": "STOP_SUBSCRIPTION", + "info": { + "detail": "detail8", + "code": "CUSTOMER_NO_NAME" + }, + "phases": [ + { + "uid": "uid7", + "ordinal": 23, + "order_template_id": "order_template_id9", + "plan_phase_uid": "plan_phase_uid3" + }, + { + "uid": "uid6", + "ordinal": 22, + "order_template_id": "order_template_id8", + "plan_phase_uid": "plan_phase_uid2" + }, + { + "uid": "uid5", + "ordinal": 21, + "order_template_id": "order_template_id7", + "plan_phase_uid": "plan_phase_uid1" + } + ] + } + ], + "errors": [ + { + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", + "detail": "detail1", + "field": "field9" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", + "detail": "detail2", + "field": "field0" + }, + { + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", + "detail": "detail3", + "field": "field1" } ], "cursor": "cursor6" diff --git a/doc/models/list-team-member-wages-response.md b/doc/models/list-team-member-wages-response.md index 409cca4f..e9ccc72d 100644 --- a/doc/models/list-team-member-wages-response.md +++ b/doc/models/list-team-member-wages-response.md @@ -28,9 +28,9 @@ a set of `TeamMemberWage` objects. "currency": "USD" }, "id": "pXS3qCv7BERPnEGedM4S8mhm", + "job_id": "jxJNN6eCJsLrhg5UFJrDWDGE", "team_member_id": "33fJchumvVdJwxV0H6L9", - "title": "Manager", - "job_id": "job_id9" + "title": "Manager" }, { "hourly_rate": { @@ -38,9 +38,9 @@ a set of `TeamMemberWage` objects. "currency": "USD" }, "id": "rZduCkzYDUVL3ovh1sQgbue6", + "job_id": "gcbz15vKGnMKmaWJJ152kjim", "team_member_id": "33fJchumvVdJwxV0H6L9", - "title": "Cook", - "job_id": "job_id8" + "title": "Cook" }, { "hourly_rate": { @@ -48,9 +48,9 @@ a set of `TeamMemberWage` objects. "currency": "USD" }, "id": "FxLbs5KpPUHa8wyt5ctjubDX", + "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", "team_member_id": "33fJchumvVdJwxV0H6L9", - "title": "Barista", - "job_id": "job_id7" + "title": "Barista" }, { "hourly_rate": { @@ -58,27 +58,27 @@ a set of `TeamMemberWage` objects. "currency": "USD" }, "id": "vD1wCgijMDR3cX5TPnu7VXto", + "job_id": "N4YKVLzFj3oGtNocqoYHYpW3", "team_member_id": "33fJchumvVdJwxV0H6L9", - "title": "Cashier", - "job_id": "job_id6" + "title": "Cashier" } ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-transactions-response.md b/doc/models/list-transactions-response.md index f0486d65..c13d5c28 100644 --- a/doc/models/list-transactions-response.md +++ b/doc/models/list-transactions-response.md @@ -99,20 +99,20 @@ One of `errors` or `transactions` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-webhook-event-types-response.md b/doc/models/list-webhook-event-types-response.md index 011efc2c..ed0375cf 100644 --- a/doc/models/list-webhook-event-types-response.md +++ b/doc/models/list-webhook-event-types-response.md @@ -35,20 +35,20 @@ present. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-webhook-subscriptions-response.md b/doc/models/list-webhook-subscriptions-response.md index 2ee56301..0a9ee656 100644 --- a/doc/models/list-webhook-subscriptions-response.md +++ b/doc/models/list-webhook-subscriptions-response.md @@ -40,20 +40,20 @@ present. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/list-workweek-configs-response.md b/doc/models/list-workweek-configs-response.md index 944da9e4..1dfc1691 100644 --- a/doc/models/list-workweek-configs-response.md +++ b/doc/models/list-workweek-configs-response.md @@ -34,20 +34,20 @@ the request resulted in errors. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/loyalty-program-accrual-rule-spend-data.md b/doc/models/loyalty-program-accrual-rule-spend-data.md index e8f18d69..fb354f40 100644 --- a/doc/models/loyalty-program-accrual-rule-spend-data.md +++ b/doc/models/loyalty-program-accrual-rule-spend-data.md @@ -22,7 +22,7 @@ Represents additional data for rules with the `SPEND` accrual type. { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "excluded_category_ids": [ "excluded_category_ids8", diff --git a/doc/models/loyalty-program-accrual-rule-visit-data.md b/doc/models/loyalty-program-accrual-rule-visit-data.md index 51204036..3cef8e2b 100644 --- a/doc/models/loyalty-program-accrual-rule-visit-data.md +++ b/doc/models/loyalty-program-accrual-rule-visit-data.md @@ -20,7 +20,7 @@ Represents additional data for rules with the `VISIT` accrual type. { "minimum_amount_money": { "amount": 146, - "currency": "UYI" + "currency": "MYR" }, "tax_mode": "BEFORE_TAX" } diff --git a/doc/models/loyalty-program-accrual-rule.md b/doc/models/loyalty-program-accrual-rule.md index b93d9992..77094571 100644 --- a/doc/models/loyalty-program-accrual-rule.md +++ b/doc/models/loyalty-program-accrual-rule.md @@ -27,14 +27,14 @@ Represents an accrual rule, which defines how buyers can earn points from the ba "visit_data": { "minimum_amount_money": { "amount": 24, - "currency": "GEL" + "currency": "UYI" }, "tax_mode": "BEFORE_TAX" }, "spend_data": { "amount_money": { "amount": 248, - "currency": "MXV" + "currency": "BSD" }, "excluded_category_ids": [ "excluded_category_ids4" diff --git a/doc/models/loyalty-program-reward-definition.md b/doc/models/loyalty-program-reward-definition.md index e577d4e5..e1db7b96 100644 --- a/doc/models/loyalty-program-reward-definition.md +++ b/doc/models/loyalty-program-reward-definition.md @@ -34,11 +34,11 @@ are now defined using a catalog pricing rule and other catalog objects. For more ], "fixed_discount_money": { "amount": 36, - "currency": "WST" + "currency": "TTD" }, "max_discount_money": { "amount": 84, - "currency": "JOD" + "currency": "STD" } } ``` diff --git a/doc/models/loyalty-program-reward-tier.md b/doc/models/loyalty-program-reward-tier.md index 56fddafa..f4c59b22 100644 --- a/doc/models/loyalty-program-reward-tier.md +++ b/doc/models/loyalty-program-reward-tier.md @@ -34,11 +34,11 @@ Represents a reward tier in a loyalty program. A reward tier defines how buyers ], "fixed_discount_money": { "amount": 132, - "currency": "TRY" + "currency": "CUC" }, "max_discount_money": { "amount": 176, - "currency": "MYR" + "currency": "CUC" } }, "created_at": "created_at2", diff --git a/doc/models/loyalty-program.md b/doc/models/loyalty-program.md index ad46b234..0bea4927 100644 --- a/doc/models/loyalty-program.md +++ b/doc/models/loyalty-program.md @@ -45,11 +45,11 @@ For more information, see [Loyalty Program Overview](https://developer.squareup. ], "fixed_discount_money": { "amount": 119, - "currency": "CUC" + "currency": "SEK" }, "max_discount_money": { "amount": 163, - "currency": "ZMK" + "currency": "SEK" } }, "created_at": "created_at7", @@ -71,11 +71,11 @@ For more information, see [Loyalty Program Overview](https://developer.squareup. ], "fixed_discount_money": { "amount": 120, - "currency": "CUP" + "currency": "SGD" }, "max_discount_money": { "amount": 164, - "currency": "ZMW" + "currency": "SGD" } }, "created_at": "created_at8", diff --git a/doc/models/merchant.md b/doc/models/merchant.md index 69066fcf..63eef83f 100644 --- a/doc/models/merchant.md +++ b/doc/models/merchant.md @@ -28,7 +28,7 @@ Represents a business that sells with Square. "business_name": "business_name4", "country": "FO", "language_code": "language_code8", - "currency": "YER", + "currency": "SLL", "status": "ACTIVE" } ``` diff --git a/doc/models/modifier-location-overrides.md b/doc/models/modifier-location-overrides.md index a7650de8..51cf64de 100644 --- a/doc/models/modifier-location-overrides.md +++ b/doc/models/modifier-location-overrides.md @@ -21,7 +21,7 @@ Location-specific overrides for specified properties of a `CatalogModifier` obje "location_id": "location_id4", "price_money": { "amount": 202, - "currency": "BBD" + "currency": "CNY" } } ``` diff --git a/doc/models/money.md b/doc/models/money.md index 252a6935..dc502459 100644 --- a/doc/models/money.md +++ b/doc/models/money.md @@ -24,7 +24,7 @@ for more information. ```json { "amount": 46, - "currency": "YER" + "currency": "SLL" } ``` diff --git a/doc/models/order-line-item-applied-discount.md b/doc/models/order-line-item-applied-discount.md index 58d5f94d..a27b2f3e 100644 --- a/doc/models/order-line-item-applied-discount.md +++ b/doc/models/order-line-item-applied-discount.md @@ -28,7 +28,7 @@ line items. "discount_uid": "discount_uid4", "applied_money": { "amount": 196, - "currency": "PLN" + "currency": "HKD" } } ``` diff --git a/doc/models/order-line-item-applied-service-charge.md b/doc/models/order-line-item-applied-service-charge.md index bd80f7e8..0fb56027 100644 --- a/doc/models/order-line-item-applied-service-charge.md +++ b/doc/models/order-line-item-applied-service-charge.md @@ -21,7 +21,7 @@ "service_charge_uid": "service_charge_uid0", "applied_money": { "amount": 196, - "currency": "PLN" + "currency": "HKD" } } ``` diff --git a/doc/models/order-line-item-applied-tax.md b/doc/models/order-line-item-applied-tax.md index 033d768e..dfa060d4 100644 --- a/doc/models/order-line-item-applied-tax.md +++ b/doc/models/order-line-item-applied-tax.md @@ -28,7 +28,7 @@ set of participating line items. "tax_uid": "tax_uid4", "applied_money": { "amount": 196, - "currency": "PLN" + "currency": "HKD" } } ``` diff --git a/doc/models/order-money-amounts.md b/doc/models/order-money-amounts.md index c91459ec..bd831110 100644 --- a/doc/models/order-money-amounts.md +++ b/doc/models/order-money-amounts.md @@ -23,23 +23,23 @@ A collection of various money amounts. { "total_money": { "amount": 250, - "currency": "UNKNOWN_CURRENCY" + "currency": "KES" }, "tax_money": { "amount": 58, - "currency": "KZT" + "currency": "XBC" }, "discount_money": { "amount": 92, - "currency": "XBD" + "currency": "THB" }, "tip_money": { "amount": 190, - "currency": "CHE" + "currency": "ZMK" }, "service_charge_money": { "amount": 160, - "currency": "BZD" + "currency": "AOA" } } ``` diff --git a/doc/models/order-rounding-adjustment.md b/doc/models/order-rounding-adjustment.md index 7ed1d8a9..797efeb0 100644 --- a/doc/models/order-rounding-adjustment.md +++ b/doc/models/order-rounding-adjustment.md @@ -24,7 +24,7 @@ when the minimum unit of the account is smaller than the lowest physical denomin "name": "name0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/pause-subscription-response.md b/doc/models/pause-subscription-response.md index 1d8e5688..1e4d5706 100644 --- a/doc/models/pause-subscription-response.md +++ b/doc/models/pause-subscription-response.md @@ -22,7 +22,7 @@ Defines output parameters in a response from the { "actions": [ { - "effective_date": "2021-11-17", + "effective_date": "2023-11-17", "id": "99b2439e-63f7-3ad5-95f7-ab2447a80673", "type": "PAUSE", "phases": [ @@ -37,40 +37,44 @@ Defines output parameters in a response from the } ], "subscription": { - "created_at": "2021-10-20T21:53:10Z", + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", - "id": "9ba40961-995a-4a3d-8c53-048c40cafc13", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", "location_id": "S8GWD5R9QB376", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", - "price_override_money": { - "amount": 2000, - "currency": "USD" - }, + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": { - "name": "My App" + "name": "My Application" }, + "start_date": "2023-06-20", "status": "ACTIVE", "timezone": "America/Los_Angeles", - "version": 1594311617331, - "plan_variation_id": "plan_variation_id8", - "start_date": "start_date8" + "version": 1 }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/pay-order-response.md b/doc/models/pay-order-response.md index cd57d7ae..60b9ba1f 100644 --- a/doc/models/pay-order-response.md +++ b/doc/models/pay-order-response.md @@ -215,20 +215,20 @@ Defines the fields that are included in the response body of a request to the }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/payment-refund.md b/doc/models/payment-refund.md index 39d58ed0..1df1294d 100644 --- a/doc/models/payment-refund.md +++ b/doc/models/payment-refund.md @@ -51,7 +51,7 @@ the original payment and the amount of money refunded. }, "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/payment.md b/doc/models/payment.md index 54066169..a724bacc 100644 --- a/doc/models/payment.md +++ b/doc/models/payment.md @@ -61,11 +61,11 @@ Represents a payment processed by the Square API. "updated_at": "updated_at4", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "tip_money": { "amount": 190, - "currency": "CHE" + "currency": "ZMK" } } ``` diff --git a/doc/models/payout-entry.md b/doc/models/payout-entry.md index 15b6a2a0..9ddfd173 100644 --- a/doc/models/payout-entry.md +++ b/doc/models/payout-entry.md @@ -52,15 +52,15 @@ The total amount of the payout will equal the sum of the payout entries for a ba "type": "CHARGE", "gross_amount_money": { "amount": 186, - "currency": "SVC" + "currency": "BWP" }, "fee_amount_money": { "amount": 126, - "currency": "ANG" + "currency": "NIO" }, "net_amount_money": { "amount": 6, - "currency": "AOA" + "currency": "LTL" } } ``` diff --git a/doc/models/payout-fee.md b/doc/models/payout-fee.md index 77226e9c..256145c4 100644 --- a/doc/models/payout-fee.md +++ b/doc/models/payout-fee.md @@ -21,7 +21,7 @@ Represents a payout fee that can incur as part of a payout. { "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "effective_at": "effective_at6", "type": "TRANSFER_FEE" diff --git a/doc/models/payout.md b/doc/models/payout.md index a670e4fb..e22ff5ac 100644 --- a/doc/models/payout.md +++ b/doc/models/payout.md @@ -36,7 +36,7 @@ external bank account or to the Square balance. "updated_at": "updated_at4", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "destination": { "type": "BANK_ACCOUNT", diff --git a/doc/models/processing-fee.md b/doc/models/processing-fee.md index 3b39f088..4d1f36e9 100644 --- a/doc/models/processing-fee.md +++ b/doc/models/processing-fee.md @@ -23,7 +23,7 @@ Represents the Square processing fee. "type": "type0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" } } ``` diff --git a/doc/models/publish-invoice-response.md b/doc/models/publish-invoice-response.md index f7b52141..75c9035f 100644 --- a/doc/models/publish-invoice-response.md +++ b/doc/models/publish-invoice-response.md @@ -23,6 +23,7 @@ Describes a `PublishInvoice` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -95,20 +96,20 @@ Describes a `PublishInvoice` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/quick-pay.md b/doc/models/quick-pay.md index cc9ca59a..6dd05d47 100644 --- a/doc/models/quick-pay.md +++ b/doc/models/quick-pay.md @@ -24,7 +24,7 @@ see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick- "name": "name0", "price_money": { "amount": 202, - "currency": "BBD" + "currency": "CNY" }, "location_id": "location_id4" } diff --git a/doc/models/redeem-loyalty-reward-response.md b/doc/models/redeem-loyalty-reward-response.md index 4fa0ccf9..8845ac99 100644 --- a/doc/models/redeem-loyalty-reward-response.md +++ b/doc/models/redeem-loyalty-reward-response.md @@ -53,20 +53,20 @@ A response that includes the `LoyaltyEvent` published for redeeming the reward. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/refund-payment-response.md b/doc/models/refund-payment-response.md index 85f5a154..d0ff547f 100644 --- a/doc/models/refund-payment-response.md +++ b/doc/models/refund-payment-response.md @@ -56,20 +56,20 @@ present, or it might be present with a status of `FAILED`. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/refund.md b/doc/models/refund.md index b8dcaba4..cc16d9bc 100644 --- a/doc/models/refund.md +++ b/doc/models/refund.md @@ -34,12 +34,12 @@ Represents a refund processed for a Square transaction. "reason": "reason4", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "status": "PENDING", "processing_fee_money": { "amount": 112, - "currency": "XBB" + "currency": "BBD" }, "additional_recipients": [ { @@ -47,7 +47,7 @@ Represents a refund processed for a Square transaction. "description": "description9", "amount_money": { "amount": 83, - "currency": "ALL" + "currency": "ZAR" }, "receivable_id": "receivable_id9" }, @@ -56,7 +56,7 @@ Represents a refund processed for a Square transaction. "description": "description0", "amount_money": { "amount": 84, - "currency": "AMD" + "currency": "ZMK" }, "receivable_id": "receivable_id0" }, @@ -65,7 +65,7 @@ Represents a refund processed for a Square transaction. "description": "description1", "amount_money": { "amount": 85, - "currency": "ANG" + "currency": "ZMW" }, "receivable_id": "receivable_id1" } diff --git a/doc/models/register-domain-response.md b/doc/models/register-domain-response.md index 2a79b0a7..24404cc9 100644 --- a/doc/models/register-domain-response.md +++ b/doc/models/register-domain-response.md @@ -24,20 +24,20 @@ Either `errors` or `status` are present in a given response (never both). "status": "VERIFIED", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/remove-group-from-customer-response.md b/doc/models/remove-group-from-customer-response.md index 07812ec3..6a3b4384 100644 --- a/doc/models/remove-group-from-customer-response.md +++ b/doc/models/remove-group-from-customer-response.md @@ -21,20 +21,20 @@ endpoint. { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/resume-subscription-response.md b/doc/models/resume-subscription-response.md index 33ee8587..4df6df71 100644 --- a/doc/models/resume-subscription-response.md +++ b/doc/models/resume-subscription-response.md @@ -22,7 +22,7 @@ Defines output parameters in a response from the { "actions": [ { - "effective_date": "2022-01-01", + "effective_date": "2023-09-01", "id": "18ff74f4-3da4-30c5-929f-7d6fca84f115", "type": "RESUME", "phases": [ @@ -37,40 +37,44 @@ Defines output parameters in a response from the } ], "subscription": { - "created_at": "2021-10-20T21:53:10Z", + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", - "id": "9ba40961-995a-4a3d-8c53-048c40cafc13", + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", "location_id": "S8GWD5R9QB376", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", - "price_override_money": { - "amount": 2000, - "currency": "USD" - }, + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": { - "name": "My App" + "name": "My Application" }, + "start_date": "2023-06-20", "status": "ACTIVE", "timezone": "America/Los_Angeles", - "version": 1594311617331, - "plan_variation_id": "plan_variation_id8", - "start_date": "start_date8" + "version": 1 }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-booking-custom-attribute-response.md b/doc/models/retrieve-booking-custom-attribute-response.md index afcf636c..77982179 100644 --- a/doc/models/retrieve-booking-custom-attribute-response.md +++ b/doc/models/retrieve-booking-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-card-response.md b/doc/models/retrieve-card-response.md index 34486f1b..8ddac338 100644 --- a/doc/models/retrieve-card-response.md +++ b/doc/models/retrieve-card-response.md @@ -49,20 +49,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-cash-drawer-shift-response.md b/doc/models/retrieve-cash-drawer-shift-response.md index 1d7e5afe..aeb71fcf 100644 --- a/doc/models/retrieve-cash-drawer-shift-response.md +++ b/doc/models/retrieve-cash-drawer-shift-response.md @@ -60,20 +60,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-catalog-object-response.md b/doc/models/retrieve-catalog-object-response.md index 80562a30..a3a5281a 100644 --- a/doc/models/retrieve-catalog-object-response.md +++ b/doc/models/retrieve-catalog-object-response.md @@ -161,20 +161,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-customer-custom-attribute-definition-response.md b/doc/models/retrieve-customer-custom-attribute-definition-response.md index d4296631..527247d2 100644 --- a/doc/models/retrieve-customer-custom-attribute-definition-response.md +++ b/doc/models/retrieve-customer-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-customer-custom-attribute-response.md b/doc/models/retrieve-customer-custom-attribute-response.md index 7a15b450..d871693e 100644 --- a/doc/models/retrieve-customer-custom-attribute-response.md +++ b/doc/models/retrieve-customer-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-customer-group-response.md b/doc/models/retrieve-customer-group-response.md index ba770608..ca356cc3 100644 --- a/doc/models/retrieve-customer-group-response.md +++ b/doc/models/retrieve-customer-group-response.md @@ -29,20 +29,20 @@ Either `errors` or `group` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-customer-response.md b/doc/models/retrieve-customer-response.md index 70d891d3..06390ac7 100644 --- a/doc/models/retrieve-customer-response.md +++ b/doc/models/retrieve-customer-response.md @@ -62,20 +62,20 @@ Either `errors` or `customer` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-customer-segment-response.md b/doc/models/retrieve-customer-segment-response.md index 96538834..5d0f4284 100644 --- a/doc/models/retrieve-customer-segment-response.md +++ b/doc/models/retrieve-customer-segment-response.md @@ -28,20 +28,20 @@ Either `errors` or `segment` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-dispute-evidence-response.md b/doc/models/retrieve-dispute-evidence-response.md index d768ab62..9cb1422c 100644 --- a/doc/models/retrieve-dispute-evidence-response.md +++ b/doc/models/retrieve-dispute-evidence-response.md @@ -32,20 +32,20 @@ Defines the fields in a `RetrieveDisputeEvidence` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-dispute-response.md b/doc/models/retrieve-dispute-response.md index c246c1a2..4f087bc3 100644 --- a/doc/models/retrieve-dispute-response.md +++ b/doc/models/retrieve-dispute-response.md @@ -41,20 +41,20 @@ Defines fields in a `RetrieveDispute` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-employee-response.md b/doc/models/retrieve-employee-response.md index e5abbe81..a7f47fe7 100644 --- a/doc/models/retrieve-employee-response.md +++ b/doc/models/retrieve-employee-response.md @@ -25,20 +25,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-gift-card-from-gan-response.md b/doc/models/retrieve-gift-card-from-gan-response.md index 6b281675..077bc183 100644 --- a/doc/models/retrieve-gift-card-from-gan-response.md +++ b/doc/models/retrieve-gift-card-from-gan-response.md @@ -33,20 +33,20 @@ if the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-gift-card-from-nonce-response.md b/doc/models/retrieve-gift-card-from-nonce-response.md index f726a418..80b695ee 100644 --- a/doc/models/retrieve-gift-card-from-nonce-response.md +++ b/doc/models/retrieve-gift-card-from-nonce-response.md @@ -33,20 +33,20 @@ the response contains a set of `Error` objects. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-gift-card-response.md b/doc/models/retrieve-gift-card-response.md index b560588d..e3ae299e 100644 --- a/doc/models/retrieve-gift-card-response.md +++ b/doc/models/retrieve-gift-card-response.md @@ -33,20 +33,20 @@ if the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-location-custom-attribute-definition-response.md b/doc/models/retrieve-location-custom-attribute-definition-response.md index f2449fb4..cf86572e 100644 --- a/doc/models/retrieve-location-custom-attribute-definition-response.md +++ b/doc/models/retrieve-location-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-location-custom-attribute-response.md b/doc/models/retrieve-location-custom-attribute-response.md index 310f71a8..8a5b1519 100644 --- a/doc/models/retrieve-location-custom-attribute-response.md +++ b/doc/models/retrieve-location-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-location-response.md b/doc/models/retrieve-location-response.md index ed6d89db..4d2f0540 100644 --- a/doc/models/retrieve-location-response.md +++ b/doc/models/retrieve-location-response.md @@ -47,20 +47,20 @@ endpoint returns in a response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-loyalty-account-response.md b/doc/models/retrieve-loyalty-account-response.md index 880cb8d3..33796157 100644 --- a/doc/models/retrieve-loyalty-account-response.md +++ b/doc/models/retrieve-loyalty-account-response.md @@ -35,20 +35,20 @@ A response that includes the loyalty account. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-loyalty-program-response.md b/doc/models/retrieve-loyalty-program-response.md index dd3d66f5..4244a005 100644 --- a/doc/models/retrieve-loyalty-program-response.md +++ b/doc/models/retrieve-loyalty-program-response.md @@ -59,11 +59,11 @@ A response that contains the loyalty program. ], "fixed_discount_money": { "amount": 63, - "currency": "DZD" + "currency": "PKR" }, "max_discount_money": { "amount": 107, - "currency": "AMD" + "currency": "PKR" } }, "id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f", @@ -87,20 +87,20 @@ A response that contains the loyalty program. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-loyalty-promotion-response.md b/doc/models/retrieve-loyalty-promotion-response.md index 6ebbd0d9..4096a0ec 100644 --- a/doc/models/retrieve-loyalty-promotion-response.md +++ b/doc/models/retrieve-loyalty-promotion-response.md @@ -57,20 +57,20 @@ Represents a [RetrieveLoyaltyPromotionPromotions](../../doc/api/loyalty.md#retri }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-loyalty-reward-response.md b/doc/models/retrieve-loyalty-reward-response.md index b78ae08f..2c30cda0 100644 --- a/doc/models/retrieve-loyalty-reward-response.md +++ b/doc/models/retrieve-loyalty-reward-response.md @@ -31,20 +31,20 @@ A response that includes the loyalty reward. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-merchant-custom-attribute-definition-response.md b/doc/models/retrieve-merchant-custom-attribute-definition-response.md index 23044af3..fb1b8aa1 100644 --- a/doc/models/retrieve-merchant-custom-attribute-definition-response.md +++ b/doc/models/retrieve-merchant-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-merchant-custom-attribute-response.md b/doc/models/retrieve-merchant-custom-attribute-response.md index e647bc21..b30398cf 100644 --- a/doc/models/retrieve-merchant-custom-attribute-response.md +++ b/doc/models/retrieve-merchant-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-merchant-response.md b/doc/models/retrieve-merchant-response.md index 447106cf..25653f50 100644 --- a/doc/models/retrieve-merchant-response.md +++ b/doc/models/retrieve-merchant-response.md @@ -30,20 +30,20 @@ The response object returned by the [RetrieveMerchant](../../doc/api/merchants.m }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-order-custom-attribute-definition-response.md b/doc/models/retrieve-order-custom-attribute-definition-response.md index c674b5f2..30f97faa 100644 --- a/doc/models/retrieve-order-custom-attribute-definition-response.md +++ b/doc/models/retrieve-order-custom-attribute-definition-response.md @@ -33,20 +33,20 @@ Represents a response from getting an order custom attribute definition. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-order-custom-attribute-response.md b/doc/models/retrieve-order-custom-attribute-response.md index 3e33d646..80788fdc 100644 --- a/doc/models/retrieve-order-custom-attribute-response.md +++ b/doc/models/retrieve-order-custom-attribute-response.md @@ -39,20 +39,20 @@ Represents a response from getting an order custom attribute. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-order-response.md b/doc/models/retrieve-order-response.md index 4e240c3a..fc76e1a1 100644 --- a/doc/models/retrieve-order-response.md +++ b/doc/models/retrieve-order-response.md @@ -208,20 +208,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-payment-link-response.md b/doc/models/retrieve-payment-link-response.md index 4b2acd72..d8764949 100644 --- a/doc/models/retrieve-payment-link-response.md +++ b/doc/models/retrieve-payment-link-response.md @@ -52,20 +52,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-snippet-response.md b/doc/models/retrieve-snippet-response.md index 5a42bd7f..3f77ab96 100644 --- a/doc/models/retrieve-snippet-response.md +++ b/doc/models/retrieve-snippet-response.md @@ -27,20 +27,20 @@ Represents a `RetrieveSnippet` response. The response can include either `snippe }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-subscription-response.md b/doc/models/retrieve-subscription-response.md index 97d5bea3..da8fc89d 100644 --- a/doc/models/retrieve-subscription-response.md +++ b/doc/models/retrieve-subscription-response.md @@ -20,45 +20,45 @@ Defines output parameters in a response from the ```json { "subscription": { - "charged_through_date": "2021-11-20", - "created_at": "2021-10-20T21:53:10Z", - "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", + "card_id": "ccof:IkWfpLj4tNHMyFii3GB", + "charged_through_date": "2023-11-20", + "created_at": "2022-07-27T21:53:10Z", + "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", "id": "8151fc89-da15-4eb9-a685-1a70883cebfc", "invoice_ids": [ - "grebK0Q_l8H4fqoMMVvt-Q", - "rcX_i3sNmHTGKhI4W2mceA" + "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", + "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA" ], "location_id": "S8GWD5R9QB376", - "paid_until_date": "2021-11-20", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", + "paid_until_date": "2024-08-01", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "price_override_money": { - "amount": 1000, + "amount": 25000, "currency": "USD" }, "source": { - "name": "My App" + "name": "My Application" }, - "start_date": "2021-10-20", + "start_date": "2022-07-27", "status": "ACTIVE", - "timezone": "America/Los_Angeles", - "plan_variation_id": "plan_variation_id8" + "timezone": "America/Los_Angeles" }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-team-member-response.md b/doc/models/retrieve-team-member-response.md index 5fa6e23a..bff14e61 100644 --- a/doc/models/retrieve-team-member-response.md +++ b/doc/models/retrieve-team-member-response.md @@ -39,20 +39,20 @@ Represents a response from a retrieve request containing a `TeamMember` object o }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-token-status-response.md b/doc/models/retrieve-token-status-response.md index 3ff39535..025325b2 100644 --- a/doc/models/retrieve-token-status-response.md +++ b/doc/models/retrieve-token-status-response.md @@ -31,20 +31,20 @@ a request to the `RetrieveTokenStatus` endpoint. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-transaction-response.md b/doc/models/retrieve-transaction-response.md index d3abc3eb..16029a35 100644 --- a/doc/models/retrieve-transaction-response.md +++ b/doc/models/retrieve-transaction-response.md @@ -73,12 +73,12 @@ One of `errors` or `transaction` is present in a given response (never both). "reason": "reason8", "amount_money": { "amount": 162, - "currency": "AOA" + "currency": "XPF" }, "status": "PENDING", "processing_fee_money": { "amount": 88, - "currency": "HUF" + "currency": "COU" }, "additional_recipients": [ { @@ -86,7 +86,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description5", "amount_money": { "amount": 59, - "currency": "LAK" + "currency": "BOB" }, "receivable_id": "receivable_id5" } @@ -101,12 +101,12 @@ One of `errors` or `transaction` is present in a given response (never both). "reason": "reason7", "amount_money": { "amount": 163, - "currency": "ARS" + "currency": "XPT" }, "status": "FAILED", "processing_fee_money": { "amount": 89, - "currency": "IDR" + "currency": "CRC" }, "additional_recipients": [ { @@ -114,7 +114,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description6", "amount_money": { "amount": 60, - "currency": "LBP" + "currency": "BOV" }, "receivable_id": "receivable_id6" }, @@ -123,7 +123,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description7", "amount_money": { "amount": 61, - "currency": "LKR" + "currency": "BRL" }, "receivable_id": "receivable_id7" } @@ -138,12 +138,12 @@ One of `errors` or `transaction` is present in a given response (never both). "reason": "reason6", "amount_money": { "amount": 164, - "currency": "AUD" + "currency": "XTS" }, "status": "REJECTED", "processing_fee_money": { "amount": 90, - "currency": "ILS" + "currency": "CUC" }, "additional_recipients": [ { @@ -151,7 +151,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description7", "amount_money": { "amount": 61, - "currency": "LKR" + "currency": "BRL" }, "receivable_id": "receivable_id7" }, @@ -160,7 +160,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description8", "amount_money": { "amount": 62, - "currency": "LRD" + "currency": "BSD" }, "receivable_id": "receivable_id8" }, @@ -169,7 +169,7 @@ One of `errors` or `transaction` is present in a given response (never both). "description": "description9", "amount_money": { "amount": 63, - "currency": "LSL" + "currency": "BTN" }, "receivable_id": "receivable_id9" } @@ -179,20 +179,20 @@ One of `errors` or `transaction` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-vendor-response.md b/doc/models/retrieve-vendor-response.md index a0843173..9e0e51af 100644 --- a/doc/models/retrieve-vendor-response.md +++ b/doc/models/retrieve-vendor-response.md @@ -20,20 +20,20 @@ Represents an output from a call to [RetrieveVendor](../../doc/api/vendors.md#re { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-wage-setting-response.md b/doc/models/retrieve-wage-setting-response.md index 6b3bc6d3..e2b22b3e 100644 --- a/doc/models/retrieve-wage-setting-response.md +++ b/doc/models/retrieve-wage-setting-response.md @@ -42,20 +42,20 @@ Represents a response from a retrieve request containing the specified `WageSett }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/retrieve-webhook-subscription-response.md b/doc/models/retrieve-webhook-subscription-response.md index a20f505b..7a37daef 100644 --- a/doc/models/retrieve-webhook-subscription-response.md +++ b/doc/models/retrieve-webhook-subscription-response.md @@ -38,20 +38,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/revoke-token-response.md b/doc/models/revoke-token-response.md index 02aaee63..c39e0aa1 100644 --- a/doc/models/revoke-token-response.md +++ b/doc/models/revoke-token-response.md @@ -19,20 +19,20 @@ "success": true, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-catalog-items-response.md b/doc/models/search-catalog-items-response.md index f88f831a..333cd31b 100644 --- a/doc/models/search-catalog-items-response.md +++ b/doc/models/search-catalog-items-response.md @@ -22,20 +22,20 @@ Defines the response body returned from the [SearchCatalogItems](../../doc/api/c { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-catalog-objects-response.md b/doc/models/search-catalog-objects-response.md index bc30d67e..64a71774 100644 --- a/doc/models/search-catalog-objects-response.md +++ b/doc/models/search-catalog-objects-response.md @@ -158,20 +158,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-customers-request.md b/doc/models/search-customers-request.md index 562458e0..586ab780 100644 --- a/doc/models/search-customers-request.md +++ b/doc/models/search-customers-request.md @@ -15,6 +15,7 @@ Defines the fields that are included in the request body of a request to the | `cursor` | `string \| undefined` | Optional | Include the pagination cursor in subsequent calls to this endpoint to retrieve
the next set of results associated with the original query.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `limit` | `bigint \| undefined` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | | `query` | [`CustomerQuery \| undefined`](../../doc/models/customer-query.md) | Optional | Represents filtering and sorting criteria for a [SearchCustomers](../../doc/api/customers.md#search-customers) request. | +| `count` | `boolean \| undefined` | Optional | Indicates whether to return the total count of matching customers in the `count` field of the response.

The default value is `false`. | ## Example (as JSON) @@ -56,7 +57,8 @@ Defines the fields that are included in the request body of a request to the "order": "ASC" } }, - "cursor": "cursor6" + "cursor": "cursor6", + "count": false } ``` diff --git a/doc/models/search-customers-response.md b/doc/models/search-customers-response.md index 13f301ef..1f137b80 100644 --- a/doc/models/search-customers-response.md +++ b/doc/models/search-customers-response.md @@ -15,8 +15,9 @@ Either `errors` or `customers` is present in a given response (never both). | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `customers` | [`Customer[] \| undefined`](../../doc/models/customer.md) | Optional | The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`). | +| `customers` | [`Customer[] \| undefined`](../../doc/models/customer.md) | Optional | The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`).
Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`)
are included in the response. | | `cursor` | `string \| undefined` | Optional | A pagination cursor that can be used during subsequent calls
to `SearchCustomers` to retrieve the next set of results associated
with the original query. Pagination cursors are only present when
a request succeeds and additional results are available.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | +| `count` | `bigint \| undefined` | Optional | The total count of customers associated with the Square account that match the search query. Only customer profiles with
public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is
present only if `count` is set to `true` in the request. | ## Example (as JSON) @@ -125,24 +126,25 @@ Either `errors` or `customers` is present in a given response (never both). ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } - ] + ], + "count": 60 } ``` diff --git a/doc/models/search-invoices-response.md b/doc/models/search-invoices-response.md index 2caf5e0e..43c813c9 100644 --- a/doc/models/search-invoices-response.md +++ b/doc/models/search-invoices-response.md @@ -26,6 +26,7 @@ Describes a `SearchInvoices` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -100,6 +101,7 @@ Describes a `SearchInvoices` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": true }, "created_at": "2021-01-23T15:29:12Z", @@ -172,20 +174,20 @@ Describes a `SearchInvoices` response. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-loyalty-accounts-response.md b/doc/models/search-loyalty-accounts-response.md index 6f595c3e..3d2e104d 100644 --- a/doc/models/search-loyalty-accounts-response.md +++ b/doc/models/search-loyalty-accounts-response.md @@ -38,20 +38,20 @@ A response that includes loyalty accounts that satisfy the search criteria. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-loyalty-events-response.md b/doc/models/search-loyalty-events-response.md index 66f6ef4f..5989aac4 100644 --- a/doc/models/search-loyalty-events-response.md +++ b/doc/models/search-loyalty-events-response.md @@ -122,20 +122,20 @@ criteria, in order by the `created_at` date. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-loyalty-rewards-response.md b/doc/models/search-loyalty-rewards-response.md index 630f1160..f24cca26 100644 --- a/doc/models/search-loyalty-rewards-response.md +++ b/doc/models/search-loyalty-rewards-response.md @@ -65,20 +65,20 @@ A response that includes the loyalty rewards satisfying the search criteria. ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-orders-response.md b/doc/models/search-orders-response.md index 2bcc190f..6f0f92f0 100644 --- a/doc/models/search-orders-response.md +++ b/doc/models/search-orders-response.md @@ -153,20 +153,20 @@ Either the `order_entries` or `orders` field is set, depending on whether ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-shifts-response.md b/doc/models/search-shifts-response.md index 978d0971..b77cc1f2 100644 --- a/doc/models/search-shifts-response.md +++ b/doc/models/search-shifts-response.md @@ -50,6 +50,7 @@ the request resulted in errors. "amount": 1100, "currency": "USD" }, + "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", "title": "Barista" } }, @@ -90,6 +91,7 @@ the request resulted in errors. "amount": 1600, "currency": "USD" }, + "job_id": "gcbz15vKGnMKmaWJJ152kjim", "title": "Cook" } } @@ -97,20 +99,20 @@ the request resulted in errors. "cursor": "cursor6", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-subscriptions-response.md b/doc/models/search-subscriptions-response.md index b5781abc..3a919027 100644 --- a/doc/models/search-subscriptions-response.md +++ b/doc/models/search-subscriptions-response.md @@ -22,7 +22,7 @@ Defines output parameters in a response from the { "subscriptions": [ { - "canceled_date": "2021-10-20", + "canceled_date": "2021-10-30", "card_id": "ccof:mueUsvgajChmjEbp4GB", "charged_through_date": "2021-11-20", "created_at": "2021-10-20T21:53:10Z", @@ -30,76 +30,78 @@ Defines output parameters in a response from the "id": "de86fc96-8664-474b-af1a-abbe59cacf0e", "location_id": "S8GWD5R9QB376", "paid_until_date": "2021-11-20", - "plan_id": "L3TJVDHVBEQEGQDEZL2JJM7R", + "plan_variation_id": "L3TJVDHVBEQEGQDEZL2JJM7R", "source": { "name": "My Application" }, "start_date": "2021-10-20", "status": "CANCELED", - "timezone": "UTC", - "plan_variation_id": "plan_variation_id3" + "timezone": "UTC" }, { - "created_at": "2021-10-20T21:53:10Z", + "charged_through_date": "2022-08-19", + "created_at": "2022-01-19T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", + "invoice_ids": [ + "grebK0Q_l8H4fqoMMVvt-Q", + "rcX_i3sNmHTGKhI4W2mceA" + ], "location_id": "S8GWD5R9QB376", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "price_override_money": { - "amount": 100, + "amount": 1000, "currency": "USD" }, "source": { "name": "My Application" }, - "start_date": "2021-10-20", - "status": "PENDING", + "start_date": "2022-01-19", + "status": "PAUSED", "tax_percentage": "5", "timezone": "America/Los_Angeles", - "version": 1594155459464, - "plan_variation_id": "plan_variation_id4" + "version": 2 }, { - "charged_through_date": "2021-11-20", - "created_at": "2021-10-20T21:53:10Z", + "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", + "created_at": "2023-06-20T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", - "id": "8151fc89-da15-4eb9-a685-1a70883cebfc", - "invoice_ids": [ - "grebK0Q_l8H4fqoMMVvt-Q", - "rcX_i3sNmHTGKhI4W2mceA" - ], + "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f", "location_id": "S8GWD5R9QB376", - "paid_until_date": "2021-11-20", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", - "price_override_money": { - "amount": 1000, - "currency": "USD" - }, + "phases": [ + { + "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", + "ordinal": 0, + "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP", + "uid": "873451e0-745b-4e87-ab0b-c574933fe616" + } + ], + "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": { "name": "My Application" }, - "start_date": "2021-10-20", + "start_date": "2023-06-20", "status": "ACTIVE", "timezone": "America/Los_Angeles", - "plan_variation_id": "plan_variation_id5" + "version": 1 } ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-team-members-response.md b/doc/models/search-team-members-response.md index b1a81985..009ac9a2 100644 --- a/doc/models/search-team-members-response.md +++ b/doc/models/search-team-members-response.md @@ -163,20 +163,20 @@ Represents a response from a search request containing a filtered list of `TeamM ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-terminal-actions-response.md b/doc/models/search-terminal-actions-response.md index 2572b2df..5f8d414b 100644 --- a/doc/models/search-terminal-actions-response.md +++ b/doc/models/search-terminal-actions-response.md @@ -55,20 +55,20 @@ "cursor": "CURSOR", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-terminal-checkouts-response.md b/doc/models/search-terminal-checkouts-response.md index e0e4c988..3a6abebf 100644 --- a/doc/models/search-terminal-checkouts-response.md +++ b/doc/models/search-terminal-checkouts-response.md @@ -103,20 +103,20 @@ "cursor": "RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-terminal-refunds-response.md b/doc/models/search-terminal-refunds-response.md index 3051376e..b6301922 100644 --- a/doc/models/search-terminal-refunds-response.md +++ b/doc/models/search-terminal-refunds-response.md @@ -48,20 +48,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/search-vendors-response.md b/doc/models/search-vendors-response.md index 9b72b3f9..aef070d8 100644 --- a/doc/models/search-vendors-response.md +++ b/doc/models/search-vendors-response.md @@ -21,20 +21,20 @@ Represents an output from a call to [SearchVendors](../../doc/api/vendors.md#sea { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/shift-wage.md b/doc/models/shift-wage.md index 237684fd..f4854bad 100644 --- a/doc/models/shift-wage.md +++ b/doc/models/shift-wage.md @@ -22,7 +22,7 @@ The hourly wage rate used to compensate an employee for this shift. "title": "title4", "hourly_rate": { "amount": 172, - "currency": "TJS" + "currency": "OMR" }, "job_id": "job_id2" } diff --git a/doc/models/shipping-fee.md b/doc/models/shipping-fee.md index b1cfeb1b..bff0769d 100644 --- a/doc/models/shipping-fee.md +++ b/doc/models/shipping-fee.md @@ -19,7 +19,7 @@ "name": "name0", "charge": { "amount": 80, - "currency": "CUC" + "currency": "UNKNOWN_CURRENCY" } } ``` diff --git a/doc/models/snippet-response.md b/doc/models/snippet-response.md index 5e41f430..c055378a 100644 --- a/doc/models/snippet-response.md +++ b/doc/models/snippet-response.md @@ -18,20 +18,20 @@ { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/submit-evidence-response.md b/doc/models/submit-evidence-response.md index 3513cadf..c2c584c3 100644 --- a/doc/models/submit-evidence-response.md +++ b/doc/models/submit-evidence-response.md @@ -41,20 +41,20 @@ Defines the fields in a `SubmitEvidence` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/subscription-phase.md b/doc/models/subscription-phase.md index ea974263..33fed683 100644 --- a/doc/models/subscription-phase.md +++ b/doc/models/subscription-phase.md @@ -27,7 +27,7 @@ Describes a phase in a subscription plan variation. For more information, see [S "periods": 142, "recurring_price_money": { "amount": 66, - "currency": "NAD" + "currency": "TMT" }, "ordinal": 80, "pricing": { @@ -38,7 +38,7 @@ Describes a phase in a subscription plan variation. For more information, see [S ], "price_money": { "amount": 40, - "currency": "SHP" + "currency": "RWF" } } } diff --git a/doc/models/subscription-pricing.md b/doc/models/subscription-pricing.md index 97cbcc6e..298ef1a3 100644 --- a/doc/models/subscription-pricing.md +++ b/doc/models/subscription-pricing.md @@ -26,7 +26,7 @@ Describes the pricing for the subscription. ], "price_money": { "amount": 202, - "currency": "BBD" + "currency": "CNY" } } ``` diff --git a/doc/models/swap-plan-request.md b/doc/models/swap-plan-request.md index b4a4f7bc..69ee6415 100644 --- a/doc/models/swap-plan-request.md +++ b/doc/models/swap-plan-request.md @@ -19,15 +19,11 @@ Defines input parameters in a call to the ```json { - "new_plan_variation_id": "new_plan_variation_id0", + "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", "phases": [ { - "ordinal": 207, - "order_template_id": "order_template_id7" - }, - { - "ordinal": 208, - "order_template_id": "order_template_id8" + "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY", + "ordinal": 0 } ] } diff --git a/doc/models/swap-plan-response.md b/doc/models/swap-plan-response.md index 32a1f2bd..8e3b53f1 100644 --- a/doc/models/swap-plan-response.md +++ b/doc/models/swap-plan-response.md @@ -22,9 +22,9 @@ Defines output parameters in a response of the { "actions": [ { - "effective_date": "2021-11-17", + "effective_date": "2023-11-17", "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83", - "new_plan_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", + "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", "phases": [ { "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY", @@ -33,12 +33,11 @@ Defines output parameters in a response of the "plan_phase_uid": "plan_phase_uid2" } ], - "type": "SWAP_PLAN", - "new_plan_variation_id": "new_plan_variation_id9" + "type": "SWAP_PLAN" } ], "subscription": { - "created_at": "2021-10-20T21:53:10Z", + "created_at": "2023-06-20T21:53:10Z", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", "id": "9ba40961-995a-4a3d-8c53-048c40cafc13", "location_id": "S8GWD5R9QB376", @@ -50,36 +49,35 @@ Defines output parameters in a response of the "uid": "98d6f53b-40e1-4714-8827-032fd923be25" } ], - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", + "plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", "price_override_money": { "amount": 2000, "currency": "USD" }, "source": { - "name": "My App" + "name": "My Application" }, "status": "ACTIVE", "timezone": "America/Los_Angeles", - "version": 1594311617331, - "plan_variation_id": "plan_variation_id8", + "version": 3, "start_date": "start_date8" }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/team-member-wage.md b/doc/models/team-member-wage.md index 46dd76ca..825433c8 100644 --- a/doc/models/team-member-wage.md +++ b/doc/models/team-member-wage.md @@ -27,7 +27,7 @@ specified by the `title` property of this object. "title": "title4", "hourly_rate": { "amount": 172, - "currency": "TJS" + "currency": "OMR" }, "job_id": "job_id2" } diff --git a/doc/models/tender-cash-details.md b/doc/models/tender-cash-details.md index e601b8d9..0689da46 100644 --- a/doc/models/tender-cash-details.md +++ b/doc/models/tender-cash-details.md @@ -20,11 +20,11 @@ Represents the details of a tender with `type` `CASH`. { "buyer_tendered_money": { "amount": 238, - "currency": "JMD" + "currency": "QAR" }, "change_back_money": { "amount": 78, - "currency": "MUR" + "currency": "DJF" } } ``` diff --git a/doc/models/terminal-action.md b/doc/models/terminal-action.md index 92945185..bc2ce229 100644 --- a/doc/models/terminal-action.md +++ b/doc/models/terminal-action.md @@ -19,6 +19,7 @@ Represents an action processed by the Square Terminal. | `createdAt` | `string \| undefined` | Optional | The time when the `TerminalAction` was created as an RFC 3339 timestamp. | | `updatedAt` | `string \| undefined` | Optional | The time when the `TerminalAction` was last updated as an RFC 3339 timestamp. | | `appId` | `string \| undefined` | Optional | The ID of the application that created the action. | +| `locationId` | `string \| undefined` | Optional | The location id the action is attached to, if a link can be made.
**Constraints**: *Maximum Length*: `64` | | `type` | [`string \| undefined`](../../doc/models/terminal-action-action-type.md) | Optional | Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. | | `qrCodeOptions` | [`QrCodeOptions \| undefined`](../../doc/models/qr-code-options.md) | Optional | Fields to describe the action that displays QR-Codes. | | `saveCardOptions` | [`SaveCardOptions \| undefined`](../../doc/models/save-card-options.md) | Optional | Describes save-card action fields. | diff --git a/doc/models/terminal-checkout.md b/doc/models/terminal-checkout.md index 54271287..eba906cb 100644 --- a/doc/models/terminal-checkout.md +++ b/doc/models/terminal-checkout.md @@ -25,7 +25,7 @@ Represents a checkout processed by the Square Terminal. | `createdAt` | `string \| undefined` | Optional | The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp. | | `updatedAt` | `string \| undefined` | Optional | The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp. | | `appId` | `string \| undefined` | Optional | The ID of the application that created the checkout. | -| `locationId` | `string \| undefined` | Optional | The location of the device where the `TerminalCheckout` was directed. | +| `locationId` | `string \| undefined` | Optional | The location of the device where the `TerminalCheckout` was directed.
**Constraints**: *Maximum Length*: `64` | | `paymentType` | [`string \| undefined`](../../doc/models/checkout-options-payment-type.md) | Optional | - | | `teamMemberId` | `string \| undefined` | Optional | An optional ID of the team member associated with creating the checkout. | | `customerId` | `string \| undefined` | Optional | An optional ID of the customer associated with the checkout. | @@ -40,7 +40,7 @@ Represents a checkout processed by the Square Terminal. "id": "id0", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reference_id": "reference_id2", "note": "note4", diff --git a/doc/models/terminal-refund.md b/doc/models/terminal-refund.md index d5b34a21..c6db16d7 100644 --- a/doc/models/terminal-refund.md +++ b/doc/models/terminal-refund.md @@ -24,7 +24,7 @@ Represents a payment refund processed by the Square Terminal. Only supports Inte | `createdAt` | `string \| undefined` | Optional | The time when the `TerminalRefund` was created, as an RFC 3339 timestamp. | | `updatedAt` | `string \| undefined` | Optional | The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp. | | `appId` | `string \| undefined` | Optional | The ID of the application that created the refund. | -| `locationId` | `string \| undefined` | Optional | The location of the device where the `TerminalRefund` was directed. | +| `locationId` | `string \| undefined` | Optional | The location of the device where the `TerminalRefund` was directed.
**Constraints**: *Maximum Length*: `64` | ## Example (as JSON) @@ -36,7 +36,7 @@ Represents a payment refund processed by the Square Terminal. Only supports Inte "order_id": "order_id6", "amount_money": { "amount": 186, - "currency": "NGN" + "currency": "TZS" }, "reason": "reason4", "device_id": "device_id6", diff --git a/doc/models/test-webhook-subscription-response.md b/doc/models/test-webhook-subscription-response.md index 5da14d90..29b63913 100644 --- a/doc/models/test-webhook-subscription-response.md +++ b/doc/models/test-webhook-subscription-response.md @@ -31,20 +31,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/transaction.md b/doc/models/transaction.md index 6fa6a2db..46e9ad20 100644 --- a/doc/models/transaction.md +++ b/doc/models/transaction.md @@ -69,12 +69,12 @@ the transaction. "reason": "reason0", "amount_money": { "amount": 186, - "currency": "YER" + "currency": "DJF" }, "status": "PENDING", "processing_fee_money": { "amount": 112, - "currency": "GEL" + "currency": "LTL" }, "additional_recipients": [ { @@ -82,7 +82,7 @@ the transaction. "description": "description3", "amount_money": { "amount": 83, - "currency": "JOD" + "currency": "JMD" }, "receivable_id": "receivable_id3" } @@ -97,12 +97,12 @@ the transaction. "reason": "reason9", "amount_money": { "amount": 187, - "currency": "ZAR" + "currency": "DKK" }, "status": "APPROVED", "processing_fee_money": { "amount": 113, - "currency": "GHS" + "currency": "LVL" }, "additional_recipients": [ { @@ -110,7 +110,7 @@ the transaction. "description": "description4", "amount_money": { "amount": 84, - "currency": "JPY" + "currency": "JOD" }, "receivable_id": "receivable_id4" }, @@ -119,7 +119,7 @@ the transaction. "description": "description5", "amount_money": { "amount": 85, - "currency": "KES" + "currency": "JPY" }, "receivable_id": "receivable_id5" } @@ -134,12 +134,12 @@ the transaction. "reason": "reason8", "amount_money": { "amount": 188, - "currency": "ZMK" + "currency": "DOP" }, "status": "REJECTED", "processing_fee_money": { "amount": 114, - "currency": "GIP" + "currency": "LYD" }, "additional_recipients": [ { @@ -147,7 +147,7 @@ the transaction. "description": "description5", "amount_money": { "amount": 85, - "currency": "KES" + "currency": "JPY" }, "receivable_id": "receivable_id5" }, @@ -156,7 +156,7 @@ the transaction. "description": "description6", "amount_money": { "amount": 86, - "currency": "KGS" + "currency": "KES" }, "receivable_id": "receivable_id6" }, @@ -165,7 +165,7 @@ the transaction. "description": "description7", "amount_money": { "amount": 87, - "currency": "KHR" + "currency": "KGS" }, "receivable_id": "receivable_id7" } diff --git a/doc/models/unlink-customer-from-gift-card-response.md b/doc/models/unlink-customer-from-gift-card-response.md index 8559acf3..6d7ed025 100644 --- a/doc/models/unlink-customer-from-gift-card-response.md +++ b/doc/models/unlink-customer-from-gift-card-response.md @@ -33,20 +33,20 @@ the response contains a set of `Error` objects. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-break-type-response.md b/doc/models/update-break-type-response.md index c466800f..1fe66f2c 100644 --- a/doc/models/update-break-type-response.md +++ b/doc/models/update-break-type-response.md @@ -32,20 +32,20 @@ the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-catalog-image-response.md b/doc/models/update-catalog-image-response.md index 56e8636b..6559fca4 100644 --- a/doc/models/update-catalog-image-response.md +++ b/doc/models/update-catalog-image-response.md @@ -60,20 +60,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-customer-custom-attribute-definition-response.md b/doc/models/update-customer-custom-attribute-definition-response.md index be3532b9..67ddc78f 100644 --- a/doc/models/update-customer-custom-attribute-definition-response.md +++ b/doc/models/update-customer-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-customer-group-response.md b/doc/models/update-customer-group-response.md index b9ab3701..ec5e5d00 100644 --- a/doc/models/update-customer-group-response.md +++ b/doc/models/update-customer-group-response.md @@ -29,20 +29,20 @@ Either `errors` or `group` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-customer-response.md b/doc/models/update-customer-response.md index 40ffb273..e92b9b29 100644 --- a/doc/models/update-customer-response.md +++ b/doc/models/update-customer-response.md @@ -55,20 +55,20 @@ Either `errors` or `customer` is present in a given response (never both). }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-invoice-response.md b/doc/models/update-invoice-response.md index 1c270d94..d6a7f040 100644 --- a/doc/models/update-invoice-response.md +++ b/doc/models/update-invoice-response.md @@ -23,6 +23,7 @@ Describes a `UpdateInvoice` response. "bank_account": false, "buy_now_pay_later": false, "card": true, + "cash_app_pay": false, "square_gift_card": false }, "created_at": "2020-06-18T17:45:13Z", @@ -90,20 +91,20 @@ Describes a `UpdateInvoice` response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-item-modifier-lists-response.md b/doc/models/update-item-modifier-lists-response.md index 7142cee4..52d45a49 100644 --- a/doc/models/update-item-modifier-lists-response.md +++ b/doc/models/update-item-modifier-lists-response.md @@ -19,20 +19,20 @@ "updated_at": "2016-11-16T22:25:24.878Z", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-item-taxes-response.md b/doc/models/update-item-taxes-response.md index 8569832e..7a448beb 100644 --- a/doc/models/update-item-taxes-response.md +++ b/doc/models/update-item-taxes-response.md @@ -19,20 +19,20 @@ "updated_at": "2016-11-16T22:25:24.878Z", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-location-custom-attribute-definition-response.md b/doc/models/update-location-custom-attribute-definition-response.md index a3aa94a4..cb928254 100644 --- a/doc/models/update-location-custom-attribute-definition-response.md +++ b/doc/models/update-location-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-location-response.md b/doc/models/update-location-response.md index b3936552..0786acaf 100644 --- a/doc/models/update-location-response.md +++ b/doc/models/update-location-response.md @@ -70,20 +70,20 @@ The response object returned by the [UpdateLocation](../../doc/api/locations.md# }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-merchant-custom-attribute-definition-response.md b/doc/models/update-merchant-custom-attribute-definition-response.md index 5828948f..0e9b477e 100644 --- a/doc/models/update-merchant-custom-attribute-definition-response.md +++ b/doc/models/update-merchant-custom-attribute-definition-response.md @@ -34,20 +34,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-order-custom-attribute-definition-response.md b/doc/models/update-order-custom-attribute-definition-response.md index fbdb4580..d203926e 100644 --- a/doc/models/update-order-custom-attribute-definition-response.md +++ b/doc/models/update-order-custom-attribute-definition-response.md @@ -33,20 +33,20 @@ Represents a response from updating an order custom attribute definition. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-order-response.md b/doc/models/update-order-response.md index 1c96cb79..5949d15a 100644 --- a/doc/models/update-order-response.md +++ b/doc/models/update-order-response.md @@ -170,20 +170,20 @@ a request to the [UpdateOrder](../../doc/api/orders.md#update-order) endpoint. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-payment-link-response.md b/doc/models/update-payment-link-response.md index c15a93b8..f1394825 100644 --- a/doc/models/update-payment-link-response.md +++ b/doc/models/update-payment-link-response.md @@ -55,20 +55,20 @@ }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-payment-response.md b/doc/models/update-payment-response.md index 14777371..8f00232a 100644 --- a/doc/models/update-payment-response.md +++ b/doc/models/update-payment-response.md @@ -88,20 +88,20 @@ Defines the response returned by }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-shift-response.md b/doc/models/update-shift-response.md index c52e5928..0f12536e 100644 --- a/doc/models/update-shift-response.md +++ b/doc/models/update-shift-response.md @@ -48,25 +48,26 @@ the request resulted in errors. "amount": 1500, "currency": "USD" }, + "job_id": "dZtrPh5GSDGugyXGByesVp51", "title": "Bartender" } }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-subscription-request.md b/doc/models/update-subscription-request.md index 8d18f51e..2cfe2359 100644 --- a/doc/models/update-subscription-request.md +++ b/doc/models/update-subscription-request.md @@ -19,12 +19,8 @@ Defines input parameters in a request to the ```json { "subscription": { - "price_override_money": { - "amount": 2000, - "currency": "USD" - }, - "tax_percentage": null, - "version": 1594155459464, + "canceled_date": null, + "card_id": "{NEW CARD ID}", "id": "id4", "location_id": "location_id8", "plan_variation_id": "plan_variation_id8", diff --git a/doc/models/update-subscription-response.md b/doc/models/update-subscription-response.md index c30e99c4..0363fef5 100644 --- a/doc/models/update-subscription-response.md +++ b/doc/models/update-subscription-response.md @@ -20,40 +20,41 @@ Defines output parameters in a response from the ```json { "subscription": { - "created_at": "2021-10-20T21:53:10Z", - "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", - "id": "9ba40961-995a-4a3d-8c53-048c40cafc13", - "location_id": "S8GWD5R9QB376", - "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", - "price_override_money": { - "amount": 2000, - "currency": "USD" - }, + "card_id": "{NEW CARD ID}", + "charged_through_date": "2023-03-13", + "created_at": "2023-01-30T19:27:32Z", + "customer_id": "AM69AB81FT4479YH9HGWS1HZY8", + "id": "7217d8ca-1fee-4446-a9e5-8540b5d8c9bb", + "invoice_ids": [ + "inv:0-ChAPSfVYvNewckgf3x4iigN_ENMM", + "inv:0-ChBQaCCLfjcm9WEUBGxvuydJENMM" + ], + "location_id": "LPJKHYR7WFDKN", + "plan_variation_id": "XOUNEKCE6NSXQW5NTSQ73MMX", "source": { - "name": "My App" + "name": "My Application" }, + "start_date": "2023-01-30", "status": "ACTIVE", - "timezone": "America/Los_Angeles", - "version": 1594311617331, - "plan_variation_id": "plan_variation_id8", - "start_date": "start_date8" + "timezone": "UTC", + "version": 3 }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-team-member-response.md b/doc/models/update-team-member-response.md index f93d54cc..03110d3e 100644 --- a/doc/models/update-team-member-response.md +++ b/doc/models/update-team-member-response.md @@ -39,20 +39,20 @@ Represents a response from an update request containing the updated `TeamMember` }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-wage-setting-request.md b/doc/models/update-wage-setting-request.md index bbfa7351..cfee0a57 100644 --- a/doc/models/update-wage-setting-request.md +++ b/doc/models/update-wage-setting-request.md @@ -30,7 +30,7 @@ Represents an update request for the `WageSetting` object describing a `TeamMemb "weekly_hours": 40, "hourly_rate": { "amount": 125, - "currency": "ETB" + "currency": "XUS" } }, { @@ -42,7 +42,7 @@ Represents an update request for the `WageSetting` object describing a `TeamMemb "pay_type": "HOURLY", "annual_rate": { "amount": 66, - "currency": "EGP" + "currency": "XCD" }, "weekly_hours": 234 } diff --git a/doc/models/update-wage-setting-response.md b/doc/models/update-wage-setting-response.md index d72dfdd8..e3cacce5 100644 --- a/doc/models/update-wage-setting-response.md +++ b/doc/models/update-wage-setting-response.md @@ -45,7 +45,7 @@ or error messages. "pay_type": "HOURLY", "annual_rate": { "amount": 66, - "currency": "EGP" + "currency": "XCD" }, "weekly_hours": 234 } @@ -56,20 +56,20 @@ or error messages. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-webhook-subscription-response.md b/doc/models/update-webhook-subscription-response.md index f09860aa..b5b99f23 100644 --- a/doc/models/update-webhook-subscription-response.md +++ b/doc/models/update-webhook-subscription-response.md @@ -37,20 +37,20 @@ present. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-webhook-subscription-signature-key-response.md b/doc/models/update-webhook-subscription-signature-key-response.md index 3d3c3f1b..ef8f6256 100644 --- a/doc/models/update-webhook-subscription-signature-key-response.md +++ b/doc/models/update-webhook-subscription-signature-key-response.md @@ -25,20 +25,20 @@ present. "signature_key": "1k9bIJKCeTmSQwyagtNRLg", "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/update-workweek-config-response.md b/doc/models/update-workweek-config-response.md index 35d8be0a..58ee1f25 100644 --- a/doc/models/update-workweek-config-response.md +++ b/doc/models/update-workweek-config-response.md @@ -30,20 +30,20 @@ the request resulted in errors. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-booking-custom-attribute-response.md b/doc/models/upsert-booking-custom-attribute-response.md index 6231da09..b3c844a8 100644 --- a/doc/models/upsert-booking-custom-attribute-response.md +++ b/doc/models/upsert-booking-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-catalog-object-response.md b/doc/models/upsert-catalog-object-response.md index 45ce2f2e..0024bbb8 100644 --- a/doc/models/upsert-catalog-object-response.md +++ b/doc/models/upsert-catalog-object-response.md @@ -122,20 +122,20 @@ ], "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-customer-custom-attribute-response.md b/doc/models/upsert-customer-custom-attribute-response.md index a526f01c..83aedcf1 100644 --- a/doc/models/upsert-customer-custom-attribute-response.md +++ b/doc/models/upsert-customer-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-location-custom-attribute-response.md b/doc/models/upsert-location-custom-attribute-response.md index a97d2d4d..d2a7301c 100644 --- a/doc/models/upsert-location-custom-attribute-response.md +++ b/doc/models/upsert-location-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-merchant-custom-attribute-response.md b/doc/models/upsert-merchant-custom-attribute-response.md index 8bb83754..4570b842 100644 --- a/doc/models/upsert-merchant-custom-attribute-response.md +++ b/doc/models/upsert-merchant-custom-attribute-response.md @@ -40,20 +40,20 @@ Either `custom_attribute_definition` or `errors` is present in the response. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-order-custom-attribute-response.md b/doc/models/upsert-order-custom-attribute-response.md index 7813f44e..641b5611 100644 --- a/doc/models/upsert-order-custom-attribute-response.md +++ b/doc/models/upsert-order-custom-attribute-response.md @@ -39,20 +39,20 @@ Represents a response from upserting order custom attribute definitions. }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/upsert-snippet-response.md b/doc/models/upsert-snippet-response.md index 1c2016be..3ab6a593 100644 --- a/doc/models/upsert-snippet-response.md +++ b/doc/models/upsert-snippet-response.md @@ -27,20 +27,20 @@ Represents an `UpsertSnippet` response. The response can include either `snippet }, "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/v1-create-refund-request.md b/doc/models/v1-create-refund-request.md index d08275b3..77aeca04 100644 --- a/doc/models/v1-create-refund-request.md +++ b/doc/models/v1-create-refund-request.md @@ -26,7 +26,7 @@ V1CreateRefundRequest "reason": "reason4", "refunded_money": { "amount": 214, - "currency_code": "CHW" + "currency_code": "SRD" }, "request_idempotence_key": "request_idempotence_key8" } diff --git a/doc/models/v1-list-orders-response.md b/doc/models/v1-list-orders-response.md index ffa5806b..4a70b13a 100644 --- a/doc/models/v1-list-orders-response.md +++ b/doc/models/v1-list-orders-response.md @@ -19,20 +19,20 @@ { "errors": [ { - "category": "MERCHANT_SUBSCRIPTION_ERROR", - "code": "GENERIC_DECLINE", + "category": "API_ERROR", + "code": "REFUND_ALREADY_PENDING", "detail": "detail8", "field": "field6" }, { - "category": "API_ERROR", - "code": "CVV_FAILURE", + "category": "AUTHENTICATION_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", "detail": "detail9", "field": "field7" }, { - "category": "AUTHENTICATION_ERROR", - "code": "ADDRESS_VERIFICATION_FAILURE", + "category": "INVALID_REQUEST_ERROR", + "code": "REFUND_DECLINED", "detail": "detail0", "field": "field8" } @@ -45,8 +45,8 @@ { "errors": [ { - "category": "API_ERROR", - "code": "CVV_FAILURE", + "category": "AUTHENTICATION_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", "detail": "detail9", "field": "field7" } diff --git a/doc/models/v1-list-refunds-response.md b/doc/models/v1-list-refunds-response.md index 69db06b2..709303ee 100644 --- a/doc/models/v1-list-refunds-response.md +++ b/doc/models/v1-list-refunds-response.md @@ -21,15 +21,15 @@ "reason": "reason7", "refunded_money": { "amount": 17, - "currency_code": "XTS" + "currency_code": "USS" }, "refunded_processing_fee_money": { "amount": 59, - "currency_code": "GYD" + "currency_code": "ANG" }, "refunded_tax_money": { "amount": 115, - "currency_code": "NIO" + "currency_code": "LSL" } }, { @@ -37,15 +37,15 @@ "reason": "reason6", "refunded_money": { "amount": 18, - "currency_code": "XXX" + "currency_code": "UYI" }, "refunded_processing_fee_money": { "amount": 60, - "currency_code": "HKD" + "currency_code": "AOA" }, "refunded_tax_money": { "amount": 116, - "currency_code": "NOK" + "currency_code": "LTL" } } ] diff --git a/doc/models/v1-list-settlements-response.md b/doc/models/v1-list-settlements-response.md index dafe2026..8a28c258 100644 --- a/doc/models/v1-list-settlements-response.md +++ b/doc/models/v1-list-settlements-response.md @@ -21,7 +21,7 @@ "status": "SENT", "total_money": { "amount": 53, - "currency_code": "PGK" + "currency_code": "MWK" }, "initiated_at": "initiated_at9", "bank_account_id": "bank_account_id7" @@ -31,7 +31,7 @@ "status": "FAILED", "total_money": { "amount": 54, - "currency_code": "PHP" + "currency_code": "MXN" }, "initiated_at": "initiated_at0", "bank_account_id": "bank_account_id8" diff --git a/doc/models/v1-money.md b/doc/models/v1-money.md index d6736089..862382e8 100644 --- a/doc/models/v1-money.md +++ b/doc/models/v1-money.md @@ -17,7 +17,7 @@ ```json { "amount": 46, - "currency_code": "BTN" + "currency_code": "RWF" } ``` diff --git a/doc/models/v1-order.md b/doc/models/v1-order.md index 8d823bb6..24f2689d 100644 --- a/doc/models/v1-order.md +++ b/doc/models/v1-order.md @@ -43,20 +43,20 @@ V1Order { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/v1-payment-discount.md b/doc/models/v1-payment-discount.md index d1f5f133..0f575038 100644 --- a/doc/models/v1-payment-discount.md +++ b/doc/models/v1-payment-discount.md @@ -22,7 +22,7 @@ V1PaymentDiscount "name": "name0", "applied_money": { "amount": 196, - "currency_code": "LYD" + "currency_code": "IQD" }, "discount_id": "discount_id8" } diff --git a/doc/models/v1-payment-modifier.md b/doc/models/v1-payment-modifier.md index 654cb33b..251f7493 100644 --- a/doc/models/v1-payment-modifier.md +++ b/doc/models/v1-payment-modifier.md @@ -22,7 +22,7 @@ V1PaymentModifier "name": "name0", "applied_money": { "amount": 196, - "currency_code": "LYD" + "currency_code": "IQD" }, "modifier_option_id": "modifier_option_id6" } diff --git a/doc/models/v1-payment-surcharge.md b/doc/models/v1-payment-surcharge.md index ee24bdb7..74b7521c 100644 --- a/doc/models/v1-payment-surcharge.md +++ b/doc/models/v1-payment-surcharge.md @@ -27,12 +27,12 @@ V1PaymentSurcharge "name": "name0", "applied_money": { "amount": 196, - "currency_code": "LYD" + "currency_code": "IQD" }, "rate": "rate0", "amount_money": { "amount": 186, - "currency_code": "KRW" + "currency_code": "UZS" }, "type": "CUSTOM" } diff --git a/doc/models/v1-payment-tax.md b/doc/models/v1-payment-tax.md index 53181272..80bf4eea 100644 --- a/doc/models/v1-payment-tax.md +++ b/doc/models/v1-payment-tax.md @@ -24,20 +24,20 @@ V1PaymentTax { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } @@ -45,7 +45,7 @@ V1PaymentTax "name": "name0", "applied_money": { "amount": 196, - "currency_code": "LYD" + "currency_code": "IQD" }, "rate": "rate0", "inclusion_type": "ADDITIVE" diff --git a/doc/models/v1-refund.md b/doc/models/v1-refund.md index da0ec6f0..cccf7b86 100644 --- a/doc/models/v1-refund.md +++ b/doc/models/v1-refund.md @@ -38,15 +38,15 @@ V1Refund "reason": "reason4", "refunded_money": { "amount": 214, - "currency_code": "CHW" + "currency_code": "SRD" }, "refunded_processing_fee_money": { "amount": 0, - "currency_code": "LBP" + "currency_code": "BGN" }, "refunded_tax_money": { "amount": 148, - "currency_code": "BAM" + "currency_code": "SRD" } } ``` diff --git a/doc/models/v1-settlement-entry.md b/doc/models/v1-settlement-entry.md index 7d621835..7a9eff4b 100644 --- a/doc/models/v1-settlement-entry.md +++ b/doc/models/v1-settlement-entry.md @@ -24,11 +24,11 @@ V1SettlementEntry "type": "PAID_SERVICE_FEE", "amount_money": { "amount": 186, - "currency_code": "KRW" + "currency_code": "UZS" }, "fee_money": { "amount": 108, - "currency_code": "UZS" + "currency_code": "ILS" } } ``` diff --git a/doc/models/v1-settlement.md b/doc/models/v1-settlement.md index f3a85cdc..29f44e7b 100644 --- a/doc/models/v1-settlement.md +++ b/doc/models/v1-settlement.md @@ -26,7 +26,7 @@ V1Settlement "status": "FAILED", "total_money": { "amount": 250, - "currency_code": "USS" + "currency_code": "KZT" }, "initiated_at": "initiated_at2", "bank_account_id": "bank_account_id0" diff --git a/doc/models/void-transaction-response.md b/doc/models/void-transaction-response.md index ea89b1b2..04383ab3 100644 --- a/doc/models/void-transaction-response.md +++ b/doc/models/void-transaction-response.md @@ -20,20 +20,20 @@ a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) en { "errors": [ { - "category": "AUTHENTICATION_ERROR", - "code": "REFUND_ALREADY_PENDING", + "category": "REFUND_ERROR", + "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { - "category": "INVALID_REQUEST_ERROR", - "code": "PAYMENT_NOT_REFUNDABLE", + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { - "category": "RATE_LIMIT_ERROR", - "code": "REFUND_DECLINED", + "category": "EXTERNAL_VENDOR_ERROR", + "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } diff --git a/doc/models/wage-setting.md b/doc/models/wage-setting.md index 746c080f..1b2df46d 100644 --- a/doc/models/wage-setting.md +++ b/doc/models/wage-setting.md @@ -29,11 +29,11 @@ An object representing a team member's wage information. "pay_type": "NONE", "hourly_rate": { "amount": 79, - "currency": "QAR" + "currency": "GNF" }, "annual_rate": { "amount": 19, - "currency": "PKR" + "currency": "DKK" }, "weekly_hours": 187 }, @@ -42,11 +42,11 @@ An object representing a team member's wage information. "pay_type": "HOURLY", "hourly_rate": { "amount": 80, - "currency": "RON" + "currency": "GTQ" }, "annual_rate": { "amount": 20, - "currency": "PLN" + "currency": "DOP" }, "weekly_hours": 188 }, @@ -55,11 +55,11 @@ An object representing a team member's wage information. "pay_type": "SALARY", "hourly_rate": { "amount": 81, - "currency": "RSD" + "currency": "GYD" }, "annual_rate": { "amount": 21, - "currency": "PYG" + "currency": "DZD" }, "weekly_hours": 189 } diff --git a/jest.config.js b/jest.config.js index b96423d2..45a2c189 100644 --- a/jest.config.js +++ b/jest.config.js @@ -2,7 +2,6 @@ module.exports = { testEnvironment: 'node', preset: 'ts-jest', globals: { - __DEV__: true, 'ts-jest': { tsConfig: 'tsconfig.base.json', }, diff --git a/package.json b/package.json index a0df0825..60b9571d 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "28.0.1", + "version": "29.0.0", "license": "MIT", "sideEffects": false, "main": "dist/cjs/index.js", diff --git a/src/api/customersApi.ts b/src/api/customersApi.ts index bdb5a427..66bd43d2 100644 --- a/src/api/customersApi.ts +++ b/src/api/customersApi.ts @@ -55,7 +55,7 @@ import { UpdateCustomerResponse, updateCustomerResponseSchema, } from '../models/updateCustomerResponse'; -import { bigint, number, optional, string } from '../schema'; +import { bigint, boolean, number, optional, string } from '../schema'; import { BaseApi } from './baseApi'; export class CustomersApi extends BaseApi { @@ -66,18 +66,20 @@ export class CustomersApi extends BaseApi { * for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated * profiles can take closer to one minute or longer, especially during network incidents and outages. * - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this cursor - * to retrieve the next set of results for your original query. For more information, - * see [Pagination](https://developer.squareup.com/docs/build-basics/common-api- - * patterns/pagination). - * @param limit The maximum number of results to return in a single page. This limit is advisory. The - * response might contain more or fewer results. If the specified limit is less than 1 or - * greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. - * The default value is 100. For more information, see [Pagination](https://developer. - * squareup.com/docs/build-basics/common-api-patterns/pagination). + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this + * cursor to retrieve the next set of results for your original query. For more + * information, see [Pagination](https://developer.squareup.com/docs/build-basics/common- + * api-patterns/pagination). + * @param limit The maximum number of results to return in a single page. This limit is advisory. + * The response might contain more or fewer results. If the specified limit is less than + * 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` + * error. The default value is 100. For more information, see [Pagination](https: + * //developer.squareup.com/docs/build-basics/common-api-patterns/pagination). * @param sortField Indicates how customers should be sorted. The default value is `DEFAULT`. * @param sortOrder Indicates whether customers should be sorted in ascending (`ASC`) or descending - * (`DESC`) order. The default value is `ASC`. + * (`DESC`) order. The default value is `ASC`. + * @param count Indicates whether to return the total count of customers in the `count` field of the + * response. The default value is `false`. * @return Response from the API call */ async listCustomers( @@ -85,6 +87,7 @@ export class CustomersApi extends BaseApi { limit?: number, sortField?: string, sortOrder?: string, + count?: boolean, requestOptions?: RequestOptions ): Promise> { const req = this.createRequest('GET', '/v2/customers'); @@ -93,11 +96,13 @@ export class CustomersApi extends BaseApi { limit: [limit, optional(number())], sortField: [sortField, optional(string())], sortOrder: [sortOrder, optional(string())], + count: [count, optional(boolean())], }); req.query('cursor', mapped.cursor); req.query('limit', mapped.limit); req.query('sort_field', mapped.sortField); req.query('sort_order', mapped.sortOrder); + req.query('count', mapped.count); return req.callAsJson(listCustomersResponseSchema, requestOptions); } diff --git a/src/api/refundsApi.ts b/src/api/refundsApi.ts index 7e37f0d8..df1d7fb2 100644 --- a/src/api/refundsApi.ts +++ b/src/api/refundsApi.ts @@ -27,7 +27,7 @@ export class RefundsApi extends BaseApi { * * The maximum results per page is 100. * - * @param beginTime Indicates the start of the time range to retrieve each PaymentRefund` for, in RFC + * @param beginTime Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC * 3339 format. The range is determined using the `created_at` field for each * `PaymentRefund`. Default: The current time minus one year. * @param endTime Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC diff --git a/src/client.ts b/src/client.ts index 2cb4b777..a9e276bc 100644 --- a/src/client.ts +++ b/src/client.ts @@ -67,7 +67,7 @@ import { import { HttpClient } from './clientAdapter'; /** Current SDK version */ -export const SDK_VERSION = '28.0.1'; +export const SDK_VERSION = '29.0.0'; export class Client implements ClientInterface { private _config: Readonly; private _timeout: number; @@ -131,7 +131,7 @@ export class Client implements ClientInterface { ? this._config.httpClientOptions.timeout : this._config.timeout; this._userAgent = updateUserAgent( - 'Square-TypeScript-SDK/28.0.1 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}', + 'Square-TypeScript-SDK/29.0.0 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}', this._config.squareVersion, this._config.userAgentDetail ); diff --git a/src/defaultConfiguration.ts b/src/defaultConfiguration.ts index 177df5fa..80e1e801 100644 --- a/src/defaultConfiguration.ts +++ b/src/defaultConfiguration.ts @@ -4,7 +4,7 @@ import { RetryConfiguration } from './core'; /** Default values for the configuration parameters of the client. */ export const DEFAULT_CONFIGURATION: Configuration = { timeout: 60000, - squareVersion: '2023-06-08', + squareVersion: '2023-07-20', additionalHeaders: {}, userAgentDetail: '', environment: Environment.Production, diff --git a/src/errors/apiError.ts b/src/errors/apiError.ts index 071ae4ed..db6e6f87 100644 --- a/src/errors/apiError.ts +++ b/src/errors/apiError.ts @@ -48,7 +48,7 @@ export class ApiError extends Error } } } catch (error) { - if (__DEV__) { + if (process.env.NODE_ENV !== 'production') { if (console) { console.warn( `Unexpected error: Could not parse HTTP response body as JSON. ${error.message}` diff --git a/src/models/businessAppointmentSettings.ts b/src/models/businessAppointmentSettings.ts index a8080c77..e3cec856 100644 --- a/src/models/businessAppointmentSettings.ts +++ b/src/models/businessAppointmentSettings.ts @@ -20,9 +20,9 @@ export interface BusinessAppointmentSettings { locationTypes?: string[] | null; /** Time units of a service duration for bookings. */ alignmentTime?: string; - /** The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time. */ + /** The minimum lead time in seconds before a service can be booked. A booking must be created at least this amount of time before its starting time. */ minBookingLeadTimeSeconds?: number | null; - /** The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's starting time. */ + /** The maximum lead time in seconds before a service can be booked. A booking must be created at most this amount of time before its starting time. */ maxBookingLeadTimeSeconds?: number | null; /** * Indicates whether a customer can choose from all available time slots and have a staff member assigned diff --git a/src/models/createDeviceCodeRequest.ts b/src/models/createDeviceCodeRequest.ts index fd374d3d..9378a387 100644 --- a/src/models/createDeviceCodeRequest.ts +++ b/src/models/createDeviceCodeRequest.ts @@ -5,7 +5,7 @@ export interface CreateDeviceCodeRequest { /** * A unique string that identifies this CreateDeviceCode request. Keys can * be any valid string but must be unique for every CreateDeviceCode request. - * See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; deviceCode: DeviceCode; diff --git a/src/models/createSubscriptionRequest.ts b/src/models/createSubscriptionRequest.ts index 304955a2..283e1bbb 100644 --- a/src/models/createSubscriptionRequest.ts +++ b/src/models/createSubscriptionRequest.ts @@ -20,14 +20,6 @@ export interface CreateSubscriptionRequest { idempotencyKey?: string; /** The ID of the location the subscription is associated with. */ locationId: string; - /** - * The ID of the [subscription plan](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations) created using the Catalog API. - * Deprecated in favour of `plan_variation_id`. - * For more information, see - * [Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan) and - * [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough). - */ - planId?: string; /** The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. */ planVariationId?: string; /** The ID of the [customer](entity:Customer) subscribing to the subscription plan variation. */ @@ -85,7 +77,6 @@ export const createSubscriptionRequestSchema: Schema { idempotencyKey: ['idempotency_key', optional(string())], locationId: ['location_id', string()], - planId: ['plan_id', optional(string())], planVariationId: ['plan_variation_id', optional(string())], customerId: ['customer_id', string()], startDate: ['start_date', optional(string())], diff --git a/src/models/createTeamMemberRequest.ts b/src/models/createTeamMemberRequest.ts index 865cf1c6..30d508e4 100644 --- a/src/models/createTeamMemberRequest.ts +++ b/src/models/createTeamMemberRequest.ts @@ -6,7 +6,7 @@ export interface CreateTeamMemberRequest { /** * A unique string that identifies this `CreateTeamMember` request. * Keys can be any valid string, but must be unique for every request. - * For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency). + * For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). * The minimum length is 1 and the maximum length is 45. */ idempotencyKey?: string; diff --git a/src/models/createTerminalActionRequest.ts b/src/models/createTerminalActionRequest.ts index 9248afd8..f6cb36f9 100644 --- a/src/models/createTerminalActionRequest.ts +++ b/src/models/createTerminalActionRequest.ts @@ -5,7 +5,7 @@ export interface CreateTerminalActionRequest { /** * A unique string that identifies this `CreateAction` request. Keys can be any valid string * but must be unique for every `CreateAction` request. - * See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more * information. */ idempotencyKey: string; diff --git a/src/models/createTerminalCheckoutRequest.ts b/src/models/createTerminalCheckoutRequest.ts index 0695c991..ddbd475d 100644 --- a/src/models/createTerminalCheckoutRequest.ts +++ b/src/models/createTerminalCheckoutRequest.ts @@ -5,7 +5,7 @@ export interface CreateTerminalCheckoutRequest { /** * A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but * must be unique for every `CreateCheckout` request. - * See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; /** Represents a checkout processed by the Square Terminal. */ diff --git a/src/models/createTerminalRefundRequest.ts b/src/models/createTerminalRefundRequest.ts index 04543c59..de91024a 100644 --- a/src/models/createTerminalRefundRequest.ts +++ b/src/models/createTerminalRefundRequest.ts @@ -5,7 +5,7 @@ export interface CreateTerminalRefundRequest { /** * A unique string that identifies this `CreateRefund` request. Keys can be any valid string but * must be unique for every `CreateRefund` request. - * See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; /** Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. */ diff --git a/src/models/invoiceAcceptedPaymentMethods.ts b/src/models/invoiceAcceptedPaymentMethods.ts index 8c75901a..e5176d66 100644 --- a/src/models/invoiceAcceptedPaymentMethods.ts +++ b/src/models/invoiceAcceptedPaymentMethods.ts @@ -17,6 +17,11 @@ export interface InvoiceAcceptedPaymentMethods { * [Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later). */ buyNowPayLater?: boolean | null; + /** + * Indicates whether Cash App payments are accepted. The default value is `false`. + * This payment method is supported only for seller [locations](entity:Location) in the United States. + */ + cashAppPay?: boolean | null; } export const invoiceAcceptedPaymentMethodsSchema: Schema = object( @@ -25,5 +30,6 @@ export const invoiceAcceptedPaymentMethodsSchema: Schema = object({ @@ -28,4 +41,5 @@ export const listCustomersRequestSchema: Schema = object({ limit: ['limit', optional(nullable(number()))], sortField: ['sort_field', optional(string())], sortOrder: ['sort_order', optional(string())], + count: ['count', optional(nullable(boolean()))], }); diff --git a/src/models/listCustomersResponse.ts b/src/models/listCustomersResponse.ts index 9218f051..37472fde 100644 --- a/src/models/listCustomersResponse.ts +++ b/src/models/listCustomersResponse.ts @@ -1,4 +1,12 @@ -import { array, lazy, object, optional, Schema, string } from '../schema'; +import { + array, + bigint, + lazy, + object, + optional, + Schema, + string, +} from '../schema'; import { Customer, customerSchema } from './customer'; import { Error, errorSchema } from './error'; @@ -10,7 +18,11 @@ import { Error, errorSchema } from './error'; export interface ListCustomersResponse { /** Any errors that occurred during the request. */ errors?: Error[]; - /** The customer profiles associated with the Square account or an empty object (`{}`) if none are found. */ + /** + * The customer profiles associated with the Square account or an empty object (`{}`) if none are found. + * Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or + * `phone_number`) are included in the response. + */ customers?: Customer[]; /** * A pagination cursor to retrieve the next set of results for the @@ -19,6 +31,12 @@ export interface ListCustomersResponse { * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; + /** + * The total count of customers associated with the Square account. Only customer profiles with public information + * (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present + * only if `count` is set to `true` in the request. + */ + count?: bigint; } export const listCustomersResponseSchema: Schema = object( @@ -26,5 +44,6 @@ export const listCustomersResponseSchema: Schema = object errors: ['errors', optional(array(lazy(() => errorSchema)))], customers: ['customers', optional(array(lazy(() => customerSchema)))], cursor: ['cursor', optional(string())], + count: ['count', optional(bigint())], } ); diff --git a/src/models/listPaymentRefundsRequest.ts b/src/models/listPaymentRefundsRequest.ts index e60c87e7..6a8007c6 100644 --- a/src/models/listPaymentRefundsRequest.ts +++ b/src/models/listPaymentRefundsRequest.ts @@ -7,7 +7,7 @@ import { nullable, number, object, optional, Schema, string } from '../schema'; */ export interface ListPaymentRefundsRequest { /** - * Indicates the start of the time range to retrieve each PaymentRefund` for, in RFC 3339 + * Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 * format. The range is determined using the `created_at` field for each `PaymentRefund`. * Default: The current time minus one year. */ diff --git a/src/models/searchCustomersRequest.ts b/src/models/searchCustomersRequest.ts index 6ac2b587..dee8c207 100644 --- a/src/models/searchCustomersRequest.ts +++ b/src/models/searchCustomersRequest.ts @@ -1,4 +1,12 @@ -import { bigint, lazy, object, optional, Schema, string } from '../schema'; +import { + bigint, + boolean, + lazy, + object, + optional, + Schema, + string, +} from '../schema'; import { CustomerQuery, customerQuerySchema } from './customerQuery'; /** @@ -20,6 +28,11 @@ export interface SearchCustomersRequest { limit?: bigint; /** Represents filtering and sorting criteria for a [SearchCustomers]($e/Customers/SearchCustomers) request. */ query?: CustomerQuery; + /** + * Indicates whether to return the total count of matching customers in the `count` field of the response. + * The default value is `false`. + */ + count?: boolean; } export const searchCustomersRequestSchema: Schema = object( @@ -27,5 +40,6 @@ export const searchCustomersRequestSchema: Schema = obje cursor: ['cursor', optional(string())], limit: ['limit', optional(bigint())], query: ['query', optional(lazy(() => customerQuerySchema))], + count: ['count', optional(boolean())], } ); diff --git a/src/models/searchCustomersResponse.ts b/src/models/searchCustomersResponse.ts index 6cb4cf49..fa03ec57 100644 --- a/src/models/searchCustomersResponse.ts +++ b/src/models/searchCustomersResponse.ts @@ -1,4 +1,12 @@ -import { array, lazy, object, optional, Schema, string } from '../schema'; +import { + array, + bigint, + lazy, + object, + optional, + Schema, + string, +} from '../schema'; import { Customer, customerSchema } from './customer'; import { Error, errorSchema } from './error'; @@ -10,7 +18,11 @@ import { Error, errorSchema } from './error'; export interface SearchCustomersResponse { /** Any errors that occurred during the request. */ errors?: Error[]; - /** The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`). */ + /** + * The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`). + * Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) + * are included in the response. + */ customers?: Customer[]; /** * A pagination cursor that can be used during subsequent calls @@ -20,6 +32,12 @@ export interface SearchCustomersResponse { * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; + /** + * The total count of customers associated with the Square account that match the search query. Only customer profiles with + * public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is + * present only if `count` is set to `true` in the request. + */ + count?: bigint; } export const searchCustomersResponseSchema: Schema = object( @@ -27,5 +45,6 @@ export const searchCustomersResponseSchema: Schema = ob errors: ['errors', optional(array(lazy(() => errorSchema)))], customers: ['customers', optional(array(lazy(() => customerSchema)))], cursor: ['cursor', optional(string())], + count: ['count', optional(bigint())], } ); diff --git a/src/models/terminalAction.ts b/src/models/terminalAction.ts index 874585e6..c4d58c7f 100644 --- a/src/models/terminalAction.ts +++ b/src/models/terminalAction.ts @@ -51,6 +51,8 @@ export interface TerminalAction { updatedAt?: string; /** The ID of the application that created the action. */ appId?: string; + /** The location id the action is attached to, if a link can be made. */ + locationId?: string; /** Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. */ type?: string; /** Fields to describe the action that displays QR-Codes. */ @@ -88,6 +90,7 @@ export const terminalActionSchema: Schema = object({ createdAt: ['created_at', optional(string())], updatedAt: ['updated_at', optional(string())], appId: ['app_id', optional(string())], + locationId: ['location_id', optional(string())], type: ['type', optional(string())], qrCodeOptions: ['qr_code_options', optional(lazy(() => qrCodeOptionsSchema))], saveCardOptions: [ diff --git a/src/types.d.ts b/src/types.d.ts deleted file mode 100644 index b867229b..00000000 --- a/src/types.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare const __DEV__: boolean;