From 586b6855d8439ac4a03847f1a2c16eeec8e3f16f Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Mon, 1 Nov 2021 15:56:29 -0600 Subject: [PATCH 01/19] 5 syntax corrections --- api.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/api.json b/api.json index c1780dc..6d41e1c 100644 --- a/api.json +++ b/api.json @@ -16242,7 +16242,7 @@ "type": "object", "properties": { "square_product": { - "$ref": "#/definitions/ExternalSquareProduct", + "$ref": "#/definitions/ApplicationDetailsExternalSquareProduct", "description": "The Square product, such as Square Point of Sale (POS), \nSquare Invoices, or Square Virtual Terminal." }, "application_id": { @@ -26046,7 +26046,7 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/Type", + "$ref": "#/definitions/GiftCardType", "description": "Indicates the gift card type." }, "gan_source": { @@ -26055,7 +26055,7 @@ "x-read-only": true }, "state": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/GiftCardStatus", "description": "The current gift card state.", "x-read-only": true }, @@ -26100,7 +26100,7 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/Type", + "$ref": "#/definitions/GiftCardActivityType", "description": "The type of the gift card activity." }, "location_id": { @@ -26828,7 +26828,7 @@ "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2–12 installments \n- One deposit with 2–12 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Payment requests](https://developer.squareup.com/docs/invoices-api/overview#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)." }, "delivery_method": { - "$ref": "#/definitions/invoice_delivery_methodInvoiceDeliveryMethod", + "$ref": "#/definitions/InvoiceDeliveryMethod", "description": "The delivery method that Square uses to send the invoice, reminders, and receipts to\nthe customer. After the invoice is published, Square processes the invoice based on the delivery\nmethod and payment request settings, either immediately or on the `scheduled_at` date, if specified.\nFor example, Square might send the invoice or receipt for an automatic payment. For invoices with\nautomatic payments, this field must be set to `EMAIL`.\n\nOne of the following is required when creating an invoice:\n- (Recommended) This `delivery_method` field. To configure an automatic payment, the\n`automatic_payment_source` field of the payment request is also required.\n- The deprecated `request_method` field of the payment request. Note that `invoice`\nobjects returned in responses do not include `request_method`." }, "invoice_number": { From 84938fd97f5d8829a9c18bfe6a1c58de6f058b32 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Mon, 1 Nov 2021 15:56:29 -0600 Subject: [PATCH 02/19] 5 syntax corrections --- api.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/api.json b/api.json index 89894c7..74f6e71 100644 --- a/api.json +++ b/api.json @@ -16587,7 +16587,7 @@ "type": "object", "properties": { "square_product": { - "$ref": "#/definitions/ExternalSquareProduct", + "$ref": "#/definitions/ApplicationDetailsExternalSquareProduct", "description": "The Square product, such as Square Point of Sale (POS), \nSquare Invoices, or Square Virtual Terminal." }, "application_id": { @@ -26500,7 +26500,7 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/Type", + "$ref": "#/definitions/GiftCardType", "description": "Indicates the gift card type." }, "gan_source": { @@ -26509,7 +26509,7 @@ "x-read-only": true }, "state": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/GiftCardStatus", "description": "The current gift card state.", "x-read-only": true }, @@ -26554,7 +26554,7 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/Type", + "$ref": "#/definitions/GiftCardActivityType", "description": "The type of the gift card activity." }, "location_id": { @@ -27282,7 +27282,7 @@ "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2–12 installments \n- One deposit with 2–12 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Payment requests](https://developer.squareup.com/docs/invoices-api/overview#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)." }, "delivery_method": { - "$ref": "#/definitions/invoice_delivery_methodInvoiceDeliveryMethod", + "$ref": "#/definitions/InvoiceDeliveryMethod", "description": "The delivery method that Square uses to send the invoice, reminders, and receipts to\nthe customer. After the invoice is published, Square processes the invoice based on the delivery\nmethod and payment request settings, either immediately or on the `scheduled_at` date, if specified.\nFor example, Square might send the invoice or receipt for an automatic payment. For invoices with\nautomatic payments, this field must be set to `EMAIL`.\n\nOne of the following is required when creating an invoice:\n- (Recommended) This `delivery_method` field. To configure an automatic payment, the\n`automatic_payment_source` field of the payment request is also required.\n- The deprecated `request_method` field of the payment request. Note that `invoice`\nobjects returned in responses do not include `request_method`." }, "invoice_number": { From b078862c986ddfeb8a7aa05cad47f87072559c23 Mon Sep 17 00:00:00 2001 From: Richard Moot Date: Mon, 10 Jan 2022 11:52:37 -0800 Subject: [PATCH 03/19] Manually fix references that were broken --- api.json | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/api.json b/api.json index 89894c7..e81514d 100644 --- a/api.json +++ b/api.json @@ -16587,7 +16587,7 @@ "type": "object", "properties": { "square_product": { - "$ref": "#/definitions/ExternalSquareProduct", + "$ref": "#/definitions/ApplicationDetailsExternalSquareProduct", "description": "The Square product, such as Square Point of Sale (POS), \nSquare Invoices, or Square Virtual Terminal." }, "application_id": { @@ -26500,16 +26500,16 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/Type", + "$ref": "#/definitions/GiftCardType", "description": "Indicates the gift card type." }, "gan_source": { - "$ref": "#/definitions/GANSource", + "$ref": "#/definitions/GiftCardGANSource", "description": "Indicates whether the gift card account number (GAN) is generated by Square or \nimported from a non-Square system. For more information, see \n[Third-party gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#third-party-gift-cards).", "x-read-only": true }, "state": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/GiftCardStatus", "description": "The current gift card state.", "x-read-only": true }, @@ -26554,7 +26554,7 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/Type", + "$ref": "#/definitions/GiftCardActivityType", "description": "The type of the gift card activity." }, "location_id": { @@ -26683,7 +26683,7 @@ "description": "The amount of money to add or remove, depending on the activity `type`. This value is \nalways positive." }, "reason": { - "$ref": "#/definitions/Reason", + "$ref": "#/definitions/GiftCardActivityAdjustDecrementReason", "description": "The reason to decrease the gift card balance." } }, @@ -26703,7 +26703,7 @@ "description": "The amount of money to add or remove, depending on the activity `type`. This value is \nalways positive." }, "reason": { - "$ref": "#/definitions/Reason", + "$ref": "#/definitions/GiftCardActivityAdjustIncrementReason", "description": "The reason to increase the balance." } }, @@ -26718,7 +26718,7 @@ ], "properties": { "reason": { - "$ref": "#/definitions/Reason", + "$ref": "#/definitions/GiftCardActivityBlockReason", "description": "The reason to block the gift card." } }, @@ -26733,7 +26733,7 @@ ], "properties": { "reason": { - "$ref": "#/definitions/Reason", + "$ref": "#/definitions/GiftCardActivityClearBalanceReason", "description": "The reason to decrease the gift card balance." } }, @@ -26748,7 +26748,7 @@ ], "properties": { "reason": { - "$ref": "#/definitions/Reason", + "$ref": "#/definitions/GiftCardActivityDeactivateReason", "description": "The reason to decrease the balance." } }, @@ -26876,7 +26876,7 @@ ], "properties": { "reason": { - "$ref": "#/definitions/Reason", + "$ref": "#/definitions/GiftCardActivityUnblockReason", "description": "The reason to unblock a gift card." } }, @@ -27282,7 +27282,7 @@ "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2–12 installments \n- One deposit with 2–12 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Payment requests](https://developer.squareup.com/docs/invoices-api/overview#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)." }, "delivery_method": { - "$ref": "#/definitions/invoice_delivery_methodInvoiceDeliveryMethod", + "$ref": "#/definitions/InvoiceDeliveryMethod", "description": "The delivery method that Square uses to send the invoice, reminders, and receipts to\nthe customer. After the invoice is published, Square processes the invoice based on the delivery\nmethod and payment request settings, either immediately or on the `scheduled_at` date, if specified.\nFor example, Square might send the invoice or receipt for an automatic payment. For invoices with\nautomatic payments, this field must be set to `EMAIL`.\n\nOne of the following is required when creating an invoice:\n- (Recommended) This `delivery_method` field. To configure an automatic payment, the\n`automatic_payment_source` field of the payment request is also required.\n- The deprecated `request_method` field of the payment request. Note that `invoice`\nobjects returned in responses do not include `request_method`." }, "invoice_number": { @@ -39294,7 +39294,7 @@ "description": "The ID of the subscription plan associated with the subscription." }, "info": { - "$ref": "#/definitions/Info", + "$ref": "#/definitions/SubscriptionEventInfo", "description": "Additional information about the subscription event." } }, @@ -39309,7 +39309,7 @@ "description": "A human-readable explanation for the event." }, "code": { - "$ref": "#/definitions/InfoCode", + "$ref": "#/definitions/SubscriptionEventInfoCode", "description": "An info code indicating the subscription event that occurred." } }, From 577730f4842ce4383222f852da4a4233aea04194 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Tue, 19 Apr 2022 22:50:36 -0600 Subject: [PATCH 04/19] Fixed a few broken types --- api.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/api.json b/api.json index e732fa0..57405c7 100644 --- a/api.json +++ b/api.json @@ -36148,7 +36148,7 @@ "description": "The timestamp of when the payout entry affected the balance, in RFC 3339 format." }, "type": { - "$ref": "#/definitions/squareuppaymentbalancesActivityType", + "$ref": "#/definitions/ActivityType", "description": "The type of activity associated with this payout entry." }, "gross_amount_money": { @@ -41270,11 +41270,11 @@ "type": "object", "properties": { "filter": { - "$ref": "#/definitions/Filter", + "$ref": "#/definitions/SearchVendorsRequestFilter", "description": "Specifies a filter used to search for vendors." }, "sort": { - "$ref": "#/definitions/Sort", + "$ref": "#/definitions/SearchVendorsRequestSort", "description": "Specifies a sorter used to sort the returned vendors." }, "cursor": { @@ -41332,7 +41332,7 @@ "type": "object", "properties": { "field": { - "$ref": "#/definitions/Field", + "$ref": "#/definitions/SearchVendorsRequestSortField", "description": "Specifies the sort key to sort the returned vendors." }, "order": { @@ -45468,7 +45468,7 @@ "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2022-04-20/objects/Vendor)." }, "status": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/VendorStatus", "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2022-04-20/objects/Vendor)." } }, From ad5a8498ab3dbc634ea346ce87aa03a4dba3a4c5 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Sat, 14 May 2022 13:46:04 -0600 Subject: [PATCH 05/19] removed a bunch of "online_checkoutresource" --- api.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api.json b/api.json index 5ed901a..37486bb 100644 --- a/api.json +++ b/api.json @@ -26308,11 +26308,11 @@ "description": "Describes the `Order` for which to create a checkout link. \nFor more information, \nsee [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout)." }, "checkout_options": { - "$ref": "#/definitions/online_checkoutresourceCheckoutOptions", + "$ref": "#/definitions/CheckoutOptions", "description": "Describes optional fields to add to the resulting checkout page.\nFor more information, \nsee [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations)." }, "pre_populated_data": { - "$ref": "#/definitions/online_checkoutresourcePrePopulatedData", + "$ref": "#/definitions/PrePopulatedData", "description": "Describes fields to prepopulate in the resulting checkout page. \nFor more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address)." }, "source": { @@ -26352,7 +26352,7 @@ "description": "Any errors that occurred during the request." }, "payment_link": { - "$ref": "#/definitions/online_checkoutresourcePaymentLink", + "$ref": "#/definitions/PaymentLink", "description": "The created payment link." } }, @@ -33005,7 +33005,7 @@ "payment_links": { "type": "array", "items": { - "$ref": "#/definitions/online_checkoutresourcePaymentLink" + "$ref": "#/definitions/PaymentLink" }, "description": "The list of payment links." }, @@ -40555,7 +40555,7 @@ "description": "Any errors that occurred during the request." }, "payment_link": { - "$ref": "#/definitions/online_checkoutresourcePaymentLink", + "$ref": "#/definitions/PaymentLink", "description": "The payment link that is retrieved." } }, @@ -46124,7 +46124,7 @@ ], "properties": { "payment_link": { - "$ref": "#/definitions/online_checkoutresourcePaymentLink", + "$ref": "#/definitions/PaymentLink", "description": "The `payment_link` object describing the updates to apply. \nFor more information, see [Update a payment link](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link)." } }, @@ -46152,7 +46152,7 @@ "description": "Any errors that occurred when updating the payment link." }, "payment_link": { - "$ref": "#/definitions/online_checkoutresourcePaymentLink", + "$ref": "#/definitions/PaymentLink", "description": "The updated payment link." } }, From 70db1ee78e94da7cdadf2f29281bff80ed240ef4 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Sat, 14 May 2022 14:46:43 -0600 Subject: [PATCH 06/19] fixed left out "TerminalAction" prefix --- api.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api.json b/api.json index 37486bb..83266ca 100644 --- a/api.json +++ b/api.json @@ -44684,7 +44684,7 @@ "x-read-only": true }, "type": { - "$ref": "#/definitions/ActionType", + "$ref": "#/definitions/TerminalActionActionType", "description": "Represents the type of the action." }, "save_card_options": { From 319c648b87de3d04b994552f74e03902455b783b Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Sat, 14 May 2022 14:47:05 -0600 Subject: [PATCH 07/19] inserted left out "CustomAttributeDefinition" prefix --- api.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api.json b/api.json index 83266ca..2e13144 100644 --- a/api.json +++ b/api.json @@ -27367,7 +27367,7 @@ "x-read-only": true }, "visibility": { - "$ref": "#/definitions/Visibility", + "$ref": "#/definitions/CustomAttributeDefinitionVisibility", "description": "Specifies how the custom attribute definition and its values should be shared with\nthe seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`." }, "version": { From a35844f95b26963d0401b03d9068f402ee146aee Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Sat, 14 May 2022 14:47:33 -0600 Subject: [PATCH 08/19] put in bogus values for missing customer custom attribute types --- api.json | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/api.json b/api.json index 2e13144..724f35f 100644 --- a/api.json +++ b/api.json @@ -13865,6 +13865,44 @@ "description": "Indicates the method used to create the customer profile.", "x-release-status": "PUBLIC" }, + "CustomerCustomAttributeUpsertRequest": { + "type": "string", + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "x-enum-elements": [ + { + "name": "INCLUDE", + "description": "Customers should be included in the result set when they match the\nfiltering criteria." + }, + { + "name": "EXCLUDE", + "description": "Customers should be excluded from the result set when they match\nthe filtering criteria." + } + ], + "description": "Indicates whether customers should be included in, or excluded from,\nthe result set when they match the filtering criteria.", + "x-release-status": "PUBLIC" + }, + "CustomerCustomAttributeUpsertResponse": { + "type": "string", + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "x-enum-elements": [ + { + "name": "INCLUDE", + "description": "Customers should be included in the result set when they match the\nfiltering criteria." + }, + { + "name": "EXCLUDE", + "description": "Customers should be excluded from the result set when they match\nthe filtering criteria." + } + ], + "description": "Indicates whether customers should be included in, or excluded from,\nthe result set when they match the filtering criteria.", + "x-release-status": "PUBLIC" + }, "CustomerInclusionExclusion": { "type": "string", "enum": [ From 7b097ad83a5c0b0f190ca934fbeccb621072f097 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Tue, 23 Aug 2022 15:59:03 -0600 Subject: [PATCH 09/19] fixed syntax error: GiftCardActivityRedeemStatus instead of Status --- api.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api.json b/api.json index b243814..0f0149f 100644 --- a/api.json +++ b/api.json @@ -31220,7 +31220,7 @@ "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom payment processing system can use this field to track information\nrelated to an order or payment." }, "status": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/GiftCardActivityRedeemStatus", "description": "The status of the gift card redemption. Gift cards redeemed from Square Point of Sale or the \nSquare Seller Dashboard use a two-state process: `PENDING` \nto `COMPLETED` or `PENDING` to `CANCELED`. Gift cards redeemed using the Gift Card Activities API \nalways have a `COMPLETED` status.", "x-read-only": true } From 9e8f920263f6a582cd02f92cb6a003c710ae2476 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Fri, 2 Dec 2022 16:19:13 -0700 Subject: [PATCH 10/19] changed all dates to better merge new API --- api.json | 1680 +++++++++++++++++++++++++++--------------------------- 1 file changed, 840 insertions(+), 840 deletions(-) diff --git a/api.json b/api.json index 82c1be6..d496a91 100644 --- a/api.json +++ b/api.json @@ -105,7 +105,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE_IN_PERSON" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -144,7 +144,7 @@ "description": "`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see\n[Migrate from Renew to Refresh OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).\n\nRenews an OAuth access token before it expires.\n\nOAuth access tokens besides your application\u0027s personal access token expire after 30 days.\nYou can also renew expired tokens within 15 days of their expiration.\nYou cannot renew an access token that has been expired for more than 15 days.\nInstead, the associated user must recomplete the OAuth flow from the beginning.\n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the Credentials\npage in the [Developer Dashboard](https://developer.squareup.com/apps).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2ClientSecret": [] @@ -188,7 +188,7 @@ "operationId": "RevokeToken", "description": "Revokes an access token generated with the OAuth flow.\n\nIf an account has more than one OAuth access token for your application, this\nendpoint revokes all of them, regardless of which token you specify. When an\nOAuth access token is revoked, all of the active subscriptions associated\nwith that OAuth token are canceled immediately.\n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the OAuth\npage for your application on the Developer Dashboard.", "x-release-status": "PUBLIC", - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2ClientSecret": [] @@ -224,7 +224,7 @@ "operationId": "ObtainToken", "description": "Returns an OAuth access token and a refresh token unless the \n`short_lived` parameter is set to `true`, in which case the endpoint \nreturns only an access token.\n\nThe `grant_type` parameter specifies the type of OAuth request. If \n`grant_type` is `authorization_code`, you must include the authorization \ncode you received when a seller granted you authorization. If `grant_type` \nis `refresh_token`, you must provide a valid refresh token. If you are using \nan old version of the Square APIs (prior to March 13, 2019), `grant_type` \ncan be `migration_token` and you must provide a valid migration token.\n\nYou can use the `scopes` parameter to limit the set of permissions granted \nto the access token and refresh token. You can use the `short_lived` parameter \nto create an access token that expires in 24 hours.\n\n__Note:__ OAuth tokens should be encrypted and stored on a secure server. \nApplication clients should never interact directly with OAuth tokens.", "x-release-status": "PUBLIC", - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [], "parameters": [ { @@ -261,7 +261,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -330,7 +330,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -378,7 +378,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -436,7 +436,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -528,7 +528,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -577,7 +577,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -659,7 +659,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -709,7 +709,7 @@ "x-oauthpermissions": [ "SETTLEMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -801,7 +801,7 @@ "x-oauthpermissions": [ "SETTLEMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -847,7 +847,7 @@ "description": "Activates a domain for use with Apple Pay on the Web and Square. A validation\nis performed on this domain by Apple to ensure that it is properly set up as\nan Apple Pay enabled domain.\n\nThis endpoint provides an easy way for platform developers to bulk activate\nApple Pay on the Web with Square for merchants using their platform.\n\nNote: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022.\nYou must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see [Migrate to the Web Payments SDK](https://developer.squareup.com/docs/web-payments/migrate).\n\nTo learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -881,12 +881,12 @@ ], "summary": "ListBankAccounts", "operationId": "ListBankAccounts", - "description": "Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2022-10-19/objects/BankAccount) objects linked to a Square account.", + "description": "Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2022-11-16/objects/BankAccount) objects linked to a Square account.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -934,12 +934,12 @@ ], "summary": "GetBankAccountByV1Id", "operationId": "GetBankAccountByV1Id", - "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2022-10-19/objects/BankAccount) identified by V1 bank account ID.", + "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2022-11-16/objects/BankAccount) identified by V1 bank account ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -973,12 +973,12 @@ ], "summary": "GetBankAccount", "operationId": "GetBankAccount", - "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2022-10-19/objects/BankAccount)\nlinked to a Square account.", + "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2022-11-16/objects/BankAccount)\nlinked to a Square account.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1017,7 +1017,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1089,7 +1089,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1130,7 +1130,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1171,7 +1171,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1202,7 +1202,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1262,7 +1262,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1301,7 +1301,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1312,7 +1312,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2022-10-19/objects/Booking) object representing the to-be-retrieved booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2022-11-16/objects/Booking) object representing the to-be-retrieved booking.", "type": "string", "in": "path", "required": true @@ -1338,7 +1338,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1349,7 +1349,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2022-10-19/objects/Booking) object representing the to-be-updated booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2022-11-16/objects/Booking) object representing the to-be-updated booking.", "type": "string", "in": "path", "required": true @@ -1386,7 +1386,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1397,7 +1397,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2022-10-19/objects/Booking) object representing the to-be-cancelled booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2022-11-16/objects/Booking) object representing the to-be-cancelled booking.", "type": "string", "in": "path", "required": true @@ -1434,7 +1434,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1499,7 +1499,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1540,7 +1540,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1579,7 +1579,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1618,7 +1618,7 @@ "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1687,12 +1687,12 @@ ], "summary": "RetrieveCashDrawerShift", "operationId": "RetrieveCashDrawerShift", - "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2022-10-19/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.", + "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2022-11-16/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1738,7 +1738,7 @@ "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1793,12 +1793,12 @@ ], "summary": "BatchDeleteCatalogObjects", "operationId": "BatchDeleteCatalogObjects", - "description": "Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.", + "description": "Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1834,12 +1834,12 @@ ], "summary": "BatchRetrieveCatalogObjects", "operationId": "BatchRetrieveCatalogObjects", - "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) objects, references to\nits [CatalogModifierList](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTax) objects that apply to it.", + "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) objects, references to\nits [CatalogModifierList](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTax) objects that apply to it.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1880,7 +1880,7 @@ "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1921,7 +1921,7 @@ "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1947,12 +1947,12 @@ ], "summary": "ListCatalog", "operationId": "ListCatalog", - "description": "Returns a list of all [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s of the specified types in the catalog. \n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) values, \nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-objects)\nand set the `include_deleted_objects` attribute value to `true`.", + "description": "Returns a list of all [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s of the specified types in the catalog. \n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) values, \nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-objects)\nand set the `include_deleted_objects` attribute value to `true`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -1970,14 +1970,14 @@ }, { "name": "types", - "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", "type": "string", "in": "query", "required": false }, { "name": "catalog_version", - "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical\nversions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical\nversions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", "x-is-beta": true, "type": "integer", "format": "int64", @@ -2002,12 +2002,12 @@ ], "summary": "UpsertCatalogObject", "operationId": "UpsertCatalogObject", - "description": "Creates or updates the target [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject).", + "description": "Creates or updates the target [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2043,12 +2043,12 @@ ], "summary": "DeleteCatalogObject", "operationId": "DeleteCatalogObject", - "description": "Deletes a single [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) children.", + "description": "Deletes a single [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) children.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2080,12 +2080,12 @@ ], "summary": "RetrieveCatalogObject", "operationId": "RetrieveCatalogObject", - "description": "Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) as a\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem)\ninformation including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTax) objects that apply to it.", + "description": "Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) as a\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem)\ninformation including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTax) objects that apply to it.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2110,7 +2110,7 @@ }, { "name": "catalog_version", - "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "x-is-beta": true, "type": "integer", "format": "int64", @@ -2135,12 +2135,12 @@ ], "summary": "SearchCatalogObjects", "operationId": "SearchCatalogObjects", - "description": "Searches for [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-items)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", + "description": "Searches for [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-items)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2176,12 +2176,12 @@ ], "summary": "SearchCatalogItems", "operationId": "SearchCatalogItems", - "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-objects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", + "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-objects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2217,12 +2217,12 @@ ], "summary": "UpdateItemModifierLists", "operationId": "UpdateItemModifierLists", - "description": "Updates the [CatalogModifierList](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) without having\nto perform an upsert on the entire item.", + "description": "Updates the [CatalogModifierList](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) without having\nto perform an upsert on the entire item.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2258,12 +2258,12 @@ ], "summary": "UpdateItemTaxes", "operationId": "UpdateItemTaxes", - "description": "Updates the [CatalogTax](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTax) objects that apply to the\ntargeted [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) without having to perform an\nupsert on the entire item.", + "description": "Updates the [CatalogTax](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTax) objects that apply to the\ntargeted [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) without having to perform an\nupsert on the entire item.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2304,7 +2304,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2362,7 +2362,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2398,12 +2398,12 @@ ], "summary": "ListCustomerCustomAttributeDefinitions", "operationId": "ListCustomerCustomAttributeDefinitions", - "description": "Lists the customer-related [custom attribute definitions](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the customer-related [custom attribute definitions](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2442,12 +2442,12 @@ ], "summary": "CreateCustomerCustomAttributeDefinition", "operationId": "CreateCustomerCustomAttributeDefinition", - "description": "Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/upsert-customer-custom-attribute) or\n[BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nto set the custom attribute for customer profiles in the seller\u0027s Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", + "description": "Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/upsert-customer-custom-attribute) or\n[BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nto set the custom attribute for customer profiles in the seller\u0027s Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2483,12 +2483,12 @@ ], "summary": "DeleteCustomerCustomAttributeDefinition", "operationId": "DeleteCustomerCustomAttributeDefinition", - "description": "Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller\u0027s Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller\u0027s Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2520,12 +2520,12 @@ ], "summary": "RetrieveCustomerCustomAttributeDefinition", "operationId": "RetrieveCustomerCustomAttributeDefinition", - "description": "Retrieves a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2564,12 +2564,12 @@ ], "summary": "UpdateCustomerCustomAttributeDefinition", "operationId": "UpdateCustomerCustomAttributeDefinition", - "description": "Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", + "description": "Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2612,12 +2612,12 @@ ], "summary": "BulkUpsertCustomerCustomAttributes", "operationId": "BulkUpsertCustomerCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert \nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID \nand provides a customer ID and custom attribute. Each upsert response is returned with the ID \nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert \nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID \nand provides a customer ID and custom attribute. Each upsert response is returned with the ID \nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2658,7 +2658,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2702,7 +2702,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2743,7 +2743,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2780,7 +2780,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2817,7 +2817,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2865,7 +2865,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2906,7 +2906,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2952,7 +2952,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -2991,7 +2991,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3036,7 +3036,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3068,12 +3068,12 @@ ], "summary": "UpdateCustomer", "operationId": "UpdateCustomer", - "description": "Updates a customer profile. To change an attribute, specify the new value. To remove an attribute, specify the value as an empty string or empty object.\n\nAs a best practice, you should include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control. The value must be set to the current version of the customer profile.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2022-10-19/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2022-10-19/gift-cards-api).", + "description": "Updates a customer profile. To change an attribute, specify the new value. To remove an attribute, specify the value as an empty string or empty object.\n\nAs a best practice, you should include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control. The value must be set to the current version of the customer profile.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2022-11-16/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2022-11-16/gift-cards-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3122,7 +3122,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3172,7 +3172,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3215,12 +3215,12 @@ ], "summary": "ListCustomerCustomAttributes", "operationId": "ListCustomerCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3231,7 +3231,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3252,7 +3252,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -3275,12 +3275,12 @@ ], "summary": "DeleteCustomerCustomAttribute", "operationId": "DeleteCustomerCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3291,7 +3291,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3319,12 +3319,12 @@ ], "summary": "RetrieveCustomerCustomAttribute", "operationId": "RetrieveCustomerCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3335,7 +3335,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3349,7 +3349,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -3377,12 +3377,12 @@ ], "summary": "UpsertCustomerCustomAttribute", "operationId": "UpsertCustomerCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3393,7 +3393,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3437,7 +3437,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3481,7 +3481,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3527,7 +3527,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3585,7 +3585,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3626,7 +3626,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3665,7 +3665,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3718,7 +3718,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3757,7 +3757,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3796,7 +3796,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3842,7 +3842,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3890,7 +3890,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3934,7 +3934,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -3975,12 +3975,12 @@ ], "summary": "SubmitEvidence", "operationId": "SubmitEvidence", - "description": "Submits evidence to the cardholder\u0027s bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2022-10-19/disputes-api/create-dispute-evidence-file) and\n[CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2022-10-19/disputes-api/create-dispute-evidence-text) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", + "description": "Submits evidence to the cardholder\u0027s bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2022-11-16/disputes-api/create-dispute-evidence-file) and\n[CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2022-11-16/disputes-api/create-dispute-evidence-text) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4020,7 +4020,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4085,7 +4085,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4125,7 +4125,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4136,14 +4136,14 @@ "parameters": [ { "name": "type", - "description": "If a [type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", + "description": "If a [type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", "type": "string", "in": "query", "required": false }, { "name": "state", - "description": "If a [state](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", + "description": "If a [state](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", "type": "string", "in": "query", "required": false @@ -4185,12 +4185,12 @@ ], "summary": "CreateGiftCard", "operationId": "CreateGiftCard", - "description": "Creates a digital gift card or registers a physical (plastic) gift card. After the gift card \nis created, you must call [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) \nto activate the card with an initial balance before it can be used for payment.", + "description": "Creates a digital gift card or registers a physical (plastic) gift card. After the gift card \nis created, you must call [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) \nto activate the card with an initial balance before it can be used for payment.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4231,7 +4231,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4249,7 +4249,7 @@ }, { "name": "type", - "description": "If a [type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", + "description": "If a [type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", "type": "string", "in": "query", "required": false @@ -4312,12 +4312,12 @@ ], "summary": "CreateGiftCardActivity", "operationId": "CreateGiftCardActivity", - "description": "Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard). \nFor example, you create an `ACTIVATE` activity to activate a gift card with an initial balance \nbefore the gift card can be used.", + "description": "Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard). \nFor example, you create an `ACTIVATE` activity to activate a gift card with an initial balance \nbefore the gift card can be used.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4358,7 +4358,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4399,7 +4399,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4440,7 +4440,7 @@ "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4488,7 +4488,7 @@ "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4536,7 +4536,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4570,13 +4570,13 @@ ], "summary": "DeprecatedRetrieveInventoryAdjustment", "operationId": "DeprecatedRetrieveInventoryAdjustment", - "description": "Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/retrieve-inventory-adjustment) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/retrieve-inventory-adjustment) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4587,7 +4587,7 @@ "parameters": [ { "name": "adjustment_id", - "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryAdjustment) to retrieve.", + "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryAdjustment) to retrieve.", "type": "string", "in": "path", "required": true @@ -4610,12 +4610,12 @@ ], "summary": "RetrieveInventoryAdjustment", "operationId": "RetrieveInventoryAdjustment", - "description": "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`.", + "description": "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4626,7 +4626,7 @@ "parameters": [ { "name": "adjustment_id", - "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryAdjustment) to retrieve.", + "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryAdjustment) to retrieve.", "type": "string", "in": "path", "required": true @@ -4649,13 +4649,13 @@ ], "summary": "DeprecatedBatchChangeInventory", "operationId": "DeprecatedBatchChangeInventory", - "description": "Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-change-inventory) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-change-inventory) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4691,13 +4691,13 @@ ], "summary": "DeprecatedBatchRetrieveInventoryChanges", "operationId": "DeprecatedBatchRetrieveInventoryChanges", - "description": "Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4733,13 +4733,13 @@ ], "summary": "DeprecatedBatchRetrieveInventoryCounts", "operationId": "DeprecatedBatchRetrieveInventoryCounts", - "description": "Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4780,7 +4780,7 @@ "x-oauthpermissions": [ "INVENTORY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4821,7 +4821,7 @@ "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4857,12 +4857,12 @@ ], "summary": "BatchRetrieveInventoryCounts", "operationId": "BatchRetrieveInventoryCounts", - "description": "Returns current counts for the provided\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s at the requested\n[Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", + "description": "Returns current counts for the provided\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s at the requested\n[Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4898,13 +4898,13 @@ ], "summary": "DeprecatedRetrieveInventoryPhysicalCount", "operationId": "DeprecatedRetrieveInventoryPhysicalCount", - "description": "Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/retrieve-inventory-physical-count) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/retrieve-inventory-physical-count) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4915,7 +4915,7 @@ "parameters": [ { "name": "physical_count_id", - "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryPhysicalCount) to retrieve.", + "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryPhysicalCount) to retrieve.", "type": "string", "in": "path", "required": true @@ -4938,12 +4938,12 @@ ], "summary": "RetrieveInventoryPhysicalCount", "operationId": "RetrieveInventoryPhysicalCount", - "description": "Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", + "description": "Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4954,7 +4954,7 @@ "parameters": [ { "name": "physical_count_id", - "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryPhysicalCount) to retrieve.", + "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryPhysicalCount) to retrieve.", "type": "string", "in": "path", "required": true @@ -4977,13 +4977,13 @@ ], "summary": "RetrieveInventoryTransfer", "operationId": "RetrieveInventoryTransfer", - "description": "Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryTransfer) object\nwith the provided `transfer_id`.", + "description": "Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryTransfer) object\nwith the provided `transfer_id`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -4994,7 +4994,7 @@ "parameters": [ { "name": "transfer_id", - "description": "ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryTransfer) to retrieve.", + "description": "ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryTransfer) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -5018,12 +5018,12 @@ ], "summary": "RetrieveInventoryCount", "operationId": "RetrieveInventoryCount", - "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) at a given set of\n[Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", + "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) at a given set of\n[Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5034,14 +5034,14 @@ "parameters": [ { "name": "catalog_object_id", - "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) to retrieve.", + "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "location_ids", - "description": "The [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "description": "The [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", "type": "string", "in": "query", "required": false @@ -5071,13 +5071,13 @@ ], "summary": "RetrieveInventoryChanges", "operationId": "RetrieveInventoryChanges", - "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) at the requested\n[Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-retrieve-inventory-changes)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", + "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) at the requested\n[Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-retrieve-inventory-changes)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5088,14 +5088,14 @@ "parameters": [ { "name": "catalog_object_id", - "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) to retrieve.", + "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "location_ids", - "description": "The [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "description": "The [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", "type": "string", "in": "query", "required": false @@ -5130,7 +5130,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5176,13 +5176,13 @@ ], "summary": "CreateInvoice", "operationId": "CreateInvoice", - "description": "Creates a draft [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer\u0027s email address or charge the customer’s card on file).", + "description": "Creates a draft [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer\u0027s email address or charge the customer’s card on file).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5224,7 +5224,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5266,7 +5266,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5285,7 +5285,7 @@ }, { "name": "version", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2022-10-19/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2022-10-19/invoices-api/list-invoices).", + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2022-11-16/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2022-11-16/invoices-api/list-invoices).", "type": "integer", "in": "query", "required": false @@ -5311,7 +5311,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5349,7 +5349,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5399,7 +5399,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5411,7 +5411,7 @@ "parameters": [ { "name": "invoice_id", - "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) to cancel.", + "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) to cancel.", "type": "string", "in": "path", "required": true @@ -5449,7 +5449,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5498,7 +5498,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5549,7 +5549,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5590,7 +5590,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5627,7 +5627,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5665,7 +5665,7 @@ "TIMECARDS_SETTINGS_WRITE", "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5715,7 +5715,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5772,7 +5772,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5812,7 +5812,7 @@ "x-oauthpermissions": [ "TIMECARDS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5853,7 +5853,7 @@ "x-oauthpermissions": [ "TIMECARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5894,7 +5894,7 @@ "x-oauthpermissions": [ "TIMECARDS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5931,7 +5931,7 @@ "x-oauthpermissions": [ "TIMECARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -5969,7 +5969,7 @@ "TIMECARDS_WRITE", "TIMECARDS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6018,7 +6018,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6071,7 +6071,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6110,7 +6110,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6157,7 +6157,7 @@ "TIMECARDS_SETTINGS_WRITE", "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6206,7 +6206,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6235,7 +6235,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6276,7 +6276,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6313,7 +6313,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6356,14 +6356,14 @@ ], "summary": "CreateCheckout", "operationId": "CreateCheckout", - "description": "Links a `checkoutId` to a `checkout_page_url` that customers are\ndirected to in order to provide their payment information using a\npayment processing workflow hosted on connect.squareup.com. \n\n\nNOTE: The Checkout API has been updated with new features. \nFor more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).\nWe recommend that you use the new [CreatePaymentLink](https://developer.squareup.com/reference/square_2022-10-19/checkout-api/create-payment-link) \nendpoint in place of this previously released endpoint.", + "description": "Links a `checkoutId` to a `checkout_page_url` that customers are\ndirected to in order to provide their payment information using a\npayment processing workflow hosted on connect.squareup.com. \n\n\nNOTE: The Checkout API has been updated with new features. \nFor more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).\nWe recommend that you use the new [CreatePaymentLink](https://developer.squareup.com/reference/square_2022-11-16/checkout-api/create-payment-link) \nendpoint in place of this previously released endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE", "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6413,7 +6413,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6486,7 +6486,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6529,13 +6529,13 @@ ], "summary": "CaptureTransaction", "operationId": "CaptureTransaction", - "description": "Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "description": "Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6578,13 +6578,13 @@ ], "summary": "VoidTransaction", "operationId": "VoidTransaction", - "description": "Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "description": "Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6632,7 +6632,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6673,7 +6673,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6714,7 +6714,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6725,7 +6725,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount) to retrieve.", + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount) to retrieve.", "type": "string", "in": "path", "required": true @@ -6748,12 +6748,12 @@ ], "summary": "AccumulateLoyaltyPoints", "operationId": "AccumulateLoyaltyPoints", - "description": "Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/calculate-loyalty-points)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "description": "Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/calculate-loyalty-points)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6764,7 +6764,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount).", + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount).", "type": "string", "in": "path", "required": true @@ -6796,12 +6796,12 @@ ], "summary": "AdjustLoyaltyPoints", "operationId": "AdjustLoyaltyPoints", - "description": "Adds points to or subtracts points from a buyer\u0027s account. \n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call \n[AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/accumulate-loyalty-points) \nto add points when a buyer pays for the purchase.", + "description": "Adds points to or subtracts points from a buyer\u0027s account. \n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call \n[AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/accumulate-loyalty-points) \nto add points when a buyer pays for the purchase.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6812,7 +6812,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount).", + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount).", "type": "string", "in": "path", "required": true @@ -6849,7 +6849,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6885,13 +6885,13 @@ ], "summary": "ListLoyaltyPrograms", "operationId": "ListLoyaltyPrograms", - "description": "Returns a list of loyalty programs in the seller\u0027s account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.", + "description": "Returns a list of loyalty programs in the seller\u0027s account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6922,7 +6922,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6956,12 +6956,12 @@ ], "summary": "CalculateLoyaltyPoints", "operationId": "CalculateLoyaltyPoints", - "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/list-loyalty-promotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/list-loyalty-promotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -6972,7 +6972,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram), which defines the rules for accruing points.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram), which defines the rules for accruing points.", "type": "string", "in": "path", "required": true @@ -7004,12 +7004,12 @@ ], "summary": "ListLoyaltyPromotions", "operationId": "ListLoyaltyPromotions", - "description": "Lists the loyalty promotions associated with a [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", + "description": "Lists the loyalty promotions associated with a [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7020,7 +7020,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", "type": "string", "in": "path", "required": true @@ -7062,12 +7062,12 @@ ], "summary": "CreateLoyaltyPromotion", "operationId": "CreateLoyaltyPromotion", - "description": "Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", + "description": "Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7078,7 +7078,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-program)\nusing the `main` keyword.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-program)\nusing the `main` keyword.", "type": "string", "in": "path", "required": true @@ -7115,7 +7115,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7126,14 +7126,14 @@ "parameters": [ { "name": "promotion_id", - "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion) to retrieve.", + "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", "type": "string", "in": "path", "required": true @@ -7161,7 +7161,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7172,14 +7172,14 @@ "parameters": [ { "name": "promotion_id", - "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", + "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", "type": "string", "in": "path", "required": true }, { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "type": "string", "in": "path", "required": true @@ -7207,7 +7207,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7243,12 +7243,12 @@ ], "summary": "SearchLoyaltyRewards", "operationId": "SearchLoyaltyRewards", - "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. \nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the \n[RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-reward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", + "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. \nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the \n[RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-reward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7284,12 +7284,12 @@ ], "summary": "DeleteLoyaltyReward", "operationId": "DeleteLoyaltyReward", - "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created \n(see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/create-loyalty-reward)), \nit updates the order by removing the reward and related \ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", + "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created \n(see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/create-loyalty-reward)), \nit updates the order by removing the reward and related \ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7300,7 +7300,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward) to delete.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward) to delete.", "type": "string", "in": "path", "required": true @@ -7326,7 +7326,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7337,7 +7337,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward) to retrieve.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward) to retrieve.", "type": "string", "in": "path", "required": true @@ -7365,7 +7365,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7376,7 +7376,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward) to redeem.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward) to redeem.", "type": "string", "in": "path", "required": true @@ -7408,12 +7408,12 @@ ], "summary": "ListMerchants", "operationId": "ListMerchants", - "description": "Provides details about the merchant associated with a given access token. \n\nThe access token used to connect your application to a Square seller is associated \nwith a single merchant. That means that `ListMerchants` returns a list \nwith a single `Merchant` object. You can specify your personal access token \nto get your own merchant information or specify an OAuth token to get the \ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2022-10-19/merchants-api/retrieve-merchant)\nendpoint to retrieve the merchant information.", + "description": "Provides details about the merchant associated with a given access token. \n\nThe access token used to connect your application to a Square seller is associated \nwith a single merchant. That means that `ListMerchants` returns a list \nwith a single `Merchant` object. You can specify your personal access token \nto get your own merchant information or specify an OAuth token to get the \ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2022-11-16/merchants-api/retrieve-merchant)\nendpoint to retrieve the merchant information.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7452,7 +7452,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7491,7 +7491,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7537,7 +7537,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7581,7 +7581,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7619,7 +7619,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7658,7 +7658,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7703,12 +7703,12 @@ ], "summary": "CreateOrder", "operationId": "CreateOrder", - "description": "Creates a new [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/update-order) endpoint.", + "description": "Creates a new [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/update-order) endpoint.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7744,12 +7744,12 @@ ], "summary": "BatchRetrieveOrders", "operationId": "BatchRetrieveOrders", - "description": "Retrieves a set of [orders](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", + "description": "Retrieves a set of [orders](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7789,7 +7789,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -7829,7 +7829,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7865,12 +7865,12 @@ ], "summary": "SearchOrders", "operationId": "SearchOrders", - "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](https://developer.squareup.com/reference/square_2022-10-19/objects/SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](https://developer.squareup.com/reference/square_2022-10-19/objects/OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", + "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](https://developer.squareup.com/reference/square_2022-11-16/objects/SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](https://developer.squareup.com/reference/square_2022-11-16/objects/OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7906,12 +7906,12 @@ ], "summary": "RetrieveOrder", "operationId": "RetrieveOrder", - "description": "Retrieves an [Order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) by ID.", + "description": "Retrieves an [Order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) by ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7943,13 +7943,13 @@ ], "summary": "UpdateOrder", "operationId": "UpdateOrder", - "description": "Updates an open [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", + "description": "Updates an open [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -7993,14 +7993,14 @@ ], "summary": "PayOrder", "operationId": "PayOrder", - "description": "Pay for an [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2022-10-19/objects/Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/create-payment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", + "description": "Pay for an [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2022-11-16/objects/Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/create-payment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "PAYMENTS_WRITE", "ORDERS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8050,7 +8050,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8144,7 +8144,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8185,7 +8185,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8226,7 +8226,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8263,7 +8263,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8311,7 +8311,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8350,7 +8350,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8396,7 +8396,7 @@ "description": "Retrieves a list of all payouts for the default location. \nYou can filter payouts by location ID, status, time range, and order them in ascending or descending order. \nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -8473,7 +8473,7 @@ "description": "Retrieves details of a specific payout identified by a payout ID. \nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -8508,7 +8508,7 @@ "description": "Retrieves a list of all payout entries for a specific payout.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -8566,7 +8566,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8612,7 +8612,7 @@ }, { "name": "status", - "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2022-10-19/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2022-11-16/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", "type": "string", "in": "query", "required": false @@ -8652,7 +8652,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8693,7 +8693,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8732,7 +8732,7 @@ "x-oauthpermissions": [ "ONLINE_STORE_SITE_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8758,12 +8758,12 @@ ], "summary": "DeleteSnippet", "operationId": "DeleteSnippet", - "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2022-10-19/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2022-11-16/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8795,12 +8795,12 @@ ], "summary": "RetrieveSnippet", "operationId": "RetrieveSnippet", - "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2022-10-19/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2022-11-16/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8832,12 +8832,12 @@ ], "summary": "UpsertSnippet", "operationId": "UpsertSnippet", - "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2022-10-19/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2022-11-16/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8890,7 +8890,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8936,7 +8936,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -8977,7 +8977,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9027,7 +9027,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9081,7 +9081,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9129,7 +9129,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9168,7 +9168,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9227,7 +9227,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9286,7 +9286,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9345,7 +9345,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9399,7 +9399,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9440,7 +9440,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9481,7 +9481,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9522,7 +9522,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9563,7 +9563,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9600,7 +9600,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9648,7 +9648,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9685,7 +9685,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9734,7 +9734,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9776,7 +9776,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9818,7 +9818,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9859,7 +9859,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9899,7 +9899,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9940,7 +9940,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -9981,7 +9981,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10020,7 +10020,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10054,12 +10054,12 @@ ], "summary": "CreateTerminalRefund", "operationId": "CreateTerminalRefund", - "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2022-10-19/refunds-api).", + "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2022-11-16/refunds-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10100,7 +10100,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10141,7 +10141,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10180,7 +10180,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10214,13 +10214,13 @@ ], "summary": "BulkCreateVendors", "operationId": "BulkCreateVendors", - "description": "Creates one or more [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects to represent suppliers to a seller.", + "description": "Creates one or more [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects to represent suppliers to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10256,13 +10256,13 @@ ], "summary": "BulkRetrieveVendors", "operationId": "BulkRetrieveVendors", - "description": "Retrieves one or more vendors of specified [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) IDs.", + "description": "Retrieves one or more vendors of specified [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) IDs.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10298,13 +10298,13 @@ ], "summary": "BulkUpdateVendors", "operationId": "BulkUpdateVendors", - "description": "Updates one or more of existing [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects as suppliers to a seller.", + "description": "Updates one or more of existing [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects as suppliers to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10340,13 +10340,13 @@ ], "summary": "CreateVendor", "operationId": "CreateVendor", - "description": "Creates a single [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) object to represent a supplier to a seller.", + "description": "Creates a single [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) object to represent a supplier to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10382,13 +10382,13 @@ ], "summary": "SearchVendors", "operationId": "SearchVendors", - "description": "Searches for vendors using a filter against supported [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) properties and a supported sorter.", + "description": "Searches for vendors using a filter against supported [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) properties and a supported sorter.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10424,13 +10424,13 @@ ], "summary": "RetrieveVendor", "operationId": "RetrieveVendor", - "description": "Retrieves the vendor of a specified [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) ID.", + "description": "Retrieves the vendor of a specified [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) ID.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10441,7 +10441,7 @@ "parameters": [ { "name": "vendor_id", - "description": "ID of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) to retrieve.", + "description": "ID of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -10463,13 +10463,13 @@ ], "summary": "UpdateVendor", "operationId": "UpdateVendor", - "description": "Updates an existing [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) object as a supplier to a seller.", + "description": "Updates an existing [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) object as a supplier to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [ @@ -10516,7 +10516,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10553,7 +10553,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10570,7 +10570,7 @@ }, { "name": "include_disabled", - "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)s are returned.", + "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)s are returned.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -10578,7 +10578,7 @@ }, { "name": "sort_order", - "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", + "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", "x-is-beta": true, "type": "string", "in": "query", @@ -10612,7 +10612,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10650,7 +10650,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10659,7 +10659,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to delete.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to delete.", "x-is-beta": true, "type": "string", "in": "path", @@ -10685,7 +10685,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10694,7 +10694,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to retrieve.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -10720,7 +10720,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10729,7 +10729,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to update.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to update.", "x-is-beta": true, "type": "string", "in": "path", @@ -10766,7 +10766,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10775,7 +10775,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to update.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to update.", "x-is-beta": true, "type": "string", "in": "path", @@ -10812,7 +10812,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2022-10-19", + "x-sq-version": "2022-11-16", "security": [ { "oauth2": [] @@ -10821,7 +10821,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to test.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to test.", "x-is-beta": true, "type": "string", "in": "path", @@ -11809,71 +11809,71 @@ "x-enum-elements": [ { "name": "ITEM", - "description": "The `CatalogObject` instance is of the [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." }, { "name": "IMAGE", - "description": "The `CatalogObject` instance is of the [CatalogImage](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." + "description": "The `CatalogObject` instance is of the [CatalogImage](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." }, { "name": "CATEGORY", - "description": "The `CatalogObject` instance is of the [CatalogCategory](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." + "description": "The `CatalogObject` instance is of the [CatalogCategory](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." }, { "name": "ITEM_VARIATION", - "description": "The `CatalogObject` instance is of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." }, { "name": "TAX", - "description": "The `CatalogObject` instance is of the [CatalogTax](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." + "description": "The `CatalogObject` instance is of the [CatalogTax](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." }, { "name": "DISCOUNT", - "description": "The `CatalogObject` instance is of the [CatalogDiscount](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." + "description": "The `CatalogObject` instance is of the [CatalogDiscount](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." }, { "name": "MODIFIER_LIST", - "description": "The `CatalogObject` instance is of the [CatalogModifierList](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." + "description": "The `CatalogObject` instance is of the [CatalogModifierList](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." }, { "name": "MODIFIER", - "description": "The `CatalogObject` instance is of the [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." + "description": "The `CatalogObject` instance is of the [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." }, { "name": "PRICING_RULE", - "description": "The `CatalogObject` instance is of the [CatalogPricingRule](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." + "description": "The `CatalogObject` instance is of the [CatalogPricingRule](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." }, { "name": "PRODUCT_SET", - "description": "The `CatalogObject` instance is of the [CatalogProductSet](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." + "description": "The `CatalogObject` instance is of the [CatalogProductSet](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." }, { "name": "TIME_PERIOD", - "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." + "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." }, { "name": "MEASUREMENT_UNIT", - "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." + "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." }, { "name": "SUBSCRIPTION_PLAN", - "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." }, { "name": "ITEM_OPTION", - "description": "The `CatalogObject` instance is of the [CatalogItemOption](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt) \nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemOption](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt) \nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." }, { "name": "ITEM_OPTION_VAL", - "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." }, { "name": "CUSTOM_ATTRIBUTE_DEFINITION", - "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute. \nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." + "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute. \nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." }, { "name": "QUICK_AMOUNTS_SETTINGS", - "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED. \nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." + "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED. \nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." } ], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specfied object type.", @@ -15582,7 +15582,7 @@ "x-enum-elements": [ { "name": "PICKUP", - "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location)." + "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location)." }, { "name": "SHIPMENT", @@ -15618,7 +15618,7 @@ "description": "The balance was decreased because the order used to purchase or reload the\ngift card was refunded." } ], - "description": "Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard).", + "description": "Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustIncrementReason": { @@ -15642,7 +15642,7 @@ "description": "The transaction is voided." } ], - "description": "Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard).", + "description": "Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityBlockReason": { @@ -15656,7 +15656,7 @@ "description": "The gift card is blocked because the buyer initiated a chargeback on the gift card purchase." } ], - "description": "Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard).", + "description": "Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityClearBalanceReason": { @@ -15680,7 +15680,7 @@ "description": "The gift card balance was cleared for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API." } ], - "description": "Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard).", + "description": "Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityDeactivateReason": { @@ -15704,7 +15704,7 @@ "description": "A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API." } ], - "description": "Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard).", + "description": "Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityRedeemStatus": { @@ -15728,7 +15728,7 @@ "description": "The gift card redemption is canceled. A redemption is canceled if the authorization \non the gift card is voided." } ], - "description": "Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", + "description": "Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", "x-release-status": "PUBLIC" }, "GiftCardActivityType": { @@ -15802,7 +15802,7 @@ "description": "Reversed the import of a third-party gift card, which sets the gift card state to \n`PENDING` and clears the balance. `IMPORT_REVERSAL` activities are managed by Square and \ncannot be created using the Gift Card Activities API." } ], - "description": "Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivity).", + "description": "Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivity).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnblockReason": { @@ -15816,7 +15816,7 @@ "description": "The gift card is unblocked because a chargeback was ruled in favor of the seller." } ], - "description": "Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard).", + "description": "Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardGANSource": { @@ -16034,7 +16034,7 @@ "description": "Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\naccount for the amount of the payment request.\n\nThis payment method applies only to recurring invoices that sellers create in the Seller Dashboard or other\nSquare first-party applications. The bank account is provided by the customer during the payment flow. \n\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`." } ], - "description": "Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2022-10-19/objects/InvoicePaymentRequest).", + "description": "Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2022-11-16/objects/InvoicePaymentRequest).", "x-release-status": "PUBLIC" }, "InvoiceCustomFieldPlacement": { @@ -16077,7 +16077,7 @@ "description": "Directs Square to send invoices and receipts to the customer using SMS (text message).\n\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`." } ], - "description": "Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) to the customer.", + "description": "Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) to the customer.", "x-release-status": "PUBLIC" }, "InvoicePaymentReminderStatus": { @@ -16118,7 +16118,7 @@ "x-enum-elements": [ { "name": "EMAIL", - "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice))." + "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice))." }, { "name": "CHARGE_CARD_ON_FILE", @@ -16134,7 +16134,7 @@ }, { "name": "SMS", - "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." + "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." }, { "name": "SMS_CHARGE_CARD_ON_FILE", @@ -16380,11 +16380,11 @@ "x-enum-elements": [ { "name": "ACCUMULATE_POINTS", - "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgramAccrualRule)." + "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgramAccrualRule)." }, { "name": "CREATE_REWARD", - "description": "A [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward) is created." + "description": "A [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward) is created." }, { "name": "REDEEM_REWARD", @@ -16408,7 +16408,7 @@ }, { "name": "ACCUMULATE_PROMOTION_POINTS", - "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion)." + "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion)." } ], "description": "The type of the loyalty event.", @@ -16542,7 +16542,7 @@ "description": "Add a specified number of points to those earned from the base loyalty program.\nFor example, \"Earn 10 additional points.\"" } ], - "description": "Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", + "description": "Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionStatus": { @@ -16571,7 +16571,7 @@ "description": "The loyalty promotion is scheduled to start in the future. Square changes the\npromotion status to `ACTIVE` when the `start_date` is reached." } ], - "description": "Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion).", + "description": "Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionTriggerLimitInterval": { @@ -16590,7 +16590,7 @@ "description": "The limit applies per day, according to the `available_time` schedule specified for the promotion.\nFor example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion\na maximum of once per day." } ], - "description": "Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion).", + "description": "Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyRewardStatus": { @@ -17011,7 +17011,7 @@ "x-enum-elements": [ { "name": "PICKUP", - "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location)." + "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location)." }, { "name": "SHIPMENT", @@ -17484,14 +17484,14 @@ "x-enum-elements": [ { "name": "NAME", - "description": "To sort the result by the name of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects." + "description": "To sort the result by the name of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects." }, { "name": "CREATED_AT", - "description": "To sort the result by the creation time of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects." + "description": "To sort the result by the creation time of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects." } ], - "description": "The field to sort the returned [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects by.", + "description": "The field to sort the returned [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects by.", "x-release-status": "BETA", "x-is-beta": true }, @@ -17706,7 +17706,7 @@ "description": "Once every two years" } ], - "description": "Determines the billing cadence of a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/Subscription)", + "description": "Determines the billing cadence of a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/Subscription)", "x-release-status": "PUBLIC" }, "SubscriptionEventInfoCode": { @@ -18676,7 +18676,7 @@ "description": "Vendor is inactive and cannot receive purchase orders." } ], - "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor),\nwhether a [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) is active or inactive.", + "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor),\nwhether a [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) is active or inactive.", "x-release-status": "BETA", "x-is-beta": true }, @@ -18863,10 +18863,10 @@ }, "location_id": { "type": "string", - "description": "The [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the purchase was made." + "description": "The [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the purchase was made." } }, - "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/accumulate-loyalty-points) request.", + "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/accumulate-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?account_id\u003d5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", @@ -18903,7 +18903,7 @@ "description": "The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event\nis always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included\nif the purchase also qualifies for a loyalty promotion." } }, - "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/accumulate-loyalty-points) response.", + "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/accumulate-loyalty-points) response.", "x-release-status": "PUBLIC", "example": { "events": [ @@ -18926,7 +18926,7 @@ "AddGroupToCustomerRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2022-10-19/customers-api/add-group-to-customer) endpoint.", + "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2022-11-16/customers-api/add-group-to-customer) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -18943,7 +18943,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2022-10-19/customers-api/add-group-to-customer) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2022-11-16/customers-api/add-group-to-customer) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -19064,7 +19064,7 @@ "description": "Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative\nbalance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting\nthe specified number of points would result in a negative balance. The default value is `false`." } }, - "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/adjust-loyalty-points) request.", + "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/adjust-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?account_id\u003d5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", @@ -19092,7 +19092,7 @@ "description": "The resulting event data for the adjustment." } }, - "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/adjust-loyalty-points) request.", + "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/adjust-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "event": { @@ -19152,13 +19152,13 @@ "minLength": 0, "maxLength": 36, "type": "string", - "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) object representing the service booked in this segment." + "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) object representing the service booked in this segment." }, "team_member_id": { "minLength": 1, "maxLength": 32, "type": "string", - "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) object representing the team member booked in this segment." + "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) object representing the team member booked in this segment." }, "service_variation_version": { "type": "integer", @@ -19545,7 +19545,7 @@ "catalog_version": { "type": "integer", "format": "int64", - "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true }, @@ -19589,14 +19589,14 @@ "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s returned." + "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s returned." }, "related_objects": { "type": "array", "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s referenced by the object in the `objects` field." + "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s referenced by the object in the `objects` field." } }, "description": "", @@ -19779,7 +19779,7 @@ "maximum": 1000, "minimum": 1, "type": "integer", - "description": "The number of [records](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryChange) to return." + "description": "The number of [records](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryChange) to return." } }, "description": "", @@ -19897,7 +19897,7 @@ "maximum": 1000, "minimum": 1, "type": "integer", - "description": "The number of [records](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryCount) to return." + "description": "The number of [records](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryCount) to return." } }, "description": "", @@ -20421,25 +20421,25 @@ "minLength": 0, "maxLength": 32, "type": "string", - "description": "The ID of the [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed." + "description": "The ID of the [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed." }, "customer_id": { "minLength": 0, "maxLength": 192, "type": "string", - "description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) object representing the customer receiving the booked service." + "description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) object representing the customer receiving the booked service." }, "customer_note": { "minLength": 0, "maxLength": 4096, "type": "string", - "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) instance." + "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) instance." }, "seller_note": { "minLength": 0, "maxLength": 4096, "type": "string", - "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) instance.\nThis field should not be visible to customers." + "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) instance.\nThis field should not be visible to customers." }, "appointment_segments": { "type": "array", @@ -20720,10 +20720,10 @@ "additionalProperties": { "$ref": "#/definitions/Vendor" }, - "description": "Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." + "description": "Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." } }, - "description": "Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/bulk-create-vendors).", + "description": "Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/bulk-create-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -20778,10 +20778,10 @@ "additionalProperties": { "$ref": "#/definitions/CreateVendorResponse" }, - "description": "A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2022-10-19/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." + "description": "A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2022-11-16/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." } }, - "description": "Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/bulk-create-vendors).", + "description": "Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/bulk-create-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -20844,10 +20844,10 @@ "items": { "type": "string" }, - "description": "IDs of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects to retrieve." + "description": "IDs of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects to retrieve." } }, - "description": "Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/bulk-retrieve-vendors).", + "description": "Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/bulk-retrieve-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -20873,10 +20873,10 @@ "additionalProperties": { "$ref": "#/definitions/RetrieveVendorResponse" }, - "description": "The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2022-10-19/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." + "description": "The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2022-11-16/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." } }, - "description": "Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/bulk-retrieve-vendors).", + "description": "Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/bulk-retrieve-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -21042,10 +21042,10 @@ "additionalProperties": { "$ref": "#/definitions/UpdateVendorRequest" }, - "description": "A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2022-10-19/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." + "description": "A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2022-11-16/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." } }, - "description": "Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/bulk-update-vendors).", + "description": "Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/bulk-update-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -21086,10 +21086,10 @@ "additionalProperties": { "$ref": "#/definitions/UpdateVendorResponse" }, - "description": "A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2022-10-19/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." + "description": "A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2022-11-16/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." } }, - "description": "Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/bulk-update-vendors).", + "description": "Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/bulk-update-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -21162,7 +21162,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -21216,7 +21216,7 @@ "customer_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer)." + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -21228,7 +21228,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC" }, "BulkUpsertCustomerCustomAttributesResponse": { @@ -21249,7 +21249,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -21330,7 +21330,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", @@ -21508,7 +21508,7 @@ "properties": { "order_id": { "type": "string", - "description": "The [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`." + "description": "The [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`." }, "transaction_amount_money": { "$ref": "#/definitions/Money", @@ -21518,10 +21518,10 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion\u0027s\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit." + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion\u0027s\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit." } }, - "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/calculate-loyalty-points) request.", + "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/calculate-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -21552,7 +21552,7 @@ "description": "The number of points that the buyer can earn from a loyalty promotion. To be eligible\nto earn promotion points, the purchase must first qualify for program points. When `order_id`\nis not provided in the request, this value is always 0." } }, - "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/calculate-loyalty-points) response.", + "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/calculate-loyalty-points) response.", "x-release-status": "PUBLIC", "example": { "points": 6, @@ -21847,7 +21847,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](https://developer.squareup.com/reference/square_2022-10-19/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2022-10-19/invoices-api/list-invoices)." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](https://developer.squareup.com/reference/square_2022-11-16/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2022-11-16/invoices-api/list-invoices)." } }, "description": "Describes a `CancelInvoice` request.", @@ -21949,7 +21949,7 @@ "CancelLoyaltyPromotionRequest": { "type": "object", "properties": {}, - "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/cancel-loyalty-promotion) request.", + "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/cancel-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id\u003dloypromo_f0f9b849-725e-378d-b810-511237e07b67", @@ -21971,7 +21971,7 @@ "description": "The canceled loyalty promotion." } }, - "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/cancel-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/cancel-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -22014,7 +22014,7 @@ "description": "The `idempotency_key` identifying the payment to be canceled." } }, - "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2022-10-19/payments-api/cancel-payment-by-idempotency-key).", + "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2022-11-16/payments-api/cancel-payment-by-idempotency-key).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -22033,14 +22033,14 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2022-10-19/payments-api/cancel-payment-by-idempotency-key).\nOn success, `errors` is empty.", + "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2022-11-16/payments-api/cancel-payment-by-idempotency-key).\nOn success, `errors` is empty.", "x-release-status": "PUBLIC", "example": {} }, "CancelPaymentRequest": { "type": "object", "properties": {}, - "description": "Describes the request to cancel (void) a payment using \n[CancelPayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/cancel-payment). \nYou can only cancel a payment that is approved (not completed).\nFor more information, see \n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", + "description": "Describes the request to cancel (void) a payment using \n[CancelPayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/cancel-payment). \nYou can only cancel a payment that is approved (not completed).\nFor more information, see \n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -22061,7 +22061,7 @@ "description": "The successfully canceled `Payment` object." } }, - "description": "Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/cancel-payment).", + "description": "Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/cancel-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -22130,7 +22130,7 @@ "CancelSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Defines input parameters in a request to the \n[CancelSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/cancel-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[CancelSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/cancel-subscription) endpoint.", "x-release-status": "PUBLIC" }, "CancelSubscriptionResponse": { @@ -22157,7 +22157,7 @@ "x-is-beta": true } }, - "description": "Defines output parameters in a response from the \n[CancelSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/cancel-subscription) endpoint.", + "description": "Defines output parameters in a response from the \n[CancelSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/cancel-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -22359,7 +22359,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/capture-transaction) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/capture-transaction) endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": {}, @@ -22586,7 +22586,7 @@ "minLength": 2, "maxLength": 2, "type": "string", - "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](https://developer.squareup.com/reference/square_2022-10-19/enums/Country)." + "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](https://developer.squareup.com/reference/square_2022-11-16/enums/Country)." }, "buyer_cashtag": { "minLength": 1, @@ -22971,7 +22971,7 @@ }, "custom_attribute_definition_id": { "type": "string", - "description": "The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogCustomAttributeDefinition) this value belongs to.", + "description": "The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogCustomAttributeDefinition) this value belongs to.", "x-read-only": true }, "type": { @@ -23070,7 +23070,7 @@ "description": "The permanent ID for the CatalogObject created by the server." } }, - "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/upsert-catalog-object) or\n[BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/batch-upsert-catalog-objects) to\ncreate a [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", + "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/upsert-catalog-object) or\n[BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/batch-upsert-catalog-objects) to\ncreate a [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", "x-release-status": "PUBLIC" }, "CatalogImage": { @@ -23078,15 +23078,15 @@ "properties": { "name": { "type": "string", - "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-objects).\nIt is not unique and should not be shown in a buyer facing context." + "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-objects).\nIt is not unique and should not be shown in a buyer facing context." }, "url": { "type": "string", - "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/create-catalog-image) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field." + "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/create-catalog-image) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field." }, "caption": { "type": "string", - "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-objects)." + "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-objects)." }, "photo_studio_order_id": { "type": "string", @@ -23220,7 +23220,7 @@ "description": { "maxLength": 4096, "type": "string", - "description": "The item\u0027s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description \nof the [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to \nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, \nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null \ndoes not nullify `description_html`.", + "description": "The item\u0027s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description \nof the [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to \nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, \nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null \ndoes not nullify `description_html`.", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -23268,7 +23268,7 @@ "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) objects for this item. An item must have\nat least one variation." + "description": "A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) objects for this item. An item must have\nat least one variation." }, "product_type": { "type": "string", @@ -23314,7 +23314,7 @@ "x-read-only": true } }, - "description": "A [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", + "description": "A [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", "x-release-status": "PUBLIC", "example": { "object": { @@ -23565,12 +23565,12 @@ }, "stockable_conversion": { "$ref": "#/definitions/CatalogStockConversion", - "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogStockConversion) type, \nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion, \nyou can accurately track inventory when an item variation is sold in one unit, but stocked in \nanother unit.", + "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogStockConversion) type, \nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion, \nyou can accurately track inventory when an item variation is sold in one unit, but stocked in \nanother unit.", "x-release-status": "BETA", "x-is-beta": true } }, - "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) must have at least one \nitem variation and can have at most 250 item variations. \n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked \nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both \nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass \nvariation is sellable, but not stockable. To accurately keep track of the wine\u0027s inventory count at any time, the sellable count must be \nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes \nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count \ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", + "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) must have at least one \nitem variation and can have at most 250 item variations. \n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked \nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both \nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass \nvariation is sellable, but not stockable. To accurately keep track of the wine\u0027s inventory count at any time, the sellable count must be \nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes \nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count \ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", "x-release-status": "PUBLIC" }, "CatalogMeasurementUnit": { @@ -23768,7 +23768,7 @@ "additionalProperties": { "$ref": "#/definitions/CatalogCustomAttributeValue" }, - "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\u0027s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).", + "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\u0027s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).", "x-release-status": "BETA", "x-is-beta": true }, @@ -24094,12 +24094,12 @@ }, "item_variations_for_item_option_values_query": { "$ref": "#/definitions/CatalogQueryItemVariationsForItemOptionValues", - "description": "A query expression to return item variations (of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs.", + "description": "A query expression to return item variations (of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs.", "x-release-status": "BETA", "x-is-beta": true } }, - "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-objects).\nAny combination of the following types may be used together:\n- [exact_query](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogQueryExact)\n- [prefix_query](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogQueryPrefix)\n- [range_query](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogQueryRange)\n- [sorted_attribute_query](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogQuerySortedAttribute)\n- [text_query](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogQueryText)\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\n* Searchable attribute and objects queryable by searchable attributes **\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, \u0027CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", + "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-objects).\nAny combination of the following types may be used together:\n- [exact_query](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogQueryExact)\n- [prefix_query](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogQueryPrefix)\n- [range_query](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogQueryRange)\n- [sorted_attribute_query](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogQuerySortedAttribute)\n- [text_query](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogQueryText)\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\n* Searchable attribute and objects queryable by searchable attributes **\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, \u0027CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", "x-release-status": "PUBLIC" }, "CatalogQueryExact": { @@ -24362,7 +24362,7 @@ "stockable_item_variation_id": { "minLength": 1, "type": "string", - "description": "References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItem) of the converted `CatalogItemVariation.`" + "description": "References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItem) of the converted `CatalogItemVariation.`" }, "stockable_quantity": { "minLength": 1, @@ -24374,10 +24374,10 @@ "minLength": 1, "maxLength": 16, "type": "string", - "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point." + "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point." } }, - "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", + "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", "x-release-status": "BETA", "x-is-beta": true }, @@ -24397,7 +24397,7 @@ "items": { "$ref": "#/definitions/SubscriptionPhase" }, - "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2022-10-19/objects/SubscriptionPhase) for this plan." + "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2022-11-16/objects/SubscriptionPhase) for this plan." } }, "description": "Describes a subscription plan. For more information, see\n[Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan).", @@ -24505,7 +24505,7 @@ }, "delay_capture": { "type": "boolean", - "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/capture-transaction) endpoint) or a Void\n(with the [VoidTransaction](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/void-transaction) endpoint).\n\nDefault value: `false`" + "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/capture-transaction) endpoint) or a Void\n(with the [VoidTransaction](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/void-transaction) endpoint).\n\nDefault value: `false`" }, "reference_id": { "maxLength": 40, @@ -24551,7 +24551,7 @@ "description": "A token generated by SqPaymentForm\u0027s verifyBuyer() that represents\ncustomer\u0027s device info and 3ds challenge result." } }, - "description": "Defines the parameters that can be included in the body of\na request to the [Charge](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/create-payment)", + "description": "Defines the parameters that can be included in the body of\na request to the [Charge](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/create-payment)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -24645,7 +24645,7 @@ "description": "The created transaction." } }, - "description": "Defines the fields that are included in the response body of\na request to the [Charge](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [Charge](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -24832,7 +24832,7 @@ "description": "A value you specify that uniquely identifies this clone request.\n\nIf you are unsure whether a particular order was cloned successfully,\nyou can reattempt the call with the same idempotency key without\nworrying about creating duplicate cloned orders.\nThe originally cloned order is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency)." } }, - "description": "Defines the fields that are included in requests to the\n[CloneOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/clone-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[CloneOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/clone-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24858,7 +24858,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/clone-order) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/clone-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25121,7 +25121,7 @@ "x-is-beta": true } }, - "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/complete-payment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", + "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/complete-payment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -25142,7 +25142,7 @@ "description": "The successfully completed payment." } }, - "description": "Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/complete-payment).", + "description": "Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/complete-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -25430,7 +25430,7 @@ "description": "The newly created card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](https://developer.squareup.com/reference/square_2022-10-19/cards-api/create-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](https://developer.squareup.com/reference/square_2022-11-16/cards-api/create-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -25880,7 +25880,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -25911,7 +25911,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/create-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -25943,7 +25943,7 @@ "description": "The customer group to create." } }, - "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/create-customer-group) endpoint.", + "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/create-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -25968,7 +25968,7 @@ "description": "The successfully created customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -26327,14 +26327,14 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\u0027s locations." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\u0027s locations." }, "gift_card": { "$ref": "#/definitions/GiftCard", "description": "The gift card to create. The `type` field is required for this request. The `gan_source` \nand `gan` fields are included as follows: \n\nTo direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`.\n\nTo provide a custom GAN, include `gan_source` and `gan`.\n- For `gan_source`, specify `OTHER`. \n- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be \nunique for the seller and cannot start with the same bank identification number (BIN) as major \ncredit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly \nincrease the risk of fraud. It is the responsibility of the developer to ensure the security \nof their custom GANs. For more information, see \n[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). \n\nTo register an unused, physical gift card that the seller previously ordered from Square, \ninclude `gan` and provide the GAN that is printed on the gift card." } }, - "description": "Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2022-10-19/gift-cards-api/create-gift-card) request.", + "description": "Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2022-11-16/gift-cards-api/create-gift-card) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -26544,7 +26544,7 @@ "description": "The initial values of the location being created. The `name` field is required and must be unique within a seller account.\nAll other fields are optional, but any information you care about for the location should be included.\nThe remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location)." } }, - "description": "The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2022-10-19/locations-api/create-location) endpoint.", + "description": "The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2022-11-16/locations-api/create-location) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -26576,7 +26576,7 @@ "description": "The newly created `Location` object." } }, - "description": "The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2022-10-19/locations-api/create-location) endpoint.", + "description": "The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2022-11-16/locations-api/create-location) endpoint.", "x-release-status": "PUBLIC", "example": { "location": { @@ -26693,7 +26693,7 @@ "description": "A unique identifier for this request, which is used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/create-loyalty-promotion) request.", + "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/create-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -26735,7 +26735,7 @@ "description": "The new loyalty promotion." } }, - "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/create-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/create-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -27444,7 +27444,7 @@ }, "customer_id": { "type": "string", - "description": "The [Customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Customers API." + "description": "The [Customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Customers API." }, "location_id": { "type": "string", @@ -27452,7 +27452,7 @@ }, "team_member_id": { "type": "string", - "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) ID to associate with \nthis payment." + "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) ID to associate with \nthis payment." }, "reference_id": { "maxLength": 40, @@ -27499,7 +27499,7 @@ "description": "Additional details required when recording an external payment (`source_id` is EXTERNAL)." } }, - "description": "Describes a request to create a payment using \n[CreatePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/create-payment).", + "description": "Describes a request to create a payment using \n[CreatePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/create-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -27536,7 +27536,7 @@ "description": "The newly created payment." } }, - "description": "Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/create-payment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", + "description": "Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/create-payment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", "x-release-status": "PUBLIC", "example": { "payment": { @@ -27623,7 +27623,7 @@ "minLength": 1, "maxLength": 192, "type": "string", - "description": "The ID of the tender to refund.\n\nA [`Transaction`](https://developer.squareup.com/reference/square_2022-10-19/objects/Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API." + "description": "The ID of the tender to refund.\n\nA [`Transaction`](https://developer.squareup.com/reference/square_2022-11-16/objects/Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API." }, "reason": { "maxLength": 192, @@ -27635,7 +27635,7 @@ "description": "The amount of money to refund.\n\nNote that you specify the amount in the\n__smallest denomination of the applicable currency__. For example, US dollar\namounts are specified in cents. See\n[Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.\n\nThis amount cannot exceed the amount that was originally charged to the\ntender that corresponds to `tender_id`." } }, - "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/create-refund) endpoint.\n\nDeprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/refund-payment)", + "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/create-refund) endpoint.\n\nDeprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/refund-payment)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -27673,7 +27673,7 @@ "description": "The created refund." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/create-refund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/create-refund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -27834,7 +27834,7 @@ "customer_id": { "minLength": 1, "type": "string", - "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) subscribing to the subscription plan." + "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) subscribing to the subscription plan." }, "start_date": { "type": "string", @@ -27855,7 +27855,7 @@ }, "card_id": { "type": "string", - "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) [card](https://developer.squareup.com/reference/square_2022-10-19/objects/Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email. For an example to\ncreate a customer profile for a subscriber and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough)." + "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) [card](https://developer.squareup.com/reference/square_2022-11-16/objects/Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email. For an example to\ncreate a customer profile for a subscriber and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough)." }, "timezone": { "type": "string", @@ -27868,7 +27868,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[CreateSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/create-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[CreateSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/create-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -27905,7 +27905,7 @@ "description": "The newly created subscription.\n\nFor more information, see\n[Subscription object](https://developer.squareup.com/docs/subscriptions-api/overview#subscription-object)." } }, - "description": "Defines output parameters in a response from the\n[CreateSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/create-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[CreateSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/create-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -28245,14 +28245,14 @@ "minLength": 1, "maxLength": 128, "type": "string", - "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/create-vendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more\ninformation." + "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/create-vendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more\ninformation." }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The requested [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) to be created." + "description": "The requested [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) to be created." } }, - "description": "Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/create-vendor).", + "description": "Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/create-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -28293,10 +28293,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The successfully created [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) object." + "description": "The successfully created [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) object." } }, - "description": "Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/create-vendor).", + "description": "Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/create-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -28338,14 +28338,14 @@ "idempotency_key": { "maxLength": 45, "type": "string", - "description": "A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/create-webhook-subscription) request." + "description": "A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/create-webhook-subscription) request." }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to create." + "description": "The [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to create." } }, - "description": "Creates a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription).", + "description": "Creates a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -28376,10 +28376,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The new [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)." + "description": "The new [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/create-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/create-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -28515,7 +28515,7 @@ "description": "A query expression to filter items or item variations by matching their custom attributes\u0027\n`boolean_value` property values against the specified Boolean expression.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified." } }, - "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-items)\nendpoint to search for items or item variations.", + "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-items)\nendpoint to search for items or item variations.", "x-release-status": "PUBLIC" }, "CustomField": { @@ -28539,7 +28539,7 @@ "properties": { "id": { "type": "string", - "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2022-10-19/customers-api/search-customers) \nor [ListCustomers](https://developer.squareup.com/reference/square_2022-10-19/customers-api/list-customers) endpoint." + "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2022-11-16/customers-api/search-customers) \nor [ListCustomers](https://developer.squareup.com/reference/square_2022-11-16/customers-api/list-customers) endpoint." }, "created_at": { "type": "string", @@ -28556,7 +28556,7 @@ "items": { "$ref": "#/definitions/Card" }, - "description": "Payment details of the credit, debit, and gift cards stored on file for the customer profile. \n\nDEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2022-10-19/cards-api/list-cards) (for credit and debit cards on file) \nor [ListGiftCards](https://developer.squareup.com/reference/square_2022-10-19/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter. \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).", + "description": "Payment details of the credit, debit, and gift cards stored on file for the customer profile. \n\nDEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2022-11-16/cards-api/list-cards) (for credit and debit cards on file) \nor [ListGiftCards](https://developer.squareup.com/reference/square_2022-11-16/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter. \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -28647,7 +28647,7 @@ "description": "The country code to search for." } }, - "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", + "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", "x-release-status": "BETA", "x-is-beta": true }, @@ -28677,18 +28677,18 @@ "properties": { "key": { "type": "string", - "description": "The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api)." + "description": "The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api)." }, "filter": { "$ref": "#/definitions/CustomerCustomAttributeFilterValue", - "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api).\n\nYou must provide this `filter` field, the `updated_at` field, or both." + "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api).\n\nYou must provide this `filter` field, the `updated_at` field, or both." }, "updated_at": { "$ref": "#/definitions/TimeRange", "description": "The date range for when the custom attribute was last updated. The date range can include `start_at`, `end_at`, or\nboth. Range boundaries are inclusive. Dates are specified as RFC 3339 timestamps.\n\nYou must provide this `updated_at` field, the `filter` field, or both." } }, - "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute).", + "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute).", "x-release-status": "BETA", "x-is-beta": true }, @@ -28709,7 +28709,7 @@ }, "selection": { "$ref": "#/definitions/FilterValue", - "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller." + "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller." }, "date": { "$ref": "#/definitions/TimeRange", @@ -28728,7 +28728,7 @@ "description": "A filter for a query based on the value of an `Address`-type custom attribute. The filter can include `postal_code`, `country`, or both." } }, - "description": "A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute).", + "description": "A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute).", "x-release-status": "BETA", "x-is-beta": true }, @@ -28743,7 +28743,7 @@ "description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters." } }, - "description": "The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", + "description": "The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", "x-release-status": "BETA", "x-is-beta": true }, @@ -28780,12 +28780,12 @@ }, "custom_attribute": { "$ref": "#/definitions/CustomerCustomAttributeFilters", - "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api). For example, you can call\n[RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/retrieve-customer-custom-attribute) using a customer ID from the result set.", + "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api). For example, you can call\n[RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/retrieve-customer-custom-attribute) using a customer ID from the result set.", "x-release-status": "BETA", "x-is-beta": true } }, - "description": "Represents a set of `CustomerQuery` filters used to limit the set of\ncustomers returned by the [SearchCustomers](https://developer.squareup.com/reference/square_2022-10-19/customers-api/search-customers) endpoint.", + "description": "Represents a set of `CustomerQuery` filters used to limit the set of\ncustomers returned by the [SearchCustomers](https://developer.squareup.com/reference/square_2022-11-16/customers-api/search-customers) endpoint.", "x-release-status": "PUBLIC" }, "CustomerGroup": { @@ -28899,7 +28899,7 @@ "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only." } }, - "description": "Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "description": "Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC" }, "CustomerTextFilter": { @@ -29052,7 +29052,7 @@ "DeleteCustomerCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/delete-customer-custom-attributeDefinition) request.", + "description": "Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/delete-customer-custom-attributeDefinition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie" @@ -29076,7 +29076,7 @@ "DeleteCustomerCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/delete-customer-custom-attribute) request.", + "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/delete-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie" @@ -29093,14 +29093,14 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/delete-customer-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/delete-customer-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": {} }, "DeleteCustomerGroupRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/delete-customer-group) endpoint.", + "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/delete-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -29117,7 +29117,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/delete-customer-group) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/delete-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -29197,7 +29197,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2022-10-19/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2022-10-19/invoices-api/list-invoices)." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2022-11-16/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2022-11-16/invoices-api/list-invoices)." } }, "description": "Describes a `DeleteInvoice` request.", @@ -29323,7 +29323,7 @@ "DeleteSubscriptionActionRequest": { "type": "object", "properties": {}, - "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/delete-subscription-action)\nendpoint.", + "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/delete-subscription-action)\nendpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -29342,7 +29342,7 @@ "description": "The subscription that has the specified action deleted." } }, - "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/delete-subscription-action)\nendpoint.", + "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/delete-subscription-action)\nendpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -29374,7 +29374,7 @@ "DeleteWebhookSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Deletes a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription).", + "description": "Deletes a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -29392,7 +29392,7 @@ "description": "Information on errors encountered during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/delete-webhook-subscription) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/delete-webhook-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -29792,7 +29792,7 @@ "description": "The retrieved card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](https://developer.squareup.com/reference/square_2022-10-19/cards-api/disable-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](https://developer.squareup.com/reference/square_2022-11-16/cards-api/disable-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -30000,7 +30000,7 @@ "description": "Data associated with the event." } }, - "description": "Published when evidence is added to a [Dispute](https://developer.squareup.com/reference/square_2022-10-19/objects/Dispute)\nfrom the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app,\nor by calling either [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2022-10-19/disputes-api/create-dispute-evidence-file) or [CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2022-10-19/disputes-api/create-dispute-evidence-text).", + "description": "Published when evidence is added to a [Dispute](https://developer.squareup.com/reference/square_2022-11-16/objects/Dispute)\nfrom the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app,\nor by calling either [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2022-11-16/disputes-api/create-dispute-evidence-file) or [CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2022-11-16/disputes-api/create-dispute-evidence-text).", "x-release-status": "PUBLIC", "example": { "merchant_id": "0HPGX5JYE6EE1", @@ -30910,7 +30910,7 @@ "GetPaymentRefundRequest": { "type": "object", "properties": {}, - "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/get-payment-refund).", + "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/get-payment-refund).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -30931,7 +30931,7 @@ "description": "The requested `PaymentRefund`." } }, - "description": "Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/get-payment-refund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", + "description": "Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/get-payment-refund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", "x-release-status": "PUBLIC", "example": { "refund": { @@ -30963,7 +30963,7 @@ "GetPaymentRequest": { "type": "object", "properties": {}, - "description": "Describes a request to retrieve a payment using \n[GetPayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/get-payment).", + "description": "Describes a request to retrieve a payment using \n[GetPayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/get-payment).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -30984,7 +30984,7 @@ "description": "The requested `Payment`." } }, - "description": "Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/get-payment).", + "description": "Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/get-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -31393,7 +31393,7 @@ "maxLength": 191, "type": "string" }, - "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) to whom this gift card is linked.", + "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) to whom this gift card is linked.", "x-read-only": true } }, @@ -31418,7 +31418,7 @@ }, "location_id": { "type": "string", - "description": "The ID of the [business location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the activity occurred." + "description": "The ID of the [business location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the activity occurred." }, "created_at": { "type": "string", @@ -31448,7 +31448,7 @@ }, "redeem_activity_details": { "$ref": "#/definitions/GiftCardActivityRedeem", - "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/create-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) to create the `REDEEM` activity." + "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/create-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) to create the `REDEEM` activity." }, "clear_balance_activity_details": { "$ref": "#/definitions/GiftCardActivityClearBalance", @@ -31468,7 +31468,7 @@ }, "refund_activity_details": { "$ref": "#/definitions/GiftCardActivityRefund", - "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that process payments using the Square Payments API, Square creates a `REFUND` activity that \nupdates the gift card balance after the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/refund-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) to create the `REFUND` activity." + "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that process payments using the Square Payments API, Square creates a `REFUND` activity that \nupdates the gift card balance after the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/refund-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) to create the `REFUND` activity." }, "unlinked_activity_refund_activity_details": { "$ref": "#/definitions/GiftCardActivityUnlinkedActivityRefund", @@ -31495,7 +31495,7 @@ "x-read-only": true } }, - "description": "Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", + "description": "Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", "x-release-status": "PUBLIC" }, "GiftCardActivityActivate": { @@ -31503,15 +31503,15 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "line_item_uid": { "type": "string", - "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "reference_id": { "type": "string", @@ -31522,10 +31522,10 @@ "items": { "type": "string" }, - "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." + "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." } }, - "description": "Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustDecrement": { @@ -31544,7 +31544,7 @@ "description": "The reason to decrease the gift card balance." } }, - "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustIncrement": { @@ -31563,7 +31563,7 @@ "description": "The reason to increase the balance." } }, - "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityBlock": { @@ -31577,7 +31577,7 @@ "description": "The reason to block the gift card." } }, - "description": "Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityClearBalance": { @@ -31591,7 +31591,7 @@ "description": "The reason to decrease the gift card balance." } }, - "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityDeactivate": { @@ -31605,7 +31605,7 @@ "description": "The reason to decrease the balance." } }, - "description": "Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityImport": { @@ -31619,7 +31619,7 @@ "description": "The balance amount on the imported gift card." } }, - "description": "Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", + "description": "Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", "x-release-status": "PUBLIC" }, "GiftCardActivityImportReversal": { @@ -31633,7 +31633,7 @@ "description": "The amount of money cleared from the third-party gift card when \nthe import was reversed." } }, - "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityLoad": { @@ -31641,15 +31641,15 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "line_item_uid": { "type": "string", - "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "reference_id": { "type": "string", @@ -31660,10 +31660,10 @@ "items": { "type": "string" }, - "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." + "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." } }, - "description": "Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityRedeem": { @@ -31674,7 +31674,7 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-10-19/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2022-11-16/gift-card-activities-api/create-gift-card-activity) request." }, "payment_id": { "type": "string", @@ -31691,7 +31691,7 @@ "x-read-only": true } }, - "description": "Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityRefund": { @@ -31699,7 +31699,7 @@ "properties": { "redeem_activity_id": { "type": "string", - "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/refund-payment) request \nrepresents a redemption made by the same gift card. Note that you must use `RefundPayment` \nto refund a gift card payment to the same gift card if the payment was processed by Square.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card." + "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/refund-payment) request \nrepresents a redemption made by the same gift card. Note that you must use `RefundPayment` \nto refund a gift card payment to the same gift card if the payment was processed by Square.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card." }, "amount_money": { "$ref": "#/definitions/Money", @@ -31715,7 +31715,7 @@ "x-read-only": true } }, - "description": "Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnblock": { @@ -31729,7 +31729,7 @@ "description": "The reason to unblock a gift card." } }, - "description": "Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnlinkedActivityRefund": { @@ -31752,7 +31752,7 @@ "x-read-only": true } }, - "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType).", + "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "InventoryAdjustment": { @@ -31770,26 +31770,26 @@ }, "from_state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2022-10-19/enums/InventoryState) of the related quantity\nof items before the adjustment." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2022-11-16/enums/InventoryState) of the related quantity\nof items before the adjustment." }, "to_state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2022-10-19/enums/InventoryState) of the related quantity\nof items after the adjustment." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2022-11-16/enums/InventoryState) of the related quantity\nof items after the adjustment." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the related\nquantity of items is being tracked." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "quantity": { "maxLength": 26, @@ -31820,23 +31820,23 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2022-10-19/objects/Employee) responsible for the\ninventory adjustment." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2022-11-16/objects/Employee) responsible for the\ninventory adjustment." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) responsible for the\ninventory adjustment." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) responsible for the\ninventory adjustment." }, "transaction_id": { "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2022-10-19/objects/Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", + "description": "The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2022-11-16/objects/Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", "x-read-only": true }, "refund_id": { "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2022-10-19/objects/Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", + "description": "The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2022-11-16/objects/Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", "x-read-only": true }, "purchase_order_id": { @@ -31897,7 +31897,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](https://developer.squareup.com/reference/square_2022-10-19/enums/InventoryChangeType) for all possible values." + "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](https://developer.squareup.com/reference/square_2022-11-16/enums/InventoryChangeType) for all possible values." }, "physical_count": { "$ref": "#/definitions/InventoryPhysicalCount", @@ -31909,20 +31909,20 @@ }, "transfer": { "$ref": "#/definitions/InventoryTransfer", - "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-change-inventory) endpoint when the seller has an active Retail Plus subscription." + "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-change-inventory) endpoint when the seller has an active Retail Plus subscription." }, "measurement_unit": { "$ref": "#/definitions/CatalogMeasurementUnit", - "description": "The [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "description": "The [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "x-read-only": true }, "measurement_unit_id": { "type": "string", - "description": "The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "description": "The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "x-read-only": true } }, - "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) instance.", + "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) instance.", "x-release-status": "PUBLIC" }, "InventoryCount": { @@ -31931,21 +31931,21 @@ "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "state": { "type": "string", - "description": "The current [inventory state](https://developer.squareup.com/reference/square_2022-10-19/enums/InventoryState) for the related\nquantity of items." + "description": "The current [inventory state](https://developer.squareup.com/reference/square_2022-11-16/enums/InventoryState) for the related\nquantity of items." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the related\nquantity of items is being tracked." }, "quantity": { "maxLength": 26, @@ -31960,7 +31960,7 @@ }, "is_estimated": { "type": "boolean", - "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-change-inventory),\n[BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-retrieve-inventory-changes),\n[BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/batch-retrieve-inventory-counts), and\n[RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-10-19/inventory-api/retrieve-inventory-changes).", + "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-change-inventory),\n[BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-retrieve-inventory-changes),\n[BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/batch-retrieve-inventory-counts), and\n[RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2022-11-16/inventory-api/retrieve-inventory-changes).", "x-release-status": "BETA", "x-is-beta": true, "x-read-only": true @@ -31975,31 +31975,31 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryPhysicalCount)." + "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryPhysicalCount)." }, "reference_id": { "maxLength": 255, "type": "string", - "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryPhysicalCount) to an external\nsystem." + "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryPhysicalCount) to an external\nsystem." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "state": { "type": "string", - "description": "The current [inventory state](https://developer.squareup.com/reference/square_2022-10-19/enums/InventoryState) for the related\nquantity of items." + "description": "The current [inventory state](https://developer.squareup.com/reference/square_2022-11-16/enums/InventoryState) for the related\nquantity of items." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the related\nquantity of items is being tracked." }, "quantity": { "maxLength": 26, @@ -32014,12 +32014,12 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2022-10-19/objects/Employee) responsible for the\nphysical count." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2022-11-16/objects/Employee) responsible for the\nphysical count." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) responsible for the\nphysical count." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) responsible for the\nphysical count." }, "occurred_at": { "maxLength": 34, @@ -32051,27 +32051,27 @@ }, "state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2022-10-19/enums/InventoryState) for the quantity of\nitems being transferred." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2022-11-16/enums/InventoryState) for the quantity of\nitems being transferred." }, "from_location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the related\nquantity of items was tracked before the transfer." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the related\nquantity of items was tracked before the transfer." }, "to_location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the related\nquantity of items was tracked after the transfer." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the related\nquantity of items was tracked after the transfer." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "quantity": { "maxLength": 26, @@ -32097,12 +32097,12 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2022-10-19/objects/Employee) responsible for the\ninventory transfer." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2022-11-16/objects/Employee) responsible for the\ninventory transfer." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) responsible for the\ninventory transfer." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) responsible for the\ninventory transfer." } }, "description": "Represents the transfer of a quantity of product inventory at a\nparticular time from one location to another.", @@ -32130,7 +32130,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/retrieve-order) endpoint using the order ID." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/retrieve-order) endpoint using the order ID." }, "primary_recipient": { "$ref": "#/definitions/InvoiceRecipient", @@ -32212,7 +32212,7 @@ }, "subscription_id": { "type": "string", - "description": "The ID of the [subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", + "description": "The ID of the [subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", "x-read-only": true }, "sale_or_service_date": { @@ -32253,7 +32253,7 @@ "description": "Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\n\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later)." } }, - "description": "The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) on the Square-hosted invoice payment page.", + "description": "The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) on the Square-hosted invoice payment page.", "x-release-status": "PUBLIC" }, "InvoiceCustomField": { @@ -32342,7 +32342,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice)." + "description": "The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice)." }, "request_method": { "type": "string", @@ -32378,7 +32378,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](https://developer.squareup.com/reference/square_2022-10-19/cards-api/list-cards) and include the `customer_id` of the invoice recipient." + "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](https://developer.squareup.com/reference/square_2022-11-16/cards-api/list-cards) and include the `customer_id` of the invoice recipient." }, "reminders": { "type": "array", @@ -32403,7 +32403,7 @@ "x-read-only": true } }, - "description": "Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", + "description": "Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC" }, "InvoiceQuery": { @@ -32934,7 +32934,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListCards](https://developer.squareup.com/reference/square_2022-10-19/cards-api/list-cards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListCards](https://developer.squareup.com/reference/square_2022-11-16/cards-api/list-cards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "cards": [ @@ -33181,12 +33181,12 @@ }, "types": { "type": "string", - "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2022-10-19/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2022-11-16/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." }, "catalog_version": { "type": "integer", "format": "int64", - "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical\nversions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical\nversions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true } @@ -33282,7 +33282,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?limit\u003d2" @@ -33310,7 +33310,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definitions": [ @@ -33357,10 +33357,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/list-customer-custom-attributes) request.", + "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/list-customer-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR" @@ -33388,7 +33388,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/list-customer-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/list-customer-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "PUBLIC", "example": { "custom_attributes": [ @@ -33425,7 +33425,7 @@ "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/list-customer-groups) endpoint.", + "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/list-customer-groups) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -33453,7 +33453,7 @@ "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint. This value is present only if the request\nsucceeded and additional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "groups": [ @@ -34040,7 +34040,7 @@ }, "type": { "type": "string", - "description": "If a [type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." + "description": "If a [type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." }, "location_id": { "type": "string", @@ -34149,11 +34149,11 @@ "properties": { "type": { "type": "string", - "description": "If a [type](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." + "description": "If a [type](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." }, "state": { "type": "string", - "description": "If a [state](https://developer.squareup.com/reference/square_2022-10-19/objects/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." + "description": "If a [state](https://developer.squareup.com/reference/square_2022-11-16/objects/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." }, "limit": { "maximum": 50, @@ -34428,7 +34428,7 @@ "ListLocationsRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in requests to the\n[ListLocations](https://developer.squareup.com/reference/square_2022-10-19/locations-api/list-locations) endpoint.", + "description": "Defines the fields that are included in requests to the\n[ListLocations](https://developer.squareup.com/reference/square_2022-11-16/locations-api/list-locations) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -34450,7 +34450,7 @@ "description": "The business locations." } }, - "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](https://developer.squareup.com/reference/square_2022-10-19/locations-api/list-locations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](https://developer.squareup.com/reference/square_2022-11-16/locations-api/list-locations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "locations": [ @@ -34614,7 +34614,7 @@ "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/list-loyalty-promotions) request.", + "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/list-loyalty-promotions) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -34643,7 +34643,7 @@ "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/list-loyalty-promotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", + "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/list-loyalty-promotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", "x-release-status": "PUBLIC", "example": { "loyalty_promotions": [ @@ -34715,7 +34715,7 @@ "description": "The cursor generated by the previous response." } }, - "description": "Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2022-10-19/merchants-api/list-merchants) endpoint.", + "description": "Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2022-11-16/merchants-api/list-merchants) endpoint.", "x-release-status": "PUBLIC" }, "ListMerchantsResponse": { @@ -34740,7 +34740,7 @@ "description": "If the response is truncated, the cursor to use in next request to fetch next set of objects." } }, - "description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2022-10-19/merchants-api/list-merchants) endpoint.", + "description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2022-11-16/merchants-api/list-merchants) endpoint.", "x-release-status": "PUBLIC", "example": { "merchant": [ @@ -34848,7 +34848,7 @@ }, "status": { "type": "string", - "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2022-10-19/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2022-11-16/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." }, "source_type": { "type": "string", @@ -34859,7 +34859,7 @@ "description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100" } }, - "description": "Describes a request to list refunds using\n[ListPaymentRefunds](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/list-payment-refunds).\n\nThe maximum results per page is 100.", + "description": "Describes a request to list refunds using\n[ListPaymentRefunds](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/list-payment-refunds).\n\nThe maximum results per page is 100.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -34887,7 +34887,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)." } }, - "description": "Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/list-payment-refunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", + "description": "Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/list-payment-refunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "refunds": [ @@ -34961,7 +34961,7 @@ "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`" } }, - "description": "Describes a request to list payments using \n[ListPayments](https://developer.squareup.com/reference/square_2022-10-19/payments-api/list-payments).\n\nThe maximum results per page is 100.", + "description": "Describes a request to list payments using \n[ListPayments](https://developer.squareup.com/reference/square_2022-11-16/payments-api/list-payments).\n\nThe maximum results per page is 100.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -34989,7 +34989,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)." } }, - "description": "Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2022-10-19/payments-api/list-payments).", + "description": "Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2022-11-16/payments-api/list-payments).", "x-release-status": "PUBLIC", "example": { "payments": [ @@ -35292,7 +35292,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/list-refunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2022-10-19/orders-api/search-orders)", + "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/list-refunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2022-11-16/orders-api/search-orders)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -35329,7 +35329,7 @@ "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -35428,7 +35428,7 @@ "description": "The upper limit on the number of subscription events to return\nin a paged response." } }, - "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/list-subscription-events)\nendpoint.", + "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/list-subscription-events)\nendpoint.", "x-release-status": "PUBLIC" }, "ListSubscriptionEventsResponse": { @@ -35453,7 +35453,7 @@ "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of events.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." } }, - "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/list-subscription-events).", + "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/list-subscription-events).", "x-release-status": "PUBLIC", "example": { "subscription_events": [ @@ -35681,7 +35681,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/list-transactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2022-10-19/orders-api/search-orders)", + "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/list-transactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2022-11-16/orders-api/search-orders)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -35718,7 +35718,7 @@ "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/list-transactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/list-transactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -35843,10 +35843,10 @@ "items": { "$ref": "#/definitions/EventTypeMetadata" }, - "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2022-10-19/objects/EventTypeMetadata)." + "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2022-11-16/objects/EventTypeMetadata)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/list-webhook-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/list-webhook-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35872,11 +35872,11 @@ }, "include_disabled": { "type": "boolean", - "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)s are returned." + "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)s are returned." }, "sort_order": { "type": "string", - "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." + "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." }, "limit": { "maximum": 100, @@ -35885,7 +35885,7 @@ "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100" } }, - "description": "Lists all [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)s owned by your application.", + "description": "Lists all [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)s owned by your application.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35907,14 +35907,14 @@ "items": { "$ref": "#/definitions/WebhookSubscription" }, - "description": "The requested list of [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)s." + "description": "The requested list of [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)s." }, "cursor": { "type": "string", "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/list-webhook-subscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/list-webhook-subscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -36019,7 +36019,7 @@ "items": { "type": "string" }, - "description": "The Square features that are enabled for the location.\nSee [LocationCapability](https://developer.squareup.com/reference/square_2022-10-19/enums/LocationCapability) for possible values.", + "description": "The Square features that are enabled for the location.\nSee [LocationCapability](https://developer.squareup.com/reference/square_2022-11-16/enums/LocationCapability) for possible values.", "x-read-only": true }, "status": { @@ -36041,7 +36041,7 @@ }, "country": { "type": "string", - "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](https://developer.squareup.com/reference/square_2022-10-19/enums/Country) for possible values.", + "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](https://developer.squareup.com/reference/square_2022-11-16/enums/Country) for possible values.", "x-read-only": true }, "language_code": { @@ -36052,7 +36052,7 @@ }, "currency": { "type": "string", - "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](https://developer.squareup.com/reference/square_2022-10-19/enums/Currency) for possible values.", + "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](https://developer.squareup.com/reference/square_2022-11-16/enums/Currency) for possible values.", "x-read-only": true }, "phone_number": { @@ -36160,7 +36160,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram) to which the account belongs." + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram) to which the account belongs." }, "balance": { "type": "integer", @@ -36175,7 +36175,7 @@ }, "customer_id": { "type": "string", - "description": "The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) that is associated with the account." + "description": "The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) that is associated with the account." }, "enrolled_at": { "type": "string", @@ -36203,7 +36203,7 @@ "description": "The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. \n\nThe total number of points in this field equals the number of points in the `balance` field." } }, - "description": "Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", + "description": "Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", "x-release-status": "PUBLIC" }, "LoyaltyAccountExpiringPointDeadline": { @@ -36304,12 +36304,12 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount) associated with the event.", + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount) associated with the event.", "x-read-only": true }, "location_id": { "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the event occurred.", + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the event occurred.", "x-read-only": true }, "source": { @@ -36342,7 +36342,7 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -36352,7 +36352,7 @@ }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders." } }, "description": "Provides metadata when the event `type` is `ACCUMULATE_POINTS`.", @@ -36368,14 +36368,14 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "loyalty_promotion_id": { "minLength": 1, "maxLength": 255, "type": "string", - "description": "The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion).", + "description": "The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion).", "x-read-only": true }, "points": { @@ -36386,7 +36386,7 @@ "order_id": { "minLength": 1, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", "x-read-only": true } }, @@ -36402,7 +36402,7 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -36428,13 +36428,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "points": { @@ -36472,13 +36472,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "points": { @@ -36502,7 +36502,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -36553,7 +36553,7 @@ "minLength": 1, "type": "string" }, - "description": "The [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." + "description": "The [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." } }, "description": "Filter events by location.", @@ -36568,7 +36568,7 @@ "loyalty_account_id": { "minLength": 1, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount) associated with loyalty events." + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount) associated with loyalty events." } }, "description": "Filter events by loyalty account.", @@ -36583,7 +36583,7 @@ "order_id": { "minLength": 1, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) associated with the event." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) associated with the event." } }, "description": "Filter events by the order associated with the event.", @@ -36600,7 +36600,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -36632,18 +36632,18 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", "x-read-only": true } }, @@ -36716,7 +36716,7 @@ "minLength": 1, "type": "string" }, - "description": "The [locations](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) at which the program is active.", + "description": "The [locations](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) at which the program is active.", "x-read-only": true }, "created_at": { @@ -36736,7 +36736,7 @@ "items": { "$ref": "#/definitions/LoyaltyProgramAccrualRule" }, - "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/list-loyalty-promotions).", + "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/list-loyalty-promotions).", "x-read-only": true } }, @@ -36781,7 +36781,7 @@ "x-read-only": true } }, - "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram).", + "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram).", "x-release-status": "PUBLIC" }, "LoyaltyProgramAccrualRuleCategoryData": { @@ -36793,7 +36793,7 @@ "category_id": { "minLength": 1, "type": "string", - "description": "The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) that buyers can purchase to earn\npoints.", + "description": "The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) that buyers can purchase to earn\npoints.", "x-read-only": true } }, @@ -36809,7 +36809,7 @@ "item_variation_id": { "minLength": 1, "type": "string", - "description": "The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject) that buyers can purchase to earn\npoints.", + "description": "The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject) that buyers can purchase to earn\npoints.", "x-read-only": true } }, @@ -36833,7 +36833,7 @@ "items": { "type": "string" }, - "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded categories.", + "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded categories.", "x-read-only": true }, "excluded_item_variation_ids": { @@ -36841,7 +36841,7 @@ "items": { "type": "string" }, - "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded item variations.", + "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded item variations.", "x-read-only": true }, "tax_mode": { @@ -36977,7 +36977,7 @@ }, "pricing_rule_reference": { "$ref": "#/definitions/CatalogObjectReference", - "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/retrieve-catalog-object) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).", + "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/retrieve-catalog-object) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).", "x-read-only": true } }, @@ -37062,7 +37062,7 @@ }, "loyalty_program_id": { "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram) associated with the promotion.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram) associated with the promotion.", "x-read-only": true }, "minimum_spend_amount_money": { @@ -37070,7 +37070,7 @@ "description": "The minimum purchase amount required to earn promotion points. If specified, this amount is positive." } }, - "description": "Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", + "description": "Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionAvailableTimeData": { @@ -37097,7 +37097,7 @@ "description": "A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)\n(`VEVENT`). Each event represents an available time period per day or days of the week. \nA day can have a maximum of one available time period.\n\nOnly `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and\ntimestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,\nan end date (using the `UNTIL` keyword), or both. For more information, see\n[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).\n\nNote that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request\nbut are always included in the response." } }, - "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion).", + "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentive": { @@ -37119,7 +37119,7 @@ "description": "Additional data for a `POINTS_ADDITION` incentive type." } }, - "description": "Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", + "description": "Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentivePointsAdditionData": { @@ -37134,7 +37134,7 @@ "description": "The number of additional points to earn each time the promotion is triggered. For example,\nsuppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also\nqualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer\nearns a total of 8 points (5 program points + 3 promotion points \u003d 8 points)." } }, - "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotionIncentive).", + "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentivePointsMultiplierData": { @@ -37150,7 +37150,7 @@ "description": "The multiplier used to calculate the number of points earned each time the promotion\nis triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program.\nIf the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier`\nof 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier \u003d 15 points)." } }, - "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotionIncentive).", + "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionTriggerLimit": { @@ -37170,7 +37170,7 @@ "description": "The time period the limit applies to." } }, - "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", + "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", "x-release-status": "PUBLIC" }, "LoyaltyReward": { @@ -37195,13 +37195,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount) to which the reward belongs." + "description": "The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount) to which the reward belongs." }, "reward_tier_id": { "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgramRewardTier) used to create the reward." + "description": "The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgramRewardTier) used to create the reward." }, "points": { "minimum": 1, @@ -37211,7 +37211,7 @@ }, "order_id": { "type": "string", - "description": "The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) to which the reward is attached." + "description": "The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) to which the reward is attached." }, "created_at": { "type": "string", @@ -37229,7 +37229,7 @@ "x-read-only": true } }, - "description": "Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", + "description": "Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", "x-release-status": "PUBLIC" }, "MeasurementUnit": { @@ -37343,7 +37343,7 @@ }, "currency": { "type": "string", - "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2022-10-19/enums/Currency) for possible values." + "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2022-11-16/enums/Currency) for possible values." } }, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", @@ -37545,7 +37545,7 @@ "customer_id": { "maxLength": 191, "type": "string", - "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) associated with the order.\n\n__IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions\nto be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the\n`customer_id` assigned to any underlying `Payment` objects is ignored and might result in the\ncreation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", + "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) associated with the order.\n\n__IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions\nto be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the\n`customer_id` assigned to any underlying `Payment` objects is ignored and might result in the\ncreation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "x-release-status": "BETA", "x-is-beta": true }, @@ -37656,7 +37656,7 @@ }, "closed_at": { "type": "string", - "description": "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2022-10-19/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", + "description": "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2022-11-16/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", "x-read-only": true }, "state": { @@ -37703,7 +37703,7 @@ }, "pricing_options": { "$ref": "#/definitions/OrderPricingOptions", - "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogPricingRule)." + "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogPricingRule)." }, "rewards": { "type": "array", @@ -37784,7 +37784,7 @@ "description": "The location ID the order belongs to." } }, - "description": "A lightweight description of an [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) that is returned when \n`returned_entries` is `true` on a [SearchOrdersRequest](https://developer.squareup.com/reference/square_2022-10-19/orders-api/search-orders).", + "description": "A lightweight description of an [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) that is returned when \n`returned_entries` is `true` on a [SearchOrdersRequest](https://developer.squareup.com/reference/square_2022-11-16/orders-api/search-orders).", "x-release-status": "PUBLIC" }, "OrderFulfillment": { @@ -38211,7 +38211,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) ID applied to this line item." + "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) ID applied to this line item." }, "catalog_version": { "type": "integer", @@ -38241,7 +38241,7 @@ "items": { "$ref": "#/definitions/OrderLineItemModifier" }, - "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier)s applied to this line item." + "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier)s applied to this line item." }, "applied_taxes": { "type": "array", @@ -38367,7 +38367,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogDiscount)." + "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogDiscount)." }, "catalog_version": { "type": "integer", @@ -38421,7 +38421,7 @@ }, "pricing_rule_id": { "type": "string", - "description": "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", + "description": "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "x-read-only": true } }, @@ -38441,7 +38441,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier)." + "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier)." }, "catalog_version": { "type": "integer", @@ -38459,7 +38459,7 @@ }, "base_price_money": { "$ref": "#/definitions/Money", - "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier) price." + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier) price." }, "total_price_money": { "$ref": "#/definitions/Money", @@ -38476,7 +38476,7 @@ "x-is-beta": true } }, - "description": "A [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier).", + "description": "A [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier).", "x-release-status": "PUBLIC" }, "OrderLineItemPricingBlocklists": { @@ -38560,7 +38560,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTax)." + "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTax)." }, "catalog_version": { "type": "integer", @@ -38651,7 +38651,7 @@ "x-is-beta": true } }, - "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogPricingRule).", + "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogPricingRule).", "x-release-status": "PUBLIC" }, "OrderQuantityUnit": { @@ -38659,7 +38659,7 @@ "properties": { "measurement_unit": { "$ref": "#/definitions/MeasurementUnit", - "description": "A [MeasurementUnit](https://developer.squareup.com/reference/square_2022-10-19/objects/MeasurementUnit) that represents the\nunit of measure for the quantity." + "description": "A [MeasurementUnit](https://developer.squareup.com/reference/square_2022-11-16/objects/MeasurementUnit) that represents the\nunit of measure for the quantity." }, "precision": { "type": "integer", @@ -38667,7 +38667,7 @@ }, "catalog_object_id": { "type": "string", - "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit." + "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit." }, "catalog_version": { "type": "integer", @@ -38748,7 +38748,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogDiscount)." + "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogDiscount)." }, "catalog_version": { "type": "integer", @@ -38825,7 +38825,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) ID applied to this return line item." + "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) ID applied to this return line item." }, "catalog_version": { "type": "integer", @@ -38846,7 +38846,7 @@ "items": { "$ref": "#/definitions/OrderReturnLineItemModifier" }, - "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier)s applied to this line item." + "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier)s applied to this line item." }, "applied_taxes": { "type": "array", @@ -38912,7 +38912,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier)." + "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier)." }, "catalog_version": { "type": "integer", @@ -38926,7 +38926,7 @@ }, "base_price_money": { "$ref": "#/definitions/Money", - "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogModifier) price." + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogModifier) price." }, "total_price_money": { "$ref": "#/definitions/Money", @@ -38961,7 +38961,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2022-10-19/objects/OrderServiceCharge)." + "description": "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2022-11-16/objects/OrderServiceCharge)." }, "catalog_version": { "type": "integer", @@ -39030,7 +39030,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogTax)." + "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogTax)." }, "catalog_version": { "type": "integer", @@ -39125,7 +39125,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)." + "description": "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)." }, "catalog_version": { "type": "integer", @@ -39274,7 +39274,7 @@ "description": "The user-provided reason to pause the subscription." } }, - "description": "Defines input parameters in a request to the\n[PauseSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/pause-subscription) endpoint.", + "description": "Defines input parameters in a request to the\n[PauseSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/pause-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -39300,7 +39300,7 @@ "description": "The list of a `PAUSE` action and a possible `RESUME` action created by the request." } }, - "description": "Defines output parameters in a response from the\n[PauseSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/pause-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[PauseSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/pause-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -39351,10 +39351,10 @@ "items": { "type": "string" }, - "description": "The IDs of the [payments](https://developer.squareup.com/reference/square_2022-10-19/objects/Payment) to collect.\nThe payment total must match the order total." + "description": "The IDs of the [payments](https://developer.squareup.com/reference/square_2022-11-16/objects/Payment) to collect.\nThe payment total must match the order total." } }, - "description": "Defines the fields that are included in requests to the\n[PayOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/pay-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[PayOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/pay-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -39379,10 +39379,10 @@ }, "order": { "$ref": "#/definitions/Order", - "description": "The paid, updated [order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order)." + "description": "The paid, updated [order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order)." } }, - "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/pay-order) endpoint.", + "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/pay-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -39683,7 +39683,7 @@ "team_member_id": { "maxLength": 192, "type": "string", - "description": "An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) associated with taking the payment.", + "description": "An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) associated with taking the payment.", "x-read-only": true }, "refund_ids": { @@ -40493,7 +40493,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." }, "idempotency_key": { "maxLength": 128, @@ -40672,7 +40672,7 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) where the reward is redeemed." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) where the reward is redeemed." } }, "description": "A request to redeem a loyalty reward.", @@ -40825,7 +40825,7 @@ }, "customer_id": { "type": "string", - "description": "The [Customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Customers\nAPI. Only allowed when `unlinked\u003dtrue`." + "description": "The [Customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Customers\nAPI. Only allowed when `unlinked\u003dtrue`." }, "reason": { "maxLength": 192, @@ -40841,10 +40841,10 @@ "team_member_id": { "maxLength": 192, "type": "string", - "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) ID to associate with this refund." + "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) ID to associate with this refund." } }, - "description": "Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/refund-payment).", + "description": "Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/refund-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -40877,7 +40877,7 @@ "description": "The successfully created `PaymentRefund`." } }, - "description": "Defines the response returned by\n[RefundPayment](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/refund-payment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", + "description": "Defines the response returned by\n[RefundPayment](https://developer.squareup.com/reference/square_2022-11-16/refunds-api/refund-payment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", "x-release-status": "PUBLIC", "example": { "refund": { @@ -40913,7 +40913,7 @@ "description": "A domain name as described in RFC-1034 that will be registered with ApplePay." } }, - "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2022-10-19/apple-pay-api/register-domain) endpoint.", + "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2022-11-16/apple-pay-api/register-domain) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -40941,10 +40941,10 @@ }, "status": { "type": "string", - "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2022-10-19/enums/RegisterDomainResponseStatus) for possible values." + "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2022-11-16/enums/RegisterDomainResponseStatus) for possible values." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2022-10-19/apple-pay-api/register-domain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2022-11-16/apple-pay-api/register-domain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "status": "VERIFIED" @@ -40961,7 +40961,7 @@ "RemoveGroupFromCustomerRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2022-10-19/customers-api/remove-group-from-customer) endpoint.", + "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2022-11-16/customers-api/remove-group-from-customer) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -40978,7 +40978,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2022-10-19/customers-api/remove-group-from-customer)\nendpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2022-11-16/customers-api/remove-group-from-customer)\nendpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -41086,7 +41086,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the\n[ResumeSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/resume-subscription) endpoint.", + "description": "Defines input parameters in a request to the\n[ResumeSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/resume-subscription) endpoint.", "x-release-status": "PUBLIC" }, "ResumeSubscriptionResponse": { @@ -41113,7 +41113,7 @@ "x-is-beta": true } }, - "description": "Defines output parameters in a response from the \n[ResumeSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/resume-subscription) endpoint.", + "description": "Defines output parameters in a response from the \n[ResumeSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/resume-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -41263,7 +41263,7 @@ "description": "The retrieved card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](https://developer.squareup.com/reference/square_2022-10-19/cards-api/retrieve-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](https://developer.squareup.com/reference/square_2022-11-16/cards-api/retrieve-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -41383,7 +41383,7 @@ "catalog_version": { "type": "integer", "format": "int64", - "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true } @@ -41509,7 +41509,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/retrieve-customer-custom-attribute-definition) request.", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/retrieve-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie" @@ -41530,7 +41530,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/retrieve-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/retrieve-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -41552,14 +41552,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-10-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2022-11-16/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.", + "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie" @@ -41580,7 +41580,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/retrieve-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/retrieve-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -41596,7 +41596,7 @@ "RetrieveCustomerGroupRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/retrieve-customer-group) endpoint.", + "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/retrieve-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -41617,7 +41617,7 @@ "description": "The retrieved customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/retrieve-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/retrieve-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -42023,7 +42023,7 @@ }, "adjustment": { "$ref": "#/definitions/InventoryAdjustment", - "description": "The requested [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryAdjustment)." + "description": "The requested [InventoryAdjustment](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryAdjustment)." } }, "description": "", @@ -42059,7 +42059,7 @@ "properties": { "location_ids": { "type": "string", - "description": "The [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." + "description": "The [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, "cursor": { "type": "string", @@ -42141,7 +42141,7 @@ "properties": { "location_ids": { "type": "string", - "description": "The [Location](https://developer.squareup.com/reference/square_2022-10-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." + "description": "The [Location](https://developer.squareup.com/reference/square_2022-11-16/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, "cursor": { "type": "string", @@ -42227,7 +42227,7 @@ }, "count": { "$ref": "#/definitions/InventoryPhysicalCount", - "description": "The requested [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryPhysicalCount)." + "description": "The requested [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryPhysicalCount)." } }, "description": "", @@ -42281,7 +42281,7 @@ }, "transfer": { "$ref": "#/definitions/InventoryTransfer", - "description": "The requested [InventoryTransfer](https://developer.squareup.com/reference/square_2022-10-19/objects/InventoryTransfer)." + "description": "The requested [InventoryTransfer](https://developer.squareup.com/reference/square_2022-11-16/objects/InventoryTransfer)." } }, "description": "", @@ -42312,7 +42312,7 @@ "RetrieveLocationRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](https://developer.squareup.com/reference/square_2022-10-19/locations-api/retrieve-location) endpoint.", + "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](https://developer.squareup.com/reference/square_2022-11-16/locations-api/retrieve-location) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -42331,7 +42331,7 @@ "description": "The requested location." } }, - "description": "Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2022-10-19/locations-api/retrieve-location)\nendpoint returns in a response.", + "description": "Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2022-11-16/locations-api/retrieve-location)\nendpoint returns in a response.", "x-release-status": "PUBLIC", "example": { "location": { @@ -42405,7 +42405,7 @@ "RetrieveLoyaltyProgramRequest": { "type": "object", "properties": {}, - "description": "A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", + "description": "A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dmain" @@ -42485,7 +42485,7 @@ "RetrieveLoyaltyPromotionRequest": { "type": "object", "properties": {}, - "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-promotion) request.", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id\u003dloypromo_f0f9b849-725e-378d-b810-511237e07b67", @@ -42507,7 +42507,7 @@ "description": "The retrieved loyalty promotion." } }, - "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2022-10-19/loyalty-api/retrieve-loyalty-promotion) response.", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2022-11-16/loyalty-api/retrieve-loyalty-promotion) response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -42578,7 +42578,7 @@ "RetrieveMerchantRequest": { "type": "object", "properties": {}, - "description": "Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2022-10-19/merchants-api/retrieve-merchant) endpoint.", + "description": "Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2022-11-16/merchants-api/retrieve-merchant) endpoint.", "x-release-status": "PUBLIC" }, "RetrieveMerchantResponse": { @@ -42596,7 +42596,7 @@ "description": "The requested `Merchant` object." } }, - "description": "The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2022-10-19/merchants-api/retrieve-merchant) endpoint.", + "description": "The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2022-11-16/merchants-api/retrieve-merchant) endpoint.", "x-release-status": "PUBLIC", "example": { "merchant": { @@ -42860,7 +42860,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/retrieve-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/retrieve-subscription) endpoint.", "x-release-status": "PUBLIC" }, "RetrieveSubscriptionResponse": { @@ -42878,7 +42878,7 @@ "description": "The subscription retrieved." } }, - "description": "Defines output parameters in a response from the\n[RetrieveSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/retrieve-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[RetrieveSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/retrieve-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -43017,7 +43017,7 @@ "description": "The requested transaction." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/retrieve-transaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/retrieve-transaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -43077,7 +43077,7 @@ "RetrieveVendorRequest": { "type": "object", "properties": {}, - "description": "Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/retrieve-vendor).", + "description": "Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/retrieve-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -43094,10 +43094,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) object." + "description": "The successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) object." } }, - "description": "Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/retrieve-vendor).", + "description": "Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/retrieve-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -43184,7 +43184,7 @@ "RetrieveWebhookSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Retrieves a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) using its id.", + "description": "Retrieves a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) using its id.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -43203,10 +43203,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The requested [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)." + "description": "The requested [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -43716,10 +43716,10 @@ "items": { "$ref": "#/definitions/CustomAttributeFilter" }, - "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-items) endpoint." + "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-items) endpoint." } }, - "description": "Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-items) endpoint.", + "description": "Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-items) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -43792,7 +43792,7 @@ "description": "Ids of returned item variations matching the specified query expression." } }, - "description": "Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-10-19/catalog-api/search-catalog-items) endpoint.", + "description": "Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2022-11-16/catalog-api/search-catalog-items) endpoint.", "x-release-status": "PUBLIC", "example": { "items": [ @@ -44667,7 +44667,7 @@ "loyalty_account_id": { "minLength": 1, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-10-19/objects/LoyaltyAccount) to which the loyalty reward belongs." + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2022-11-16/objects/LoyaltyAccount) to which the loyalty reward belongs." }, "status": { "type": "string", @@ -44758,7 +44758,7 @@ "description": "A list of customer IDs to filter by.\n\nMax: 10 customer IDs." } }, - "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](https://developer.squareup.com/reference/square_2022-10-19/objects/FulfillmentRecipient) `customer_id`.", + "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](https://developer.squareup.com/reference/square_2022-11-16/objects/FulfillmentRecipient) `customer_id`.", "x-release-status": "BETA", "x-is-beta": true }, @@ -44778,7 +44778,7 @@ "description": "The time range for filtering on the `closed_at` timestamp. If you use this\nvalue, you must set the `sort_field` in the `OrdersSearchSort` object to\n`CLOSED_AT`." } }, - "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2022-10-19/objects/SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range)", + "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2022-11-16/objects/SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range)", "x-release-status": "PUBLIC" }, "SearchOrdersFilter": { @@ -44786,7 +44786,7 @@ "properties": { "state_filter": { "$ref": "#/definitions/SearchOrdersStateFilter", - "description": "Filter by [OrderState](https://developer.squareup.com/reference/square_2022-10-19/enums/OrderState)." + "description": "Filter by [OrderState](https://developer.squareup.com/reference/square_2022-11-16/enums/OrderState)." }, "date_time_filter": { "$ref": "#/definitions/SearchOrdersDateTimeFilter", @@ -44818,17 +44818,17 @@ "items": { "type": "string" }, - "description": "A list of [fulfillment types](https://developer.squareup.com/reference/square_2022-10-19/enums/FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field." + "description": "A list of [fulfillment types](https://developer.squareup.com/reference/square_2022-11-16/enums/FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field." }, "fulfillment_states": { "type": "array", "items": { "type": "string" }, - "description": "A list of [fulfillment states](https://developer.squareup.com/reference/square_2022-10-19/enums/FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field." + "description": "A list of [fulfillment states](https://developer.squareup.com/reference/square_2022-11-16/enums/FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field." } }, - "description": "Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2022-10-19/objects/Fulfillment) information.", + "description": "Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2022-11-16/objects/Fulfillment) information.", "x-release-status": "PUBLIC" }, "SearchOrdersQuery": { @@ -44871,7 +44871,7 @@ }, "return_entries": { "type": "boolean", - "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2022-10-19/objects/OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." + "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2022-11-16/objects/OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." } }, "description": "The request does not have any required fields. When given no query criteria,\n`SearchOrders` returns all results for all of the seller\u0027s locations. When retrieving additional\npages using a `cursor`, the `query` must be equal to the `query` used to retrieve the first page of\nresults.", @@ -44914,14 +44914,14 @@ "items": { "$ref": "#/definitions/OrderEntry" }, - "description": "A list of [OrderEntries](https://developer.squareup.com/reference/square_2022-10-19/objects/OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." + "description": "A list of [OrderEntries](https://developer.squareup.com/reference/square_2022-11-16/objects/OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." }, "orders": { "type": "array", "items": { "$ref": "#/definitions/Order" }, - "description": "A list of\n[Order](https://developer.squareup.com/reference/square_2022-10-19/objects/Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." + "description": "A list of\n[Order](https://developer.squareup.com/reference/square_2022-11-16/objects/Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." }, "cursor": { "type": "string", @@ -44932,10 +44932,10 @@ "items": { "$ref": "#/definitions/Error" }, - "description": "[Errors](https://developer.squareup.com/reference/square_2022-10-19/objects/Error) encountered during the search." + "description": "[Errors](https://developer.squareup.com/reference/square_2022-11-16/objects/Error) encountered during the search." } }, - "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](https://developer.squareup.com/reference/square_2022-10-19/orders-api/search-orders).", + "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](https://developer.squareup.com/reference/square_2022-11-16/orders-api/search-orders).", "x-release-status": "PUBLIC", "example": { "order_entries": [ @@ -44964,7 +44964,7 @@ "properties": { "sort_field": { "type": "string", - "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2022-10-19/objects/SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`." + "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2022-11-16/objects/SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`." }, "sort_order": { "type": "string", @@ -44982,7 +44982,7 @@ "items": { "type": "string" }, - "description": "Filters by the [Source](https://developer.squareup.com/reference/square_2022-10-19/objects/OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names." + "description": "Filters by the [Source](https://developer.squareup.com/reference/square_2022-11-16/objects/OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names." } }, "description": "A filter based on order `source` information.", @@ -45170,7 +45170,7 @@ "x-is-beta": true } }, - "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/search-subscriptions) endpoint.", + "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC" }, "SearchSubscriptionsQuery": { @@ -45210,7 +45210,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/search-subscriptions) endpoint.", + "description": "Defines input parameters in a request to the \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -45252,7 +45252,7 @@ "description": "When the total number of resulting subscription exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." } }, - "description": "Defines output parameters in a response from the\n[SearchSubscriptions](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/search-subscriptions) endpoint.", + "description": "Defines output parameters in a response from the\n[SearchSubscriptions](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC", "example": { "subscriptions": [ @@ -45857,7 +45857,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } }, - "description": "Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/search-vendors).", + "description": "Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -45889,14 +45889,14 @@ "maxLength": 100, "type": "string" }, - "description": "The names of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects to retrieve." + "description": "The names of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects to retrieve." }, "status": { "type": "array", "items": { "type": "string" }, - "description": "The statuses of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects to retrieve." + "description": "The statuses of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects to retrieve." } }, "description": "Defines supported query expressions to search for vendors by.", @@ -45915,7 +45915,7 @@ "description": "Specifies the sort order for the returned vendors." } }, - "description": "Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/search-vendors).", + "description": "Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true }, @@ -45934,14 +45934,14 @@ "items": { "$ref": "#/definitions/Vendor" }, - "description": "The [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) objects matching the specified search filter." + "description": "The [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) objects matching the specified search filter." }, "cursor": { "type": "string", "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } }, - "description": "Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/search-vendors).", + "description": "Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -45986,7 +45986,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogItemVariation) object representing the service booked in this segment." + "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogItemVariation) object representing the service booked in this segment." }, "team_member_id_filter": { "$ref": "#/definitions/FilterValue", @@ -46296,11 +46296,11 @@ "properties": { "product": { "type": "string", - "description": "__Read only__ The [product](https://developer.squareup.com/reference/square_2022-10-19/enums/Product) type of the application." + "description": "__Read only__ The [product](https://developer.squareup.com/reference/square_2022-11-16/enums/Product) type of the application." }, "application_id": { "type": "string", - "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](https://developer.squareup.com/reference/square_2022-10-19/enums/Product) type is `EXTERNAL_API`." + "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](https://developer.squareup.com/reference/square_2022-11-16/enums/Product) type is `EXTERNAL_API`." }, "name": { "type": "string", @@ -46412,12 +46412,12 @@ }, "plan_id": { "type": "string", - "description": "The ID of the subscribed-to [subscription plan](https://developer.squareup.com/reference/square_2022-10-19/objects/CatalogSubscriptionPlan).", + "description": "The ID of the subscribed-to [subscription plan](https://developer.squareup.com/reference/square_2022-11-16/objects/CatalogSubscriptionPlan).", "x-read-only": true }, "customer_id": { "type": "string", - "description": "The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) profile.", + "description": "The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) profile.", "x-read-only": true }, "start_date": { @@ -46448,7 +46448,7 @@ "items": { "type": "string" }, - "description": "The IDs of the [invoices](https://developer.squareup.com/reference/square_2022-10-19/objects/Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", + "description": "The IDs of the [invoices](https://developer.squareup.com/reference/square_2022-11-16/objects/Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", "x-read-only": true }, "price_override_money": { @@ -46467,7 +46467,7 @@ }, "card_id": { "type": "string", - "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2022-10-19/objects/Customer) [card](https://developer.squareup.com/reference/square_2022-10-19/objects/Card)\nused to charge for the subscription." + "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2022-11-16/objects/Customer) [card](https://developer.squareup.com/reference/square_2022-11-16/objects/Card)\nused to charge for the subscription." }, "timezone": { "type": "string", @@ -46485,7 +46485,7 @@ "items": { "$ref": "#/definitions/SubscriptionAction" }, - "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/retrieve-subscription) with the query parameter\nof `include\u003dactions` or from \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/search-subscriptions) with the input parameter \nof `include:[\"actions\"]`.", + "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/retrieve-subscription) with the query parameter\nof `include\u003dactions` or from \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/search-subscriptions) with the input parameter \nof `include:[\"actions\"]`.", "x-release-status": "BETA", "x-is-beta": true } @@ -46655,7 +46655,7 @@ "x-read-only": true } }, - "description": "Defines input parameters in a call to the \n[SwapPlan](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/swap-plan) endpoint.", + "description": "Defines input parameters in a call to the \n[SwapPlan](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -46681,7 +46681,7 @@ "description": "A list of a `SWAP_PLAN` action created by the request." } }, - "description": "Defines output parameters in a response of the \n[SwapPlan](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/swap-plan) endpoint.", + "description": "Defines output parameters in a response of the \n[SwapPlan](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -46816,7 +46816,7 @@ "minLength": 0, "maxLength": 32, "type": "string", - "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2022-10-19/objects/TeamMember) object for the team member associated with the booking profile.", + "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2022-11-16/objects/TeamMember) object for the team member associated with the booking profile.", "x-read-only": true }, "description": { @@ -46905,7 +46905,7 @@ }, "amount_money": { "$ref": "#/definitions/Money", - "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](https://developer.squareup.com/reference/square_2022-10-19/objects/Payment) will be equal to the\n`amount_money` of the tender." + "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](https://developer.squareup.com/reference/square_2022-11-16/objects/Payment) will be equal to the\n`amount_money` of the tender." }, "tip_money": { "$ref": "#/definitions/Money", @@ -46944,7 +46944,7 @@ "payment_id": { "maxLength": 192, "type": "string", - "description": "The ID of the [Payment](https://developer.squareup.com/reference/square_2022-10-19/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." + "description": "The ID of the [Payment](https://developer.squareup.com/reference/square_2022-11-16/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." } }, "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", @@ -46955,7 +46955,7 @@ "properties": { "status": { "type": "string", - "description": "The credit card payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2022-10-19/enums/TenderCardDetailsStatus)\nfor possible values." + "description": "The credit card payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2022-11-16/enums/TenderCardDetailsStatus)\nfor possible values." }, "card": { "$ref": "#/definitions/Card", @@ -47388,10 +47388,10 @@ "properties": { "event_type": { "type": "string", - "description": "The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)." + "description": "The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)." } }, - "description": "Tests a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) by sending a test event to its notification URL.", + "description": "Tests a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) by sending a test event to its notification URL.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -47413,10 +47413,10 @@ }, "subscription_test_result": { "$ref": "#/definitions/SubscriptionTestResult", - "description": "The [SubscriptionTestResult](https://developer.squareup.com/reference/square_2022-10-19/objects/SubscriptionTestResult)." + "description": "The [SubscriptionTestResult](https://developer.squareup.com/reference/square_2022-11-16/objects/SubscriptionTestResult)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/test-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](https://developer.squareup.com/reference/square_2022-10-19/objects/SubscriptionTestResult) field is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/test-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](https://developer.squareup.com/reference/square_2022-11-16/objects/SubscriptionTestResult) field is not\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -47509,7 +47509,7 @@ "reference_id": { "maxLength": 40, "type": "string", - "description": "If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set." + "description": "If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set." }, "product": { "type": "string", @@ -47726,7 +47726,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie", @@ -47753,7 +47753,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/update-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/update-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -47781,7 +47781,7 @@ "description": "The `CustomerGroup` object including all the updates you want to make." } }, - "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/update-customer-group) endpoint.", + "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/update-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -47806,7 +47806,7 @@ "description": "The successfully updated customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2022-10-19/customer-groups-api/update-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2022-11-16/customer-groups-api/update-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -48243,7 +48243,7 @@ "description": "The `Location` object with only the fields to update." } }, - "description": "The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2022-10-19/locations-api/update-location) endpoint.", + "description": "The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2022-11-16/locations-api/update-location) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -48287,7 +48287,7 @@ "description": "The updated `Location` object." } }, - "description": "The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2022-10-19/locations-api/update-location) endpoint.", + "description": "The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2022-11-16/locations-api/update-location) endpoint.", "x-release-status": "PUBLIC", "example": { "location": { @@ -48359,7 +48359,7 @@ "description": "A value you specify that uniquely identifies this update request.\n\nIf you are unsure whether a particular update was applied to an order successfully,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate updates to the order.\nThe latest order version is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency)." } }, - "description": "Defines the fields that are included in requests to the\n[UpdateOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/update-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[UpdateOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/update-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -48400,7 +48400,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](https://developer.squareup.com/reference/square_2022-10-19/orders-api/update-order) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](https://developer.squareup.com/reference/square_2022-11-16/orders-api/update-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -48584,7 +48584,7 @@ "description": "A unique string that identifies this `UpdatePayment` request. Keys can be any valid string\nbut must be unique for every `UpdatePayment` request.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency)." } }, - "description": "Describes a request to update a payment using \n[UpdatePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/update-payment).", + "description": "Describes a request to update a payment using \n[UpdatePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/update-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -48618,7 +48618,7 @@ "description": "The updated payment." } }, - "description": "Defines the response returned by \n[UpdatePayment](https://developer.squareup.com/reference/square_2022-10-19/payments-api/update-payment).", + "description": "Defines the response returned by \n[UpdatePayment](https://developer.squareup.com/reference/square_2022-11-16/payments-api/update-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -48792,7 +48792,7 @@ "description": "The subscription object containing the current version, and fields to update.\nUnset fields will be left at their current server values, and JSON `null` values will\nbe treated as a request to clear the relevant data." } }, - "description": "Defines input parameters in a request to the \n[UpdateSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/update-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[UpdateSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/update-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -48822,7 +48822,7 @@ "description": "The updated subscription." } }, - "description": "Defines output parameters in a response from the\n[UpdateSubscription](https://developer.squareup.com/reference/square_2022-10-19/subscriptions-api/update-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[UpdateSubscription](https://developer.squareup.com/reference/square_2022-11-16/subscriptions-api/update-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -48926,10 +48926,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The specified [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) to be updated." + "description": "The specified [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) to be updated." } }, - "description": "Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/update-vendor).", + "description": "Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/update-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -48956,10 +48956,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) that has been updated." + "description": "The [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) that has been updated." } }, - "description": "Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2022-10-19/vendors-api/update-vendor).", + "description": "Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2022-11-16/vendors-api/update-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -49087,10 +49087,10 @@ "properties": { "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) to update." + "description": "The [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) to update." } }, - "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription).", + "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -49115,10 +49115,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The updated [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription)." + "description": "The updated [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/update-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/update-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) is not\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -49143,10 +49143,10 @@ "idempotency_key": { "maxLength": 45, "type": "string", - "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request." + "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request." } }, - "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) by replacing the existing signature key with a new one.", + "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) by replacing the existing signature key with a new one.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -49172,7 +49172,7 @@ "x-read-only": true } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2022-10-19/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-10-19/objects/WebhookSubscription) is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2022-11-16/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2022-11-16/objects/WebhookSubscription) is not\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -49413,7 +49413,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/upsert-customer-custom-attribute) request.", + "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/upsert-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie", @@ -49439,7 +49439,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-10-19/customer-custom-attributes-api/upsert-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2022-11-16/customer-custom-attributes-api/upsert-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -50504,49 +50504,49 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor).\nThis field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor).\nThis field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "created_at": { "maxLength": 34, "type": "string", - "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) was created.", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) was created.", "x-read-only": true }, "updated_at": { "maxLength": 34, "type": "string", - "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor) was last updated.", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor) was last updated.", "x-read-only": true }, "name": { "maxLength": 100, "type": "string", - "description": "The name of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor).\nThis field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "The name of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor).\nThis field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "address": { "$ref": "#/definitions/Address", - "description": "The address of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "The address of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/VendorContact" }, - "description": "The contacts of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "The contacts of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "account_number": { "maxLength": 100, "type": "string", - "description": "The account number of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "The account number of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "note": { "maxLength": 4096, "type": "string", - "description": "A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "version": { "type": "integer", - "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "status": { "$ref": "#/definitions/VendorStatus", @@ -50566,33 +50566,33 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact).\nThis field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact)." + "description": "A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact).\nThis field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact)." }, "name": { "maxLength": 255, "type": "string", - "description": "The name of the [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact).\nThis field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor)." + "description": "The name of the [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact).\nThis field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor)." }, "email_address": { "maxLength": 255, "type": "string", - "description": "The email address of the [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact)." + "description": "The email address of the [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact)." }, "phone_number": { "maxLength": 255, "type": "string", - "description": "The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact)." + "description": "The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact)." }, "removed": { "type": "boolean", - "description": "The state of the [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact)." + "description": "The state of the [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact)." }, "ordinal": { "type": "integer", - "description": "The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2022-10-19/objects/VendorContact)." + "description": "The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2022-11-16/objects/VendorContact)." } }, - "description": "Represents a contact of a [Vendor](https://developer.squareup.com/reference/square_2022-10-19/objects/Vendor).", + "description": "Represents a contact of a [Vendor](https://developer.squareup.com/reference/square_2022-11-16/objects/Vendor).", "x-release-status": "BETA", "x-is-beta": true }, @@ -50623,7 +50623,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](https://developer.squareup.com/reference/square_2022-10-19/transactions-api/void-transaction) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](https://developer.squareup.com/reference/square_2022-11-16/transactions-api/void-transaction) endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": {}, From 34c6515dae259b06dd7c83b9dcdd0c3174fd9954 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Fri, 2 Dec 2022 17:11:58 -0700 Subject: [PATCH 11/19] things I had to do to fix ultimate compile (some codables) and change version_token to version on Payment object --- api.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api.json b/api.json index e263910..bf029a4 100644 --- a/api.json +++ b/api.json @@ -22151,7 +22151,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/DeleteCustomAttribute" + "$ref": "#/definitions/AnyCodable" }, "description": "A map of requests that correspond to individual delete operations for custom attributes." } @@ -22696,7 +22696,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/CustomerCustomAttributeUpsertRequest" + "$ref": "#/definitions/AnyCodable" }, "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } @@ -22776,7 +22776,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/CustomerCustomAttributeUpsertResponse" + "$ref": "#/definitions/AnyCodable" }, "description": "A map of responses that correspond to individual upsert requests. Each response has the\nsame ID as the corresponding request and contains either a `customer_id` and `custom_attribute` or an `errors` field." }, @@ -22892,7 +22892,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/UpsertCustomAttribute" + "$ref": "#/definitions/AnyCodable" }, "description": "A map of requests that correspond to individual upsert operations for custom attributes." } @@ -31472,7 +31472,7 @@ "type": "object", "properties": { "card_details": { - "$ref": "#/definitions/CardRefundDetails", + "$ref": "#/definitions/AnyCodable", "description": "Details about a card refund. Only populated if the destination_type is `CARD`." } }, @@ -42410,8 +42410,8 @@ "description": "Details about the application that took the payment.", "x-read-only": true }, - "version_token": { - "type": "string", + "version": { + "type": "integer", "description": "Used for optimistic concurrency. This opaque token identifies a specific version of the\n`Payment` object." } }, From 60b745ed9af419fe44c18aad24198577b108a780 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Mon, 30 Jan 2023 15:28:44 -0700 Subject: [PATCH 12/19] four name corrections --- api.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api.json b/api.json index 6d5ffeb..5a83e0b 100644 --- a/api.json +++ b/api.json @@ -22772,7 +22772,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/LocationCustomAttributeDeleteRequest" + "$ref": "#/definitions/DeleteLocationCustomAttributeRequest" }, "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." } @@ -22822,7 +22822,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/LocationCustomAttributeDeleteResponse" + "$ref": "#/definitions/DeleteLocationCustomAttributeResponse" }, "description": "A map of responses that correspond to individual delete requests. Each response has the\nsame key as the corresponding request." }, @@ -23622,7 +23622,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/LocationCustomAttributeUpsertRequest" + "$ref": "#/definitions/UpsertLocationCustomAttributeRequest" }, "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } @@ -23690,7 +23690,7 @@ "values": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/LocationCustomAttributeUpsertResponse" + "$ref": "#/definitions/UpsertLocationCustomAttributeResponse" }, "description": "A map of responses that correspond to individual upsert requests. Each response has the\nsame ID as the corresponding request and contains either a `location_id` and `custom_attribute` or an `errors` field." }, From 8fa6212acfbef87a42eba6ffe219c2333f8d33fa Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Wed, 3 Jan 2024 11:50:01 -0700 Subject: [PATCH 13/19] a bunch of syntax fixes for api.json (mostly missing prefixes) --- api.json | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/api.json b/api.json index b4d3591..03ee4bf 100644 --- a/api.json +++ b/api.json @@ -29959,20 +29959,20 @@ "policies": { "type": "array", "items": { - "$ref": "#/definitions/Policy" + "$ref": "#/definitions/CheckoutLocationSettingsPolicy" }, "description": "Policy information is displayed at the bottom of the checkout pages.\nYou can set a maximum of two policies." }, "branding": { - "$ref": "#/definitions/Branding", + "$ref": "#/definitions/CheckoutLocationSettingsBranding", "description": "The branding settings for this location." }, "tipping": { - "$ref": "#/definitions/Tipping", + "$ref": "#/definitions/CheckoutLocationSettingsTipping", "description": "The tip settings for this location." }, "coupons": { - "$ref": "#/definitions/Coupons", + "$ref": "#/definitions/CheckoutLocationSettingsCoupons", "description": "The coupon settings for this location." }, "updated_at": { @@ -30081,7 +30081,7 @@ "type": "object", "properties": { "payment_methods": { - "$ref": "#/definitions/PaymentMethods", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethods", "description": "The set of payment methods accepted for the merchant\u0027s account." }, "updated_at": { @@ -30098,19 +30098,19 @@ "type": "object", "properties": { "apple_pay": { - "$ref": "#/definitions/PaymentMethod", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethodsPaymentMethod", "description": "" }, "google_pay": { - "$ref": "#/definitions/PaymentMethod", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethodsPaymentMethod", "description": "" }, "cash_app": { - "$ref": "#/definitions/PaymentMethod", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethodsPaymentMethod", "description": "" }, "afterpay_clearpay": { - "$ref": "#/definitions/AfterpayClearpay", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay", "description": "" } }, @@ -30122,11 +30122,11 @@ "type": "object", "properties": { "order_eligibility_range": { - "$ref": "#/definitions/EligibilityRange", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange", "description": "Afterpay is shown as an option for order totals falling within the configured range." }, "item_eligibility_range": { - "$ref": "#/definitions/EligibilityRange", + "$ref": "#/definitions/CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange", "description": "Afterpay is shown as an option for item totals falling within the configured range." }, "enabled": { @@ -35884,7 +35884,7 @@ "description": "The battery charge percentage as displayed on the device." }, "external_power": { - "$ref": "#/definitions/ExternalPower", + "$ref": "#/definitions/DeviceComponentDetailsExternalPower", "description": "The status of external_power." } }, @@ -35964,7 +35964,7 @@ "description": "The security protocol for a secure connection (e.g. WPA2). None provided if the connection\nis unsecured." }, "signal_strength": { - "$ref": "#/definitions/Measurement", + "$ref": "#/definitions/DeviceComponentDetailsMeasurement", "description": "A representation of signal strength of the WIFI network connection." } }, From 88c18c4e5f2a4481f906d9a2cb834f51086fc88f Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Thu, 18 Jan 2024 14:13:02 -0700 Subject: [PATCH 14/19] changed date to minimize noise when merging new version --- api.json | 2162 +++++++++++++++++++++++++++--------------------------- 1 file changed, 1081 insertions(+), 1081 deletions(-) diff --git a/api.json b/api.json index 03ee4bf..0ee8d09 100644 --- a/api.json +++ b/api.json @@ -110,7 +110,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE_IN_PERSON" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -149,7 +149,7 @@ "description": "`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see\n[Migrate from Renew to Refresh OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).\n\nRenews an OAuth access token before it expires.\n\nOAuth access tokens besides your application\u0027s personal access token expire after 30 days.\nYou can also renew expired tokens within 15 days of their expiration.\nYou cannot renew an access token that has been expired for more than 15 days.\nInstead, the associated user must recomplete the OAuth flow from the beginning.\n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the **Credentials**\npage in the [Developer Dashboard](https://developer.squareup.com/apps).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2ClientSecret": [] @@ -193,7 +193,7 @@ "operationId": "RevokeToken", "description": "Revokes an access token generated with the OAuth flow.\n\nIf an account has more than one OAuth access token for your application, this\nendpoint revokes all of them, regardless of which token you specify. \n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the **OAuth**\npage for your application in the Developer Dashboard.", "x-release-status": "PUBLIC", - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2ClientSecret": [] @@ -229,7 +229,7 @@ "operationId": "ObtainToken", "description": "Returns an OAuth access token and a refresh token unless the \n`short_lived` parameter is set to `true`, in which case the endpoint \nreturns only an access token.\n\nThe `grant_type` parameter specifies the type of OAuth request. If \n`grant_type` is `authorization_code`, you must include the authorization \ncode you received when a seller granted you authorization. If `grant_type` \nis `refresh_token`, you must provide a valid refresh token. If you\u0027re using \nan old version of the Square APIs (prior to March 13, 2019), `grant_type` \ncan be `migration_token` and you must provide a valid migration token.\n\nYou can use the `scopes` parameter to limit the set of permissions granted \nto the access token and refresh token. You can use the `short_lived` parameter \nto create an access token that expires in 24 hours.\n\n__Note:__ OAuth tokens should be encrypted and stored on a secure server. \nApplication clients should never interact directly with OAuth tokens.", "x-release-status": "PUBLIC", - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [], "parameters": [ { @@ -262,7 +262,7 @@ "description": "Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).\n\nAdd the access token to the Authorization header of the request.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nwhere `ACCESS_TOKEN` is a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).\n\nIf the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -293,7 +293,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -362,7 +362,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -410,7 +410,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -468,7 +468,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -560,7 +560,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -609,7 +609,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -691,7 +691,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -741,7 +741,7 @@ "x-oauthpermissions": [ "SETTLEMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -833,7 +833,7 @@ "x-oauthpermissions": [ "SETTLEMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -879,7 +879,7 @@ "description": "Activates a domain for use with Apple Pay on the Web and Square. A validation\nis performed on this domain by Apple to ensure that it is properly set up as\nan Apple Pay enabled domain.\n\nThis endpoint provides an easy way for platform developers to bulk activate\nApple Pay on the Web with Square for merchants using their platform.\n\nNote: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022.\nYou must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see [Migrate to the Web Payments SDK](https://developer.squareup.com/docs/web-payments/migrate).\n\nTo learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -913,12 +913,12 @@ ], "summary": "ListBankAccounts", "operationId": "ListBankAccounts", - "description": "Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2023-12-13/objects/BankAccount) objects linked to a Square account.", + "description": "Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2024-01-18/objects/BankAccount) objects linked to a Square account.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -966,12 +966,12 @@ ], "summary": "GetBankAccountByV1Id", "operationId": "GetBankAccountByV1Id", - "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2023-12-13/objects/BankAccount) identified by V1 bank account ID.", + "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2024-01-18/objects/BankAccount) identified by V1 bank account ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1005,12 +1005,12 @@ ], "summary": "GetBankAccount", "operationId": "GetBankAccount", - "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2023-12-13/objects/BankAccount)\nlinked to a Square account.", + "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2024-01-18/objects/BankAccount)\nlinked to a Square account.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1049,7 +1049,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1074,7 +1074,7 @@ }, { "name": "customer_id", - "description": "The [customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.", + "description": "The [customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.", "type": "string", "in": "query", "required": false @@ -1128,7 +1128,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1169,7 +1169,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1210,7 +1210,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1251,7 +1251,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1282,7 +1282,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1326,7 +1326,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1367,7 +1367,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1404,7 +1404,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1448,7 +1448,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1496,7 +1496,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1537,7 +1537,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1578,7 +1578,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1624,7 +1624,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1663,7 +1663,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1723,7 +1723,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1764,7 +1764,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1803,7 +1803,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1814,7 +1814,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking) object representing the to-be-retrieved booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking) object representing the to-be-retrieved booking.", "type": "string", "in": "path", "required": true @@ -1840,7 +1840,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1851,7 +1851,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking) object representing the to-be-updated booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking) object representing the to-be-updated booking.", "type": "string", "in": "path", "required": true @@ -1888,7 +1888,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1899,7 +1899,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking) object representing the to-be-cancelled booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking) object representing the to-be-cancelled booking.", "type": "string", "in": "path", "required": true @@ -1936,7 +1936,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -1947,7 +1947,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking).", "type": "string", "in": "path", "required": true @@ -1968,7 +1968,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -1996,7 +1996,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2007,7 +2007,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking).", "type": "string", "in": "path", "required": true @@ -2040,7 +2040,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2051,7 +2051,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking).", "type": "string", "in": "path", "required": true @@ -2065,7 +2065,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -2098,7 +2098,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2109,7 +2109,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking).", "type": "string", "in": "path", "required": true @@ -2153,7 +2153,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2218,7 +2218,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2259,7 +2259,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2298,7 +2298,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2337,7 +2337,7 @@ "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2406,12 +2406,12 @@ ], "summary": "RetrieveCashDrawerShift", "operationId": "RetrieveCashDrawerShift", - "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2023-12-13/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.", + "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2024-01-18/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2457,7 +2457,7 @@ "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2512,12 +2512,12 @@ ], "summary": "BatchDeleteCatalogObjects", "operationId": "BatchDeleteCatalogObjects", - "description": "Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.\n\nTo ensure consistency, only one delete request is processed at a time per seller account. \nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched) \ndelete requests are rejected with the `429` error code.", + "description": "Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.\n\nTo ensure consistency, only one delete request is processed at a time per seller account. \nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched) \ndelete requests are rejected with the `429` error code.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2553,12 +2553,12 @@ ], "summary": "BatchRetrieveCatalogObjects", "operationId": "BatchRetrieveCatalogObjects", - "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) objects, references to\nits [CatalogModifierList](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTax) objects that apply to it.", + "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) objects, references to\nits [CatalogModifierList](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTax) objects that apply to it.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2599,7 +2599,7 @@ "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2640,7 +2640,7 @@ "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2666,12 +2666,12 @@ ], "summary": "ListCatalog", "operationId": "ListCatalog", - "description": "Returns a list of all [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s of the specified types in the catalog. \n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) values, \nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-objects)\nand set the `include_deleted_objects` attribute value to `true`.", + "description": "Returns a list of all [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s of the specified types in the catalog. \n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) values, \nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-objects)\nand set the `include_deleted_objects` attribute value to `true`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2689,14 +2689,14 @@ }, { "name": "types", - "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", "type": "string", "in": "query", "required": false }, { "name": "catalog_version", - "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", "x-is-beta": true, "type": "integer", "format": "int64", @@ -2721,12 +2721,12 @@ ], "summary": "UpsertCatalogObject", "operationId": "UpsertCatalogObject", - "description": "Creates a new or updates the specified [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account. \nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched) \nupdate requests are rejected with the `429` error code.", + "description": "Creates a new or updates the specified [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account. \nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched) \nupdate requests are rejected with the `429` error code.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2762,12 +2762,12 @@ ], "summary": "DeleteCatalogObject", "operationId": "DeleteCatalogObject", - "description": "Deletes a single [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account. \nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched) \ndelete requests are rejected with the `429` error code.", + "description": "Deletes a single [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account. \nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched) \ndelete requests are rejected with the `429` error code.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2799,12 +2799,12 @@ ], "summary": "RetrieveCatalogObject", "operationId": "RetrieveCatalogObject", - "description": "Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) as a\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem)\ninformation including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTax) objects that apply to it.", + "description": "Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) as a\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem)\ninformation including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTax) objects that apply to it.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2829,7 +2829,7 @@ }, { "name": "catalog_version", - "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "x-is-beta": true, "type": "integer", "format": "int64", @@ -2862,12 +2862,12 @@ ], "summary": "SearchCatalogObjects", "operationId": "SearchCatalogObjects", - "description": "Searches for [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-items)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", + "description": "Searches for [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-items)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2903,12 +2903,12 @@ ], "summary": "SearchCatalogItems", "operationId": "SearchCatalogItems", - "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-objects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", + "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-objects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2944,12 +2944,12 @@ ], "summary": "UpdateItemModifierLists", "operationId": "UpdateItemModifierLists", - "description": "Updates the [CatalogModifierList](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) without having\nto perform an upsert on the entire item.", + "description": "Updates the [CatalogModifierList](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) without having\nto perform an upsert on the entire item.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -2985,12 +2985,12 @@ ], "summary": "UpdateItemTaxes", "operationId": "UpdateItemTaxes", - "description": "Updates the [CatalogTax](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTax) objects that apply to the\ntargeted [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) without having to perform an\nupsert on the entire item.", + "description": "Updates the [CatalogTax](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTax) objects that apply to the\ntargeted [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) without having to perform an\nupsert on the entire item.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3031,7 +3031,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3096,7 +3096,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3132,12 +3132,12 @@ ], "summary": "ListCustomerCustomAttributeDefinitions", "operationId": "ListCustomerCustomAttributeDefinitions", - "description": "Lists the customer-related [custom attribute definitions](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the customer-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3176,12 +3176,12 @@ ], "summary": "CreateCustomerCustomAttributeDefinition", "operationId": "CreateCustomerCustomAttributeDefinition", - "description": "Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/upsert-customer-custom-attribute) or\n[BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nto set the custom attribute for customer profiles in the seller\u0027s Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", + "description": "Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/upsert-customer-custom-attribute) or\n[BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nto set the custom attribute for customer profiles in the seller\u0027s Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3217,12 +3217,12 @@ ], "summary": "DeleteCustomerCustomAttributeDefinition", "operationId": "DeleteCustomerCustomAttributeDefinition", - "description": "Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller\u0027s Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller\u0027s Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3254,12 +3254,12 @@ ], "summary": "RetrieveCustomerCustomAttributeDefinition", "operationId": "RetrieveCustomerCustomAttributeDefinition", - "description": "Retrieves a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3298,12 +3298,12 @@ ], "summary": "UpdateCustomerCustomAttributeDefinition", "operationId": "UpdateCustomerCustomAttributeDefinition", - "description": "Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", + "description": "Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3346,12 +3346,12 @@ ], "summary": "BulkUpsertCustomerCustomAttributes", "operationId": "BulkUpsertCustomerCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert \nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID \nand provides a customer ID and custom attribute. Each upsert response is returned with the ID \nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert \nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID \nand provides a customer ID and custom attribute. Each upsert response is returned with the ID \nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3392,7 +3392,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3436,7 +3436,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3477,7 +3477,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3514,7 +3514,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3551,7 +3551,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3599,7 +3599,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3640,7 +3640,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3686,7 +3686,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3725,7 +3725,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3770,7 +3770,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3802,12 +3802,12 @@ ], "summary": "UpdateCustomer", "operationId": "UpdateCustomer", - "description": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null` and include the `X-Clear-Null` header set to `true`\n(recommended) or specify an empty string (string fields only).\n\nAs a best practice, include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.\nIf included, the value must be set to the current version of the customer profile.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2023-12-13/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2023-12-13/gift-cards-api).", + "description": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null` and include the `X-Clear-Null` header set to `true`\n(recommended) or specify an empty string (string fields only).\n\nAs a best practice, include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.\nIf included, the value must be set to the current version of the customer profile.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-01-18/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-01-18/gift-cards-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3856,7 +3856,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3906,7 +3906,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3949,12 +3949,12 @@ ], "summary": "ListCustomerCustomAttributes", "operationId": "ListCustomerCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -3965,7 +3965,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3986,7 +3986,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -4009,12 +4009,12 @@ ], "summary": "DeleteCustomerCustomAttribute", "operationId": "DeleteCustomerCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4025,7 +4025,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer).", "type": "string", "in": "path", "required": true @@ -4053,12 +4053,12 @@ ], "summary": "RetrieveCustomerCustomAttribute", "operationId": "RetrieveCustomerCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4069,7 +4069,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer).", "type": "string", "in": "path", "required": true @@ -4083,7 +4083,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -4111,12 +4111,12 @@ ], "summary": "UpsertCustomerCustomAttribute", "operationId": "UpsertCustomerCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4127,7 +4127,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer).", "type": "string", "in": "path", "required": true @@ -4171,7 +4171,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4215,7 +4215,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4262,7 +4262,7 @@ "x-oauthpermissions": [ "DEVICES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4326,7 +4326,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4384,7 +4384,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4425,7 +4425,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4465,7 +4465,7 @@ "x-oauthpermissions": [ "DEVICES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4505,7 +4505,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4558,7 +4558,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4597,7 +4597,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4636,7 +4636,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4682,7 +4682,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4730,7 +4730,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4774,7 +4774,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4815,12 +4815,12 @@ ], "summary": "SubmitEvidence", "operationId": "SubmitEvidence", - "description": "Submits evidence to the cardholder\u0027s bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2023-12-13/disputes-api/create-dispute-evidence-file) and\n[CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2023-12-13/disputes-api/create-dispute-evidence-text) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", + "description": "Submits evidence to the cardholder\u0027s bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2024-01-18/disputes-api/create-dispute-evidence-file) and\n[CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2024-01-18/disputes-api/create-dispute-evidence-text) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4860,7 +4860,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4925,7 +4925,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4965,7 +4965,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -4976,14 +4976,14 @@ "parameters": [ { "name": "type", - "description": "If a [type](https://developer.squareup.com/reference/square_2023-12-13/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", + "description": "If a [type](https://developer.squareup.com/reference/square_2024-01-18/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", "type": "string", "in": "query", "required": false }, { "name": "state", - "description": "If a [state](https://developer.squareup.com/reference/square_2023-12-13/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", + "description": "If a [state](https://developer.squareup.com/reference/square_2024-01-18/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", "type": "string", "in": "query", "required": false @@ -5025,12 +5025,12 @@ ], "summary": "CreateGiftCard", "operationId": "CreateGiftCard", - "description": "Creates a digital gift card or registers a physical (plastic) gift card. After the gift card \nis created, you must call [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) \nto activate the card with an initial balance before it can be used for payment.", + "description": "Creates a digital gift card or registers a physical (plastic) gift card. After the gift card \nis created, you must call [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) \nto activate the card with an initial balance before it can be used for payment.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5071,7 +5071,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5089,7 +5089,7 @@ }, { "name": "type", - "description": "If a [type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", + "description": "If a [type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", "type": "string", "in": "query", "required": false @@ -5152,12 +5152,12 @@ ], "summary": "CreateGiftCardActivity", "operationId": "CreateGiftCardActivity", - "description": "Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard). \nFor example, you create an `ACTIVATE` activity to activate a gift card with an initial balance \nbefore the gift card can be used.", + "description": "Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard). \nFor example, you create an `ACTIVATE` activity to activate a gift card with an initial balance \nbefore the gift card can be used.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5198,7 +5198,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5239,7 +5239,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5280,7 +5280,7 @@ "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5328,7 +5328,7 @@ "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5376,7 +5376,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5410,13 +5410,13 @@ ], "summary": "DeprecatedRetrieveInventoryAdjustment", "operationId": "DeprecatedRetrieveInventoryAdjustment", - "description": "Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/retrieve-inventory-adjustment) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/retrieve-inventory-adjustment) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5427,7 +5427,7 @@ "parameters": [ { "name": "adjustment_id", - "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryAdjustment) to retrieve.", + "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryAdjustment) to retrieve.", "type": "string", "in": "path", "required": true @@ -5450,12 +5450,12 @@ ], "summary": "RetrieveInventoryAdjustment", "operationId": "RetrieveInventoryAdjustment", - "description": "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`.", + "description": "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5466,7 +5466,7 @@ "parameters": [ { "name": "adjustment_id", - "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryAdjustment) to retrieve.", + "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryAdjustment) to retrieve.", "type": "string", "in": "path", "required": true @@ -5489,13 +5489,13 @@ ], "summary": "DeprecatedBatchChangeInventory", "operationId": "DeprecatedBatchChangeInventory", - "description": "Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-change-inventory) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-change-inventory) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5531,13 +5531,13 @@ ], "summary": "DeprecatedBatchRetrieveInventoryChanges", "operationId": "DeprecatedBatchRetrieveInventoryChanges", - "description": "Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5573,13 +5573,13 @@ ], "summary": "DeprecatedBatchRetrieveInventoryCounts", "operationId": "DeprecatedBatchRetrieveInventoryCounts", - "description": "Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5620,7 +5620,7 @@ "x-oauthpermissions": [ "INVENTORY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5661,7 +5661,7 @@ "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5697,12 +5697,12 @@ ], "summary": "BatchRetrieveInventoryCounts", "operationId": "BatchRetrieveInventoryCounts", - "description": "Returns current counts for the provided\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s at the requested\n[Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", + "description": "Returns current counts for the provided\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s at the requested\n[Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5738,13 +5738,13 @@ ], "summary": "DeprecatedRetrieveInventoryPhysicalCount", "operationId": "DeprecatedRetrieveInventoryPhysicalCount", - "description": "Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/retrieve-inventory-physical-count) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/retrieve-inventory-physical-count) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5755,7 +5755,7 @@ "parameters": [ { "name": "physical_count_id", - "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryPhysicalCount) to retrieve.", + "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryPhysicalCount) to retrieve.", "type": "string", "in": "path", "required": true @@ -5778,12 +5778,12 @@ ], "summary": "RetrieveInventoryPhysicalCount", "operationId": "RetrieveInventoryPhysicalCount", - "description": "Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", + "description": "Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5794,7 +5794,7 @@ "parameters": [ { "name": "physical_count_id", - "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryPhysicalCount) to retrieve.", + "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryPhysicalCount) to retrieve.", "type": "string", "in": "path", "required": true @@ -5817,13 +5817,13 @@ ], "summary": "RetrieveInventoryTransfer", "operationId": "RetrieveInventoryTransfer", - "description": "Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryTransfer) object\nwith the provided `transfer_id`.", + "description": "Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryTransfer) object\nwith the provided `transfer_id`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5834,7 +5834,7 @@ "parameters": [ { "name": "transfer_id", - "description": "ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryTransfer) to retrieve.", + "description": "ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryTransfer) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -5858,12 +5858,12 @@ ], "summary": "RetrieveInventoryCount", "operationId": "RetrieveInventoryCount", - "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) at a given set of\n[Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", + "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) at a given set of\n[Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5874,14 +5874,14 @@ "parameters": [ { "name": "catalog_object_id", - "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) to retrieve.", + "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "location_ids", - "description": "The [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "description": "The [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", "type": "string", "in": "query", "required": false @@ -5911,13 +5911,13 @@ ], "summary": "RetrieveInventoryChanges", "operationId": "RetrieveInventoryChanges", - "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) at the requested\n[Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-retrieve-inventory-changes)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", + "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) at the requested\n[Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-retrieve-inventory-changes)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -5928,14 +5928,14 @@ "parameters": [ { "name": "catalog_object_id", - "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) to retrieve.", + "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "location_ids", - "description": "The [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "description": "The [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", "type": "string", "in": "query", "required": false @@ -5970,7 +5970,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6016,13 +6016,13 @@ ], "summary": "CreateInvoice", "operationId": "CreateInvoice", - "description": "Creates a draft [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer\u0027s email address or charge the customer’s card on file).", + "description": "Creates a draft [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer\u0027s email address or charge the customer’s card on file).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6064,7 +6064,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6106,7 +6106,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6125,7 +6125,7 @@ }, { "name": "version", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2023-12-13/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2023-12-13/invoices-api/list-invoices).", + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-01-18/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2024-01-18/invoices-api/list-invoices).", "type": "integer", "in": "query", "required": false @@ -6151,7 +6151,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6189,7 +6189,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6239,7 +6239,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6251,7 +6251,7 @@ "parameters": [ { "name": "invoice_id", - "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) to cancel.", + "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) to cancel.", "type": "string", "in": "path", "required": true @@ -6289,7 +6289,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6338,7 +6338,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6389,7 +6389,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6430,7 +6430,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6467,7 +6467,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6505,7 +6505,7 @@ "TIMECARDS_SETTINGS_WRITE", "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6555,7 +6555,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6612,7 +6612,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6652,7 +6652,7 @@ "x-oauthpermissions": [ "TIMECARDS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6693,7 +6693,7 @@ "x-oauthpermissions": [ "TIMECARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6734,7 +6734,7 @@ "x-oauthpermissions": [ "TIMECARDS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6771,7 +6771,7 @@ "x-oauthpermissions": [ "TIMECARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6809,7 +6809,7 @@ "TIMECARDS_WRITE", "TIMECARDS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6858,7 +6858,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6911,7 +6911,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6950,7 +6950,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -6997,7 +6997,7 @@ "TIMECARDS_SETTINGS_WRITE", "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7046,7 +7046,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7075,7 +7075,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7111,13 +7111,13 @@ ], "summary": "ListLocationCustomAttributeDefinitions", "operationId": "ListLocationCustomAttributeDefinitions", - "description": "Lists the location-related [custom attribute definitions](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the location-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7166,13 +7166,13 @@ ], "summary": "CreateLocationCustomAttributeDefinition", "operationId": "CreateLocationCustomAttributeDefinition", - "description": "Creates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with locations.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/upsert-location-custom-attribute) or\n[BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nto set the custom attribute for locations.", + "description": "Creates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with locations.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/upsert-location-custom-attribute) or\n[BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nto set the custom attribute for locations.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7208,13 +7208,13 @@ ], "summary": "DeleteLocationCustomAttributeDefinition", "operationId": "DeleteLocationCustomAttributeDefinition", - "description": "Deletes a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall locations.\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall locations.\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7247,13 +7247,13 @@ ], "summary": "RetrieveLocationCustomAttributeDefinition", "operationId": "RetrieveLocationCustomAttributeDefinition", - "description": "Retrieves a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7294,13 +7294,13 @@ ], "summary": "UpdateLocationCustomAttributeDefinition", "operationId": "UpdateLocationCustomAttributeDefinition", - "description": "Updates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", + "description": "Updates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7344,13 +7344,13 @@ ], "summary": "BulkDeleteLocationCustomAttributes", "operationId": "BulkDeleteLocationCustomAttributes", - "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for locations as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for locations as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7386,13 +7386,13 @@ ], "summary": "BulkUpsertLocationCustomAttributes", "operationId": "BulkUpsertLocationCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for locations as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for one or more locations.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nThis `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a location ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for locations as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for one or more locations.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nThis `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a location ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7433,7 +7433,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7470,7 +7470,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7520,7 +7520,7 @@ "PAYMENTS_WRITE", "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7564,13 +7564,13 @@ ], "summary": "ListLocationCustomAttributes", "operationId": "ListLocationCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a location.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a location.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7581,7 +7581,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7613,7 +7613,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -7637,13 +7637,13 @@ ], "summary": "DeleteLocationCustomAttribute", "operationId": "DeleteLocationCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a location.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a location.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7654,7 +7654,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7684,13 +7684,13 @@ ], "summary": "RetrieveLocationCustomAttribute", "operationId": "RetrieveLocationCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a location.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a location.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7701,7 +7701,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7717,7 +7717,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -7747,13 +7747,13 @@ ], "summary": "UpsertLocationCustomAttribute", "operationId": "UpsertLocationCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for a location.\nUse this endpoint to set the value of a custom attribute for a specified location.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for a location.\nUse this endpoint to set the value of a custom attribute for a specified location.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7764,7 +7764,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7811,7 +7811,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7884,7 +7884,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7927,13 +7927,13 @@ ], "summary": "CaptureTransaction", "operationId": "CaptureTransaction", - "description": "Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "description": "Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -7976,13 +7976,13 @@ ], "summary": "VoidTransaction", "operationId": "VoidTransaction", - "description": "Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "description": "Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8030,7 +8030,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8071,7 +8071,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8112,7 +8112,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8123,7 +8123,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount) to retrieve.", + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount) to retrieve.", "type": "string", "in": "path", "required": true @@ -8146,12 +8146,12 @@ ], "summary": "AccumulateLoyaltyPoints", "operationId": "AccumulateLoyaltyPoints", - "description": "Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/calculate-loyalty-points)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "description": "Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/calculate-loyalty-points)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8162,7 +8162,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount).", + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount).", "type": "string", "in": "path", "required": true @@ -8194,12 +8194,12 @@ ], "summary": "AdjustLoyaltyPoints", "operationId": "AdjustLoyaltyPoints", - "description": "Adds points to or subtracts points from a buyer\u0027s account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/accumulate-loyalty-points)\nto add points when a buyer pays for the purchase.", + "description": "Adds points to or subtracts points from a buyer\u0027s account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/accumulate-loyalty-points)\nto add points when a buyer pays for the purchase.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8210,7 +8210,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount).", + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount).", "type": "string", "in": "path", "required": true @@ -8247,7 +8247,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8283,13 +8283,13 @@ ], "summary": "ListLoyaltyPrograms", "operationId": "ListLoyaltyPrograms", - "description": "Returns a list of loyalty programs in the seller\u0027s account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.", + "description": "Returns a list of loyalty programs in the seller\u0027s account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8320,7 +8320,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8354,12 +8354,12 @@ ], "summary": "CalculateLoyaltyPoints", "operationId": "CalculateLoyaltyPoints", - "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/list-loyalty-promotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/list-loyalty-promotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8370,7 +8370,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram), which defines the rules for accruing points.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram), which defines the rules for accruing points.", "type": "string", "in": "path", "required": true @@ -8402,12 +8402,12 @@ ], "summary": "ListLoyaltyPromotions", "operationId": "ListLoyaltyPromotions", - "description": "Lists the loyalty promotions associated with a [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", + "description": "Lists the loyalty promotions associated with a [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8418,7 +8418,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", "type": "string", "in": "path", "required": true @@ -8460,12 +8460,12 @@ ], "summary": "CreateLoyaltyPromotion", "operationId": "CreateLoyaltyPromotion", - "description": "Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", + "description": "Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8476,7 +8476,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-program)\nusing the `main` keyword.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-program)\nusing the `main` keyword.", "type": "string", "in": "path", "required": true @@ -8513,7 +8513,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8524,14 +8524,14 @@ "parameters": [ { "name": "promotion_id", - "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion) to retrieve.", + "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", "type": "string", "in": "path", "required": true @@ -8559,7 +8559,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8570,14 +8570,14 @@ "parameters": [ { "name": "promotion_id", - "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", + "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", "type": "string", "in": "path", "required": true }, { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "type": "string", "in": "path", "required": true @@ -8605,7 +8605,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8641,12 +8641,12 @@ ], "summary": "SearchLoyaltyRewards", "operationId": "SearchLoyaltyRewards", - "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-reward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", + "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-reward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8682,12 +8682,12 @@ ], "summary": "DeleteLoyaltyReward", "operationId": "DeleteLoyaltyReward", - "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/create-loyalty-reward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", + "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/create-loyalty-reward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8698,7 +8698,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward) to delete.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward) to delete.", "type": "string", "in": "path", "required": true @@ -8724,7 +8724,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8735,7 +8735,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward) to retrieve.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward) to retrieve.", "type": "string", "in": "path", "required": true @@ -8763,7 +8763,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8774,7 +8774,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward) to redeem.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward) to redeem.", "type": "string", "in": "path", "required": true @@ -8806,12 +8806,12 @@ ], "summary": "ListMerchants", "operationId": "ListMerchants", - "description": "Provides details about the merchant associated with a given access token.\n\nThe access token used to connect your application to a Square seller is associated\nwith a single merchant. That means that `ListMerchants` returns a list\nwith a single `Merchant` object. You can specify your personal access token\nto get your own merchant information or specify an OAuth token to get the\ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2023-12-13/merchants-api/retrieve-merchant)\nendpoint to retrieve the merchant information.", + "description": "Provides details about the merchant associated with a given access token.\n\nThe access token used to connect your application to a Square seller is associated\nwith a single merchant. That means that `ListMerchants` returns a list\nwith a single `Merchant` object. You can specify your personal access token\nto get your own merchant information or specify an OAuth token to get the\ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-01-18/merchants-api/retrieve-merchant)\nendpoint to retrieve the merchant information.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8845,13 +8845,13 @@ ], "summary": "ListMerchantCustomAttributeDefinitions", "operationId": "ListMerchantCustomAttributeDefinitions", - "description": "Lists the merchant-related [custom attribute definitions](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the merchant-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8900,13 +8900,13 @@ ], "summary": "CreateMerchantCustomAttributeDefinition", "operationId": "CreateMerchantCustomAttributeDefinition", - "description": "Creates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with a merchant connecting to your application.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/upsert-merchant-custom-attribute) or\n[BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nto set the custom attribute for a merchant.", + "description": "Creates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with a merchant connecting to your application.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/upsert-merchant-custom-attribute) or\n[BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nto set the custom attribute for a merchant.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8942,13 +8942,13 @@ ], "summary": "DeleteMerchantCustomAttributeDefinition", "operationId": "DeleteMerchantCustomAttributeDefinition", - "description": "Deletes a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nthe merchant.\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nthe merchant.\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -8981,13 +8981,13 @@ ], "summary": "RetrieveMerchantCustomAttributeDefinition", "operationId": "RetrieveMerchantCustomAttributeDefinition", - "description": "Retrieves a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9028,13 +9028,13 @@ ], "summary": "UpdateMerchantCustomAttributeDefinition", "operationId": "UpdateMerchantCustomAttributeDefinition", - "description": "Updates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", + "description": "Updates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9078,13 +9078,13 @@ ], "summary": "BulkDeleteMerchantCustomAttributes", "operationId": "BulkDeleteMerchantCustomAttributes", - "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for a merchant as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for a merchant as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9120,13 +9120,13 @@ ], "summary": "BulkUpsertMerchantCustomAttributes", "operationId": "BulkUpsertMerchantCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for a merchant as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for a merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nThis `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a merchant ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for a merchant as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for a merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nThis `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a merchant ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9167,7 +9167,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9201,13 +9201,13 @@ ], "summary": "ListMerchantCustomAttributes", "operationId": "ListMerchantCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9218,7 +9218,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2023-12-13/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-01-18/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9250,7 +9250,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -9274,13 +9274,13 @@ ], "summary": "DeleteMerchantCustomAttribute", "operationId": "DeleteMerchantCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a merchant.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a merchant.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9291,7 +9291,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2023-12-13/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-01-18/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9321,13 +9321,13 @@ ], "summary": "RetrieveMerchantCustomAttribute", "operationId": "RetrieveMerchantCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9338,7 +9338,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2023-12-13/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-01-18/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9354,7 +9354,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -9384,13 +9384,13 @@ ], "summary": "UpsertMerchantCustomAttribute", "operationId": "UpsertMerchantCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for a merchant.\nUse this endpoint to set the value of a custom attribute for a specified merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for a merchant.\nUse this endpoint to set the value of a custom attribute for a specified merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9401,7 +9401,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2023-12-13/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-01-18/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9448,7 +9448,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9488,7 +9488,7 @@ "MERCHANT_PROFILE_WRITE", "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9540,7 +9540,7 @@ "PAYMENT_METHODS_READ", "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9573,7 +9573,7 @@ "PAYMENT_METHODS_READ", "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9616,7 +9616,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9662,7 +9662,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9706,7 +9706,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9744,7 +9744,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9783,7 +9783,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9828,12 +9828,12 @@ ], "summary": "CreateOrder", "operationId": "CreateOrder", - "description": "Creates a new [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/update-order) endpoint.", + "description": "Creates a new [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/update-order) endpoint.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9869,12 +9869,12 @@ ], "summary": "BatchRetrieveOrders", "operationId": "BatchRetrieveOrders", - "description": "Retrieves a set of [orders](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", + "description": "Retrieves a set of [orders](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9914,7 +9914,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -9954,7 +9954,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -9990,13 +9990,13 @@ ], "summary": "ListOrderCustomAttributeDefinitions", "operationId": "ListOrderCustomAttributeDefinitions", - "description": "Lists the order-related [custom attribute definitions](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the order-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10051,7 +10051,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10087,13 +10087,13 @@ ], "summary": "DeleteOrderCustomAttributeDefinition", "operationId": "DeleteOrderCustomAttributeDefinition", - "description": "Deletes an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\n\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\n\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10126,13 +10126,13 @@ ], "summary": "RetrieveOrderCustomAttributeDefinition", "operationId": "RetrieveOrderCustomAttributeDefinition", - "description": "Retrieves an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10179,7 +10179,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10223,13 +10223,13 @@ ], "summary": "BulkDeleteOrderCustomAttributes", "operationId": "BulkDeleteOrderCustomAttributes", - "description": "Deletes order [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete\nrequests and returns a map of individual delete responses. Each delete request has a unique ID\nand provides an order ID and custom attribute. Each delete response is returned with the ID\nof the corresponding request.\n\nTo delete a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes order [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete\nrequests and returns a map of individual delete responses. Each delete request has a unique ID\nand provides an order ID and custom attribute. Each delete response is returned with the ID\nof the corresponding request.\n\nTo delete a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10265,13 +10265,13 @@ ], "summary": "BulkUpsertOrderCustomAttributes", "operationId": "BulkUpsertOrderCustomAttributes", - "description": "Creates or updates order [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides an order ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates order [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides an order ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10307,12 +10307,12 @@ ], "summary": "SearchOrders", "operationId": "SearchOrders", - "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](https://developer.squareup.com/reference/square_2023-12-13/objects/SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](https://developer.squareup.com/reference/square_2023-12-13/objects/OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", + "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](https://developer.squareup.com/reference/square_2024-01-18/objects/SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](https://developer.squareup.com/reference/square_2024-01-18/objects/OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10348,12 +10348,12 @@ ], "summary": "RetrieveOrder", "operationId": "RetrieveOrder", - "description": "Retrieves an [Order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) by ID.", + "description": "Retrieves an [Order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) by ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10385,13 +10385,13 @@ ], "summary": "UpdateOrder", "operationId": "UpdateOrder", - "description": "Updates an open [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", + "description": "Updates an open [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10435,13 +10435,13 @@ ], "summary": "ListOrderCustomAttributes", "operationId": "ListOrderCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10452,7 +10452,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10484,7 +10484,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -10508,13 +10508,13 @@ ], "summary": "DeleteOrderCustomAttribute", "operationId": "DeleteOrderCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10525,7 +10525,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10555,13 +10555,13 @@ ], "summary": "RetrieveOrderCustomAttribute", "operationId": "RetrieveOrderCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\nalso known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\nalso known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10572,7 +10572,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10596,7 +10596,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -10618,13 +10618,13 @@ ], "summary": "UpsertOrderCustomAttribute", "operationId": "UpsertOrderCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) for an order.\n\nUse this endpoint to set the value of a custom attribute for a specific order.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) for an order.\n\nUse this endpoint to set the value of a custom attribute for a specific order.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10635,7 +10635,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10676,14 +10676,14 @@ ], "summary": "PayOrder", "operationId": "PayOrder", - "description": "Pay for an [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2023-12-13/objects/Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/create-payment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", + "description": "Pay for an [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2024-01-18/objects/Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/create-payment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "PAYMENTS_WRITE", "ORDERS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10733,7 +10733,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10827,7 +10827,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10868,7 +10868,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10909,7 +10909,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10946,7 +10946,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -10994,7 +10994,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11033,7 +11033,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11079,7 +11079,7 @@ "description": "Retrieves a list of all payouts for the default location.\nYou can filter payouts by location ID, status, time range, and order them in ascending or descending order.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -11156,7 +11156,7 @@ "description": "Retrieves details of a specific payout identified by a payout ID.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -11191,7 +11191,7 @@ "description": "Retrieves a list of all payout entries for a specific payout.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -11249,7 +11249,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11295,7 +11295,7 @@ }, { "name": "status", - "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2023-12-13/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-01-18/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", "type": "string", "in": "query", "required": false @@ -11335,7 +11335,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11376,7 +11376,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11415,7 +11415,7 @@ "x-oauthpermissions": [ "ONLINE_STORE_SITE_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11441,12 +11441,12 @@ ], "summary": "DeleteSnippet", "operationId": "DeleteSnippet", - "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2023-12-13/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-01-18/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11478,12 +11478,12 @@ ], "summary": "RetrieveSnippet", "operationId": "RetrieveSnippet", - "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2023-12-13/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-01-18/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11515,12 +11515,12 @@ ], "summary": "UpsertSnippet", "operationId": "UpsertSnippet", - "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2023-12-13/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-01-18/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11573,7 +11573,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11622,7 +11622,7 @@ "SUBSCRIPTIONS_READ", "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11665,7 +11665,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11706,7 +11706,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11756,7 +11756,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11810,7 +11810,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11861,7 +11861,7 @@ "SUBSCRIPTIONS_READ", "ITEMS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11912,7 +11912,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -11951,7 +11951,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12010,7 +12010,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12069,7 +12069,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12128,7 +12128,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12182,7 +12182,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12223,7 +12223,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12264,7 +12264,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12305,7 +12305,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12346,7 +12346,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12383,7 +12383,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12431,7 +12431,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12468,7 +12468,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12517,7 +12517,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12559,7 +12559,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12601,7 +12601,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12642,7 +12642,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12681,7 +12681,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -12719,7 +12719,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12760,7 +12760,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12801,7 +12801,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12840,7 +12840,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12878,7 +12878,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -12911,12 +12911,12 @@ ], "summary": "CreateTerminalRefund", "operationId": "CreateTerminalRefund", - "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2023-12-13/refunds-api).", + "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2024-01-18/refunds-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12957,7 +12957,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -12998,7 +12998,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13037,7 +13037,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13075,7 +13075,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13108,13 +13108,13 @@ ], "summary": "BulkCreateVendors", "operationId": "BulkCreateVendors", - "description": "Creates one or more [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects to represent suppliers to a seller.", + "description": "Creates one or more [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects to represent suppliers to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13150,13 +13150,13 @@ ], "summary": "BulkRetrieveVendors", "operationId": "BulkRetrieveVendors", - "description": "Retrieves one or more vendors of specified [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) IDs.", + "description": "Retrieves one or more vendors of specified [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) IDs.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13192,13 +13192,13 @@ ], "summary": "BulkUpdateVendors", "operationId": "BulkUpdateVendors", - "description": "Updates one or more of existing [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects as suppliers to a seller.", + "description": "Updates one or more of existing [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects as suppliers to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13234,13 +13234,13 @@ ], "summary": "CreateVendor", "operationId": "CreateVendor", - "description": "Creates a single [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) object to represent a supplier to a seller.", + "description": "Creates a single [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) object to represent a supplier to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13276,13 +13276,13 @@ ], "summary": "SearchVendors", "operationId": "SearchVendors", - "description": "Searches for vendors using a filter against supported [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) properties and a supported sorter.", + "description": "Searches for vendors using a filter against supported [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) properties and a supported sorter.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13318,13 +13318,13 @@ ], "summary": "RetrieveVendor", "operationId": "RetrieveVendor", - "description": "Retrieves the vendor of a specified [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) ID.", + "description": "Retrieves the vendor of a specified [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) ID.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13335,7 +13335,7 @@ "parameters": [ { "name": "vendor_id", - "description": "ID of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) to retrieve.", + "description": "ID of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -13357,13 +13357,13 @@ ], "summary": "UpdateVendor", "operationId": "UpdateVendor", - "description": "Updates an existing [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) object as a supplier to a seller.", + "description": "Updates an existing [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) object as a supplier to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [ @@ -13409,7 +13409,7 @@ "description": "Lists all webhook event types that can be subscribed to.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13444,7 +13444,7 @@ "description": "Lists all webhook subscriptions owned by your application.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13460,14 +13460,14 @@ }, { "name": "include_disabled", - "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)s are returned.", + "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)s are returned.", "type": "boolean", "in": "query", "required": false }, { "name": "sort_order", - "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", + "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", "type": "string", "in": "query", "required": false @@ -13498,7 +13498,7 @@ "description": "Creates a webhook subscription.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13535,7 +13535,7 @@ "description": "Deletes a webhook subscription.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13544,7 +13544,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to delete.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to delete.", "type": "string", "in": "path", "required": true @@ -13568,7 +13568,7 @@ "description": "Retrieves a webhook subscription identified by its ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13577,7 +13577,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to retrieve.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to retrieve.", "type": "string", "in": "path", "required": true @@ -13601,7 +13601,7 @@ "description": "Updates a webhook subscription.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13610,7 +13610,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to update.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to update.", "type": "string", "in": "path", "required": true @@ -13645,7 +13645,7 @@ "description": "Updates a webhook subscription by replacing the existing signature key with a new one.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13654,7 +13654,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to update.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to update.", "type": "string", "in": "path", "required": true @@ -13689,7 +13689,7 @@ "description": "Tests a webhook subscription by sending a test event to the notification URL.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2023-12-13", + "x-sq-version": "2024-01-18", "security": [ { "oauth2": [] @@ -13698,7 +13698,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to test.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to test.", "type": "string", "in": "path", "required": true @@ -14048,7 +14048,7 @@ "description": "Requested items can be archived or not archived." } ], - "description": "Defines the values for the `archived_state` query expression \nused in [SearchCatalogItems](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-items) \nto return the archived, not archived or either type of catalog items.", + "description": "Defines the values for the `archived_state` query expression \nused in [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-items) \nto return the archived, not archived or either type of catalog items.", "x-release-status": "PUBLIC" }, "BankAccountStatus": { @@ -14767,75 +14767,75 @@ "x-enum-elements": [ { "name": "ITEM", - "description": "The `CatalogObject` instance is of the [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." }, { "name": "IMAGE", - "description": "The `CatalogObject` instance is of the [CatalogImage](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." + "description": "The `CatalogObject` instance is of the [CatalogImage](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." }, { "name": "CATEGORY", - "description": "The `CatalogObject` instance is of the [CatalogCategory](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." + "description": "The `CatalogObject` instance is of the [CatalogCategory](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." }, { "name": "ITEM_VARIATION", - "description": "The `CatalogObject` instance is of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." }, { "name": "TAX", - "description": "The `CatalogObject` instance is of the [CatalogTax](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." + "description": "The `CatalogObject` instance is of the [CatalogTax](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." }, { "name": "DISCOUNT", - "description": "The `CatalogObject` instance is of the [CatalogDiscount](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." + "description": "The `CatalogObject` instance is of the [CatalogDiscount](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." }, { "name": "MODIFIER_LIST", - "description": "The `CatalogObject` instance is of the [CatalogModifierList](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." + "description": "The `CatalogObject` instance is of the [CatalogModifierList](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." }, { "name": "MODIFIER", - "description": "The `CatalogObject` instance is of the [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." + "description": "The `CatalogObject` instance is of the [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." }, { "name": "PRICING_RULE", - "description": "The `CatalogObject` instance is of the [CatalogPricingRule](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." + "description": "The `CatalogObject` instance is of the [CatalogPricingRule](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." }, { "name": "PRODUCT_SET", - "description": "The `CatalogObject` instance is of the [CatalogProductSet](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." + "description": "The `CatalogObject` instance is of the [CatalogProductSet](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." }, { "name": "TIME_PERIOD", - "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." + "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." }, { "name": "MEASUREMENT_UNIT", - "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." + "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." }, { "name": "SUBSCRIPTION_PLAN_VARIATION", - "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." }, { "name": "ITEM_OPTION", - "description": "The `CatalogObject` instance is of the [CatalogItemOption](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemOption](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." }, { "name": "ITEM_OPTION_VAL", - "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." }, { "name": "CUSTOM_ATTRIBUTE_DEFINITION", - "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." + "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." }, { "name": "QUICK_AMOUNTS_SETTINGS", - "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." + "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." }, { "name": "SUBSCRIPTION_PLAN", - "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field." + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field." } ], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", @@ -17827,7 +17827,7 @@ "description": "Specifies that the employee is in the Inactive state." } ], - "description": "The status of the Employee being retrieved.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMemberStatus).", + "description": "The status of the Employee being retrieved.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMemberStatus).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -18762,7 +18762,7 @@ "x-enum-elements": [ { "name": "PICKUP", - "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)." + "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)." }, { "name": "SHIPMENT", @@ -18802,7 +18802,7 @@ "description": "The balance was decreased because the order used to purchase or reload the\ngift card was refunded." } ], - "description": "Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard).", + "description": "Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustIncrementReason": { @@ -18826,7 +18826,7 @@ "description": "The transaction is voided." } ], - "description": "Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard).", + "description": "Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityBlockReason": { @@ -18840,7 +18840,7 @@ "description": "The gift card is blocked because the buyer initiated a chargeback on the gift card purchase." } ], - "description": "Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard).", + "description": "Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityClearBalanceReason": { @@ -18864,7 +18864,7 @@ "description": "The gift card balance was cleared for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API." } ], - "description": "Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard).", + "description": "Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityDeactivateReason": { @@ -18888,7 +18888,7 @@ "description": "A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API." } ], - "description": "Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard).", + "description": "Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityRedeemStatus": { @@ -18912,7 +18912,7 @@ "description": "The gift card redemption is canceled. A redemption is canceled if the authorization \non the gift card is voided." } ], - "description": "Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", + "description": "Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", "x-release-status": "PUBLIC" }, "GiftCardActivityType": { @@ -18996,7 +18996,7 @@ "description": "Added money to a gift card as the result of a transfer from the balance of another gift card.\n`TRANSFER_BALANCE_TO` activities are managed by Square and cannot be created using the Gift Card Activities API." } ], - "description": "Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivity).", + "description": "Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivity).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnblockReason": { @@ -19010,7 +19010,7 @@ "description": "The gift card is unblocked because a chargeback was ruled in favor of the seller." } ], - "description": "Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard).", + "description": "Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardGANSource": { @@ -19233,7 +19233,7 @@ "description": "Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\naccount for the amount of the payment request if the buyer has approved the payment. The buyer receives a\nrequest to approve the payment when the invoice is sent or the invoice is updated.\n\nThis payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. \n\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`." } ], - "description": "Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2023-12-13/objects/InvoicePaymentRequest).", + "description": "Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2024-01-18/objects/InvoicePaymentRequest).", "x-release-status": "PUBLIC" }, "InvoiceCustomFieldPlacement": { @@ -19276,7 +19276,7 @@ "description": "Directs Square to send invoices and receipts to the customer using SMS (text message).\n\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`." } ], - "description": "Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) to the customer.", + "description": "Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) to the customer.", "x-release-status": "PUBLIC" }, "InvoicePaymentReminderStatus": { @@ -19317,7 +19317,7 @@ "x-enum-elements": [ { "name": "EMAIL", - "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice))." + "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice))." }, { "name": "CHARGE_CARD_ON_FILE", @@ -19333,7 +19333,7 @@ }, { "name": "SMS", - "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." + "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." }, { "name": "SMS_CHARGE_CARD_ON_FILE", @@ -19579,11 +19579,11 @@ "x-enum-elements": [ { "name": "ACCUMULATE_POINTS", - "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgramAccrualRule)." + "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgramAccrualRule)." }, { "name": "CREATE_REWARD", - "description": "A [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward) is created." + "description": "A [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward) is created." }, { "name": "REDEEM_REWARD", @@ -19607,7 +19607,7 @@ }, { "name": "ACCUMULATE_PROMOTION_POINTS", - "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion)." + "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion)." } ], "description": "The type of the loyalty event.", @@ -19741,7 +19741,7 @@ "description": "Add a specified number of points to those earned from the base loyalty program.\nFor example, \"Earn 10 additional points.\"" } ], - "description": "Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", + "description": "Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionStatus": { @@ -19770,7 +19770,7 @@ "description": "The loyalty promotion is scheduled to start in the future. Square changes the\npromotion status to `ACTIVE` when the `start_date` is reached." } ], - "description": "Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion).", + "description": "Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionTriggerLimitInterval": { @@ -19789,7 +19789,7 @@ "description": "The limit applies per day, according to the `available_time` schedule specified for the promotion.\nFor example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion\na maximum of once per day." } ], - "description": "Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion).", + "description": "Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyRewardStatus": { @@ -20231,7 +20231,7 @@ "x-enum-elements": [ { "name": "PICKUP", - "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)." + "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)." }, { "name": "SHIPMENT", @@ -20783,14 +20783,14 @@ "x-enum-elements": [ { "name": "NAME", - "description": "To sort the result by the name of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects." + "description": "To sort the result by the name of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects." }, { "name": "CREATED_AT", - "description": "To sort the result by the creation time of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects." + "description": "To sort the result by the creation time of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects." } ], - "description": "The field to sort the returned [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects by.", + "description": "The field to sort the returned [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects by.", "x-release-status": "BETA", "x-is-beta": true }, @@ -21010,7 +21010,7 @@ "description": "Once every two years" } ], - "description": "Determines the billing cadence of a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/Subscription)", + "description": "Determines the billing cadence of a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/Subscription)", "x-release-status": "PUBLIC" }, "SubscriptionEventInfoCode": { @@ -21112,7 +21112,7 @@ "description": "Relative pricing" } ], - "description": "Determines the pricing of a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/Subscription)", + "description": "Determines the pricing of a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/Subscription)", "x-release-status": "PUBLIC" }, "SubscriptionStatus": { @@ -22150,7 +22150,7 @@ "description": "Vendor is inactive and cannot receive purchase orders." } ], - "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor),\nwhether a [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) is active or inactive.", + "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor),\nwhether a [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) is active or inactive.", "x-release-status": "BETA", "x-is-beta": true }, @@ -22337,10 +22337,10 @@ }, "location_id": { "type": "string", - "description": "The [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the purchase was made." + "description": "The [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the purchase was made." } }, - "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/accumulate-loyalty-points) request.", + "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/accumulate-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?account_id\u003d5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", @@ -22377,7 +22377,7 @@ "description": "The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event\nis always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included\nif the purchase also qualifies for a loyalty promotion." } }, - "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/accumulate-loyalty-points) response.", + "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/accumulate-loyalty-points) response.", "x-release-status": "PUBLIC", "example": { "events": [ @@ -22400,7 +22400,7 @@ "AddGroupToCustomerRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2023-12-13/customers-api/add-group-to-customer) endpoint.", + "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-01-18/customers-api/add-group-to-customer) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -22417,7 +22417,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2023-12-13/customers-api/add-group-to-customer) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-01-18/customers-api/add-group-to-customer) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -22538,7 +22538,7 @@ "description": "Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative\nbalance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting\nthe specified number of points would result in a negative balance. The default value is `false`." } }, - "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/adjust-loyalty-points) request.", + "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/adjust-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?account_id\u003d5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", @@ -22566,7 +22566,7 @@ "description": "The resulting event data for the adjustment." } }, - "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/adjust-loyalty-points) request.", + "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/adjust-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "event": { @@ -22626,13 +22626,13 @@ "minLength": 0, "maxLength": 36, "type": "string", - "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) object representing the service booked in this segment." + "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) object representing the service booked in this segment." }, "team_member_id": { "minLength": 1, "maxLength": 32, "type": "string", - "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) object representing the team member booked in this segment." + "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) object representing the team member booked in this segment." }, "service_variation_version": { "type": "integer", @@ -23019,7 +23019,7 @@ "catalog_version": { "type": "integer", "format": "int64", - "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true }, @@ -23069,14 +23069,14 @@ "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s returned." + "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s returned." }, "related_objects": { "type": "array", "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s referenced by the object in the `objects` field." + "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s referenced by the object in the `objects` field." } }, "description": "", @@ -23269,7 +23269,7 @@ "maximum": 1000, "minimum": 1, "type": "integer", - "description": "The number of [records](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryChange) to return." + "description": "The number of [records](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryChange) to return." } }, "description": "", @@ -23387,7 +23387,7 @@ "maximum": 1000, "minimum": 1, "type": "integer", - "description": "The number of [records](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryCount) to return." + "description": "The number of [records](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryCount) to return." } }, "description": "", @@ -23954,25 +23954,25 @@ "minLength": 0, "maxLength": 32, "type": "string", - "description": "The ID of the [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed." + "description": "The ID of the [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed." }, "customer_id": { "minLength": 0, "maxLength": 192, "type": "string", - "description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) object representing the customer receiving the booked service." + "description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) object representing the customer receiving the booked service." }, "customer_note": { "minLength": 0, "maxLength": 4096, "type": "string", - "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) instance." + "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) instance." }, "seller_note": { "minLength": 0, "maxLength": 4096, "type": "string", - "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) instance.\nThis field should not be visible to customers." + "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) instance.\nThis field should not be visible to customers." }, "appointment_segments": { "type": "array", @@ -24046,7 +24046,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking)." + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking)." }, "key": { "minLength": 1, @@ -24054,7 +24054,7 @@ "description": "The key of the custom attribute to delete. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key." } }, - "description": "Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-delete-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.", + "description": "Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-delete-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.", "x-release-status": "PUBLIC", "example": { "booking_id": "Z57QXKM2FGXEQDV42W8RBZY7BR", @@ -24066,7 +24066,7 @@ "properties": { "booking_id": { "type": "string", - "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking) associated with the custom attribute." + "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking) associated with the custom attribute." }, "errors": { "type": "array", @@ -24076,7 +24076,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "booking_id": "N3NCVYY3WS27HF0HKANA3R9FP8", @@ -24094,7 +24094,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking)." + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -24106,7 +24106,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -24121,7 +24121,7 @@ "properties": { "booking_id": { "type": "string", - "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking) associated with the custom attribute." + "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking) associated with the custom attribute." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -24135,7 +24135,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -24367,10 +24367,10 @@ "additionalProperties": { "$ref": "#/definitions/Vendor" }, - "description": "Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." + "description": "Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." } }, - "description": "Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/bulk-create-vendors).", + "description": "Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/bulk-create-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24425,10 +24425,10 @@ "additionalProperties": { "$ref": "#/definitions/CreateVendorResponse" }, - "description": "A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2023-12-13/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." + "description": "A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2024-01-18/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." } }, - "description": "Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/bulk-create-vendors).", + "description": "Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/bulk-create-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24497,7 +24497,7 @@ "description": "A map containing 1 to 25 individual Delete requests. For each request, provide an\narbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the\ninformation needed to delete a custom attribute." } }, - "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) request.", + "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -24534,7 +24534,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -24568,7 +24568,7 @@ "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." } }, - "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-delete-location-custom-attributes) request.", + "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-delete-location-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24600,7 +24600,7 @@ "x-read-only": true } }, - "description": "Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", + "description": "Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true }, @@ -24625,7 +24625,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-delete-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-delete-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24660,7 +24660,7 @@ "description": "Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request" } }, - "description": "Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest.", + "description": "Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24682,7 +24682,7 @@ "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." } }, - "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request.", + "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24710,7 +24710,7 @@ "x-read-only": true } }, - "description": "Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", + "description": "Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true }, @@ -24735,7 +24735,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24762,7 +24762,7 @@ "description": "Errors that occurred while processing the individual MerchantCustomAttributeDeleteRequest request" } }, - "description": "Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest.", + "description": "Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24819,7 +24819,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order)." + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order)." } }, "description": "Represents one delete within the bulk operation.", @@ -24870,7 +24870,7 @@ "maxLength": 36, "type": "string" }, - "description": "A non-empty list of [Booking](https://developer.squareup.com/reference/square_2023-12-13/objects/Booking) IDs specifying bookings to retrieve." + "description": "A non-empty list of [Booking](https://developer.squareup.com/reference/square_2024-01-18/objects/Booking) IDs specifying bookings to retrieve." } }, "description": "Request payload for bulk retrieval of bookings.", @@ -24981,7 +24981,7 @@ "description": "A non-empty list of IDs of team members whose booking profiles you want to retrieve." } }, - "description": "Request payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2023-12-13/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", + "description": "Request payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-01-18/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", "x-release-status": "PUBLIC", "example": { "team_member_ids": [ @@ -24999,7 +24999,7 @@ "additionalProperties": { "$ref": "#/definitions/RetrieveTeamMemberBookingProfileResponse" }, - "description": "The returned team members\u0027 booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMemberBookingProfile) the value." + "description": "The returned team members\u0027 booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMemberBookingProfile) the value." }, "errors": { "type": "array", @@ -25009,7 +25009,7 @@ "description": "Errors that occurred during the request." } }, - "description": "Response payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2023-12-13/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", + "description": "Response payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-01-18/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", "x-release-status": "PUBLIC", "example": { "team_member_booking_profiles": { @@ -25050,10 +25050,10 @@ "items": { "type": "string" }, - "description": "IDs of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects to retrieve." + "description": "IDs of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects to retrieve." } }, - "description": "Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/bulk-retrieve-vendors).", + "description": "Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/bulk-retrieve-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25079,10 +25079,10 @@ "additionalProperties": { "$ref": "#/definitions/RetrieveVendorResponse" }, - "description": "The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2023-12-13/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." + "description": "The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2024-01-18/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." } }, - "description": "Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/bulk-retrieve-vendors).", + "description": "Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/bulk-retrieve-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25143,7 +25143,7 @@ "description": "The ID of the location to associate with the swapped subscriptions." } }, - "description": "Defines input parameters in a call to the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/bulk-swap-plan) endpoint.", + "description": "Defines input parameters in a call to the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/bulk-swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25169,7 +25169,7 @@ "description": "The number of affected subscriptions." } }, - "description": "Defines output parameters in a response of the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/bulk-swap-plan) endpoint.", + "description": "Defines output parameters in a response of the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/bulk-swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25305,10 +25305,10 @@ "additionalProperties": { "$ref": "#/definitions/UpdateVendorRequest" }, - "description": "A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2023-12-13/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." + "description": "A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2024-01-18/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." } }, - "description": "Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/bulk-update-vendors).", + "description": "Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/bulk-update-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25349,10 +25349,10 @@ "additionalProperties": { "$ref": "#/definitions/UpdateVendorResponse" }, - "description": "A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2023-12-13/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." + "description": "A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2024-01-18/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." } }, - "description": "Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/bulk-update-vendors).", + "description": "Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/bulk-update-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25425,7 +25425,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) request.", + "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -25485,7 +25485,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -25567,7 +25567,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -25621,7 +25621,7 @@ "customer_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer)." + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -25633,7 +25633,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC" }, "BulkUpsertCustomerCustomAttributesResponse": { @@ -25654,7 +25654,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -25735,7 +25735,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", @@ -25763,7 +25763,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-upsert-location-custom-attributes) request.", + "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-upsert-location-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25804,7 +25804,7 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)." + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -25816,7 +25816,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nrequest. An individual request contains a location ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nrequest. An individual request contains a location ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "BETA", "x-is-beta": true }, @@ -25838,7 +25838,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-upsert-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-upsert-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25898,7 +25898,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/bulk-upsert-location-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/bulk-upsert-location-custom-attributes) operation.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25927,7 +25927,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) request.", + "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25961,7 +25961,7 @@ "merchant_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2023-12-13/objects/Merchant)." + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-01-18/objects/Merchant)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -25973,7 +25973,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nrequest. An individual request contains a merchant ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nrequest. An individual request contains a merchant ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "BETA", "x-is-beta": true }, @@ -25995,7 +25995,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26044,7 +26044,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) operation.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26120,7 +26120,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order)." + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order)." } }, "description": "Represents one upsert within the bulk operation.", @@ -26338,7 +26338,7 @@ "properties": { "order_id": { "type": "string", - "description": "The [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`." + "description": "The [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`." }, "transaction_amount_money": { "$ref": "#/definitions/Money", @@ -26348,10 +26348,10 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion\u0027s\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit." + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion\u0027s\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit." } }, - "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/calculate-loyalty-points) request.", + "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/calculate-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -26382,7 +26382,7 @@ "description": "The number of points that the buyer can earn from a loyalty promotion. To be eligible\nto earn promotion points, the purchase must first qualify for program points. When `order_id`\nis not provided in the request, this value is always 0." } }, - "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/calculate-loyalty-points) response.", + "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/calculate-loyalty-points) response.", "x-release-status": "PUBLIC", "example": { "points": 6, @@ -26685,7 +26685,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](https://developer.squareup.com/reference/square_2023-12-13/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2023-12-13/invoices-api/list-invoices)." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](https://developer.squareup.com/reference/square_2024-01-18/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2024-01-18/invoices-api/list-invoices)." } }, "description": "Describes a `CancelInvoice` request.", @@ -26787,7 +26787,7 @@ "CancelLoyaltyPromotionRequest": { "type": "object", "properties": {}, - "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/cancel-loyalty-promotion) request.", + "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/cancel-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id\u003dloypromo_f0f9b849-725e-378d-b810-511237e07b67", @@ -26809,7 +26809,7 @@ "description": "The canceled loyalty promotion." } }, - "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/cancel-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/cancel-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -26860,7 +26860,7 @@ "description": "The `idempotency_key` identifying the payment to be canceled." } }, - "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2023-12-13/payments-api/cancel-payment-by-idempotency-key).", + "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-01-18/payments-api/cancel-payment-by-idempotency-key).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -26879,14 +26879,14 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2023-12-13/payments-api/cancel-payment-by-idempotency-key).\nOn success, `errors` is empty.", + "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-01-18/payments-api/cancel-payment-by-idempotency-key).\nOn success, `errors` is empty.", "x-release-status": "PUBLIC", "example": {} }, "CancelPaymentRequest": { "type": "object", "properties": {}, - "description": "Describes the request to cancel (void) a payment using\n[CancelPayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/cancel-payment).\nYou can only cancel a payment that is approved (not completed).\nFor more information, see\n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", + "description": "Describes the request to cancel (void) a payment using\n[CancelPayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/cancel-payment).\nYou can only cancel a payment that is approved (not completed).\nFor more information, see\n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -26907,7 +26907,7 @@ "description": "The successfully canceled `Payment` object." } }, - "description": "Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/cancel-payment).", + "description": "Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/cancel-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -26976,7 +26976,7 @@ "CancelSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Defines input parameters in a request to the \n[CancelSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/cancel-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[CancelSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/cancel-subscription) endpoint.", "x-release-status": "PUBLIC" }, "CancelSubscriptionResponse": { @@ -27003,7 +27003,7 @@ "x-is-beta": true } }, - "description": "Defines output parameters in a response from the \n[CancelSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/cancel-subscription) endpoint.", + "description": "Defines output parameters in a response from the \n[CancelSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/cancel-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -27210,7 +27210,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/capture-transaction) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/capture-transaction) endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": {}, @@ -27437,7 +27437,7 @@ "minLength": 2, "maxLength": 2, "type": "string", - "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](https://developer.squareup.com/reference/square_2023-12-13/enums/Country)." + "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](https://developer.squareup.com/reference/square_2024-01-18/enums/Country)." }, "buyer_cashtag": { "minLength": 1, @@ -27934,7 +27934,7 @@ }, "custom_attribute_definition_id": { "type": "string", - "description": "The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogCustomAttributeDefinition) this value belongs to.", + "description": "The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogCustomAttributeDefinition) this value belongs to.", "x-read-only": true }, "type": { @@ -28052,7 +28052,7 @@ "description": "The permanent ID for the CatalogObject created by the server." } }, - "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/upsert-catalog-object) or\n[BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/batch-upsert-catalog-objects) to\ncreate a [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", + "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/upsert-catalog-object) or\n[BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/batch-upsert-catalog-objects) to\ncreate a [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", "x-release-status": "PUBLIC" }, "CatalogImage": { @@ -28060,15 +28060,15 @@ "properties": { "name": { "type": "string", - "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-objects).\nIt is not unique and should not be shown in a buyer facing context." + "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-objects).\nIt is not unique and should not be shown in a buyer facing context." }, "url": { "type": "string", - "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/create-catalog-image) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field." + "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/create-catalog-image) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field." }, "caption": { "type": "string", - "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-objects)." + "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-objects)." }, "photo_studio_order_id": { "type": "string", @@ -28200,7 +28200,7 @@ "description": { "maxLength": 4096, "type": "string", - "description": "The item\u0027s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", + "description": "The item\u0027s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -28227,7 +28227,7 @@ }, "category_id": { "type": "string", - "description": "The ID of the item\u0027s category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead.", + "description": "The ID of the item\u0027s category, if any. Deprecated since 2024-01-18. Use `CatalogItem.categories`, instead.", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -28250,7 +28250,7 @@ "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) objects for this item. An item must have\nat least one variation." + "description": "A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) objects for this item. An item must have\nat least one variation." }, "product_type": { "type": "string", @@ -28328,7 +28328,7 @@ "x-is-beta": true } }, - "description": "A [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", + "description": "A [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", "x-release-status": "PUBLIC", "example": { "object": { @@ -28471,7 +28471,7 @@ }, "name": { "type": "string", - "description": "The item variation\u0027s name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem)\nuses [item options](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points." + "description": "The item variation\u0027s name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem)\nuses [item options](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points." }, "sku": { "type": "string", @@ -28571,12 +28571,12 @@ }, "stockable_conversion": { "$ref": "#/definitions/CatalogStockConversion", - "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogStockConversion) type,\nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion,\nyou can accurately track inventory when an item variation is sold in one unit, but stocked in\nanother unit.", + "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogStockConversion) type,\nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion,\nyou can accurately track inventory when an item variation is sold in one unit, but stocked in\nanother unit.", "x-release-status": "BETA", "x-is-beta": true } }, - "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine\u0027s inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", + "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine\u0027s inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", "x-release-status": "PUBLIC" }, "CatalogMeasurementUnit": { @@ -28777,7 +28777,7 @@ "additionalProperties": { "$ref": "#/definitions/CatalogCustomAttributeValue" }, - "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\u0027s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.)." + "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\u0027s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.)." }, "catalog_v1_ids": { "type": "array", @@ -29119,10 +29119,10 @@ }, "item_variations_for_item_option_values_query": { "$ref": "#/definitions/CatalogQueryItemVariationsForItemOptionValues", - "description": "A query expression to return item variations (of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs." + "description": "A query expression to return item variations (of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs." } }, - "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-objects).\nAny combination of the following types may be used together:\n- [exact_query](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogQueryExact)\n- [prefix_query](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogQueryPrefix)\n- [range_query](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogQueryRange)\n- [sorted_attribute_query](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogQuerySortedAttribute)\n- [text_query](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogQueryText)\n\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\nSearchable attribute and objects queryable by searchable attributes:\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", + "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-objects).\nAny combination of the following types may be used together:\n- [exact_query](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogQueryExact)\n- [prefix_query](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogQueryPrefix)\n- [range_query](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogQueryRange)\n- [sorted_attribute_query](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogQuerySortedAttribute)\n- [text_query](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogQueryText)\n\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\nSearchable attribute and objects queryable by searchable attributes:\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", "x-release-status": "PUBLIC" }, "CatalogQueryExact": { @@ -29383,7 +29383,7 @@ "stockable_item_variation_id": { "minLength": 1, "type": "string", - "description": "References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItem) of the converted `CatalogItemVariation.`" + "description": "References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItem) of the converted `CatalogItemVariation.`" }, "stockable_quantity": { "minLength": 1, @@ -29395,10 +29395,10 @@ "minLength": 1, "maxLength": 16, "type": "string", - "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point." + "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point." } }, - "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", + "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", "x-release-status": "BETA", "x-is-beta": true }, @@ -29417,7 +29417,7 @@ "items": { "$ref": "#/definitions/SubscriptionPhase" }, - "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2023-12-13/objects/SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error" + "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-01-18/objects/SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error" }, "subscription_plan_variations": { "type": "array", @@ -29464,7 +29464,7 @@ "items": { "$ref": "#/definitions/SubscriptionPhase" }, - "description": "A list containing each [SubscriptionPhase](https://developer.squareup.com/reference/square_2023-12-13/objects/SubscriptionPhase) for this plan variation." + "description": "A list containing each [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-01-18/objects/SubscriptionPhase) for this plan variation." }, "subscription_plan_id": { "type": "string", @@ -29598,7 +29598,7 @@ "description": "The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes\nplace on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the billing anchor date\nis changed immediately." } }, - "description": "Defines input parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/change-billing-anchor-date) endpoint.", + "description": "Defines input parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/change-billing-anchor-date) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -29629,7 +29629,7 @@ "description": "A list of a single billing anchor date change for the subscription." } }, - "description": "Defines output parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/change-billing-anchor-date) endpoint.", + "description": "Defines output parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/change-billing-anchor-date) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -29698,7 +29698,7 @@ }, "delay_capture": { "type": "boolean", - "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/capture-transaction) endpoint) or a Void\n(with the [VoidTransaction](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/void-transaction) endpoint).\n\nDefault value: `false`" + "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/capture-transaction) endpoint) or a Void\n(with the [VoidTransaction](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/void-transaction) endpoint).\n\nDefault value: `false`" }, "reference_id": { "maxLength": 40, @@ -29744,7 +29744,7 @@ "description": "A token generated by SqPaymentForm\u0027s verifyBuyer() that represents\ncustomer\u0027s device info and 3ds challenge result." } }, - "description": "Defines the parameters that can be included in the body of\na request to the [Charge](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/create-payment)", + "description": "Defines the parameters that can be included in the body of\na request to the [Charge](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/create-payment)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -29838,7 +29838,7 @@ "description": "The created transaction." } }, - "description": "Defines the fields that are included in the response body of\na request to the [Charge](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [Charge](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -30259,7 +30259,7 @@ "description": "A value you specify that uniquely identifies this clone request.\n\nIf you are unsure whether a particular order was cloned successfully,\nyou can reattempt the call with the same idempotency key without\nworrying about creating duplicate cloned orders.\nThe originally cloned order is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Defines the fields that are included in requests to the\n[CloneOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/clone-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[CloneOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/clone-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -30285,7 +30285,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/clone-order) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/clone-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -30569,7 +30569,7 @@ "x-is-beta": true } }, - "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/complete-payment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", + "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/complete-payment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -30590,7 +30590,7 @@ "description": "The successfully completed payment." } }, - "description": "Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/complete-payment).", + "description": "Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/complete-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -30782,7 +30782,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/create-booking-custom-attribute-definition) request.", + "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/create-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -30811,7 +30811,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/create-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/create-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -31031,7 +31031,7 @@ "description": "The card created by the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](https://developer.squareup.com/reference/square_2023-12-13/cards-api/create-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](https://developer.squareup.com/reference/square_2024-01-18/cards-api/create-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -31481,7 +31481,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -31512,7 +31512,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/create-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/create-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -31544,7 +31544,7 @@ "description": "The customer group to create." } }, - "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/create-customer-group) endpoint.", + "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/create-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -31569,7 +31569,7 @@ "description": "The successfully created customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -31928,14 +31928,14 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\u0027s locations." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\u0027s locations." }, "gift_card": { "$ref": "#/definitions/GiftCard", "description": "The gift card to create. The `type` field is required for this request. The `gan_source` \nand `gan` fields are included as follows: \n\nTo direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`.\n\nTo provide a custom GAN, include `gan_source` and `gan`.\n- For `gan_source`, specify `OTHER`. \n- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be \nunique for the seller and cannot start with the same bank identification number (BIN) as major \ncredit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly \nincrease the risk of fraud. It is the responsibility of the developer to ensure the security \nof their custom GANs. For more information, see \n[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). \n\nTo register an unused, physical gift card that the seller previously ordered from Square, \ninclude `gan` and provide the GAN that is printed on the gift card." } }, - "description": "Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2023-12-13/gift-cards-api/create-gift-card) request.", + "description": "Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2024-01-18/gift-cards-api/create-gift-card) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -32154,7 +32154,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/create-location-custom-attribute-definition) request.", + "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/create-location-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -32186,7 +32186,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/create-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/create-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -32212,7 +32212,7 @@ "description": "The initial values of the location being created. The `name` field is required and must be unique within a seller account.\nAll other fields are optional, but any information you care about for the location should be included.\nThe remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location)." } }, - "description": "The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2023-12-13/locations-api/create-location) endpoint.", + "description": "The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2024-01-18/locations-api/create-location) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -32244,7 +32244,7 @@ "description": "The newly created `Location` object." } }, - "description": "The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2023-12-13/locations-api/create-location) endpoint.", + "description": "The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2024-01-18/locations-api/create-location) endpoint.", "x-release-status": "PUBLIC", "example": { "location": { @@ -32361,7 +32361,7 @@ "description": "A unique identifier for this request, which is used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/create-loyalty-promotion) request.", + "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/create-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -32410,7 +32410,7 @@ "description": "The new loyalty promotion." } }, - "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/create-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/create-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -32524,7 +32524,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) request.", + "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -32556,7 +32556,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -33272,7 +33272,7 @@ }, "customer_id": { "type": "string", - "description": "The [Customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Cards API." + "description": "The [Customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Cards API." }, "location_id": { "type": "string", @@ -33280,7 +33280,7 @@ }, "team_member_id": { "type": "string", - "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) ID to associate with \nthis payment." + "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) ID to associate with \nthis payment." }, "reference_id": { "maxLength": 40, @@ -33331,7 +33331,7 @@ "description": "Details about the customer making the payment." } }, - "description": "Describes a request to create a payment using \n[CreatePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/create-payment).", + "description": "Describes a request to create a payment using \n[CreatePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/create-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -33368,7 +33368,7 @@ "description": "The newly created payment." } }, - "description": "Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/create-payment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", + "description": "Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/create-payment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", "x-release-status": "PUBLIC", "example": { "payment": { @@ -33455,7 +33455,7 @@ "minLength": 1, "maxLength": 192, "type": "string", - "description": "The ID of the tender to refund.\n\nA [`Transaction`](https://developer.squareup.com/reference/square_2023-12-13/objects/Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API." + "description": "The ID of the tender to refund.\n\nA [`Transaction`](https://developer.squareup.com/reference/square_2024-01-18/objects/Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API." }, "reason": { "maxLength": 192, @@ -33467,7 +33467,7 @@ "description": "The amount of money to refund.\n\nNote that you specify the amount in the\n__smallest denomination of the applicable currency__. For example, US dollar\namounts are specified in cents. See\n[Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.\n\nThis amount cannot exceed the amount that was originally charged to the\ntender that corresponds to `tender_id`." } }, - "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/create-refund) endpoint.\n\nDeprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/refund-payment)", + "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/create-refund) endpoint.\n\nDeprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/refund-payment)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -33505,7 +33505,7 @@ "description": "The created refund." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/create-refund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/create-refund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -33675,7 +33675,7 @@ "customer_id": { "minLength": 1, "type": "string", - "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) subscribing to the subscription plan variation." + "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) subscribing to the subscription plan variation." }, "start_date": { "type": "string", @@ -33696,7 +33696,7 @@ }, "card_id": { "type": "string", - "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) [card](https://developer.squareup.com/reference/square_2023-12-13/objects/Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription." + "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-01-18/objects/Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription." }, "timezone": { "type": "string", @@ -33724,7 +33724,7 @@ "description": "array of phases for this subscription" } }, - "description": "Defines input parameters in a request to the \n[CreateSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/create-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[CreateSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/create-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -33762,7 +33762,7 @@ "description": "The newly created subscription.\n\nFor more information, see\n[Subscription object](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#subscription-object)." } }, - "description": "Defines output parameters in a response from the\n[CreateSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/create-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[CreateSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/create-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -34106,14 +34106,14 @@ "minLength": 1, "maxLength": 128, "type": "string", - "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/create-vendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation." + "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/create-vendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation." }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The requested [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) to be created." + "description": "The requested [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) to be created." } }, - "description": "Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/create-vendor).", + "description": "Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/create-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -34154,10 +34154,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The successfully created [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) object." + "description": "The successfully created [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) object." } }, - "description": "Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/create-vendor).", + "description": "Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/create-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -34199,14 +34199,14 @@ "idempotency_key": { "maxLength": 45, "type": "string", - "description": "A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/create-webhook-subscription) request." + "description": "A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/create-webhook-subscription) request." }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to create." + "description": "The [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to create." } }, - "description": "Creates a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription).", + "description": "Creates a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription).", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions", @@ -34236,10 +34236,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The new [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)." + "description": "The new [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/create-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/create-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) will not be\npresent.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -34374,7 +34374,7 @@ "description": "A query expression to filter items or item variations by matching their custom attributes\u0027\n`boolean_value` property values against the specified Boolean expression.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified." } }, - "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-items)\nendpoint to search for items or item variations.", + "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-items)\nendpoint to search for items or item variations.", "x-release-status": "PUBLIC" }, "CustomField": { @@ -34398,7 +34398,7 @@ "properties": { "id": { "type": "string", - "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2023-12-13/customers-api/search-customers) \nor [ListCustomers](https://developer.squareup.com/reference/square_2023-12-13/customers-api/list-customers) endpoint." + "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2024-01-18/customers-api/search-customers) \nor [ListCustomers](https://developer.squareup.com/reference/square_2024-01-18/customers-api/list-customers) endpoint." }, "created_at": { "type": "string", @@ -34415,7 +34415,7 @@ "items": { "$ref": "#/definitions/Card" }, - "description": "Payment details of the credit, debit, and gift cards stored on file for the customer profile. \n\nDEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2023-12-13/cards-api/list-cards) (for credit and debit cards on file) \nor [ListGiftCards](https://developer.squareup.com/reference/square_2023-12-13/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter. \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).", + "description": "Payment details of the credit, debit, and gift cards stored on file for the customer profile. \n\nDEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2024-01-18/cards-api/list-cards) (for credit and debit cards on file) \nor [ListGiftCards](https://developer.squareup.com/reference/square_2024-01-18/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter. \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -34472,14 +34472,14 @@ "items": { "type": "string" }, - "description": "The IDs of [customer groups](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerGroup) the customer belongs to." + "description": "The IDs of [customer groups](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerGroup) the customer belongs to." }, "segment_ids": { "type": "array", "items": { "type": "string" }, - "description": "The IDs of [customer segments](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerSegment) the customer belongs to." + "description": "The IDs of [customer segments](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerSegment) the customer belongs to." }, "version": { "type": "integer", @@ -34506,7 +34506,7 @@ "description": "The country code to search for." } }, - "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", + "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", "x-release-status": "PUBLIC" }, "CustomerCreationSourceFilter": { @@ -34535,18 +34535,18 @@ "properties": { "key": { "type": "string", - "description": "The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api)." + "description": "The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api)." }, "filter": { "$ref": "#/definitions/CustomerCustomAttributeFilterValue", - "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api).\n\nYou must provide this `filter` field, the `updated_at` field, or both." + "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api).\n\nYou must provide this `filter` field, the `updated_at` field, or both." }, "updated_at": { "$ref": "#/definitions/TimeRange", "description": "The date range for when the custom attribute was last updated. The date range can include `start_at`, `end_at`, or\nboth. Range boundaries are inclusive. Dates are specified as RFC 3339 timestamps.\n\nYou must provide this `updated_at` field, the `filter` field, or both." } }, - "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute).", + "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute).", "x-release-status": "PUBLIC" }, "CustomerCustomAttributeFilterValue": { @@ -34566,7 +34566,7 @@ }, "selection": { "$ref": "#/definitions/FilterValue", - "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller." + "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller." }, "date": { "$ref": "#/definitions/TimeRange", @@ -34585,7 +34585,7 @@ "description": "A filter for a query based on the value of an `Address`-type custom attribute. The filter can include `postal_code`, `country`, or both." } }, - "description": "A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute).", + "description": "A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute).", "x-release-status": "PUBLIC" }, "CustomerCustomAttributeFilters": { @@ -34599,7 +34599,7 @@ "description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters." } }, - "description": "The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", + "description": "The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", "x-release-status": "PUBLIC" }, "CustomerDetails": { @@ -34646,18 +34646,18 @@ }, "group_ids": { "$ref": "#/definitions/FilterValue", - "description": "A filter to select customers based on the [groups](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerGroup) they belong to.\nGroup membership is controlled by sellers and developers.\n\nThe `group_ids` filter has the following syntax:\n```\n\"group_ids\": {\n\"any\": [\"{group_a_id}\", \"{group_b_id}\", ...],\n\"all\": [\"{group_1_id}\", \"{group_2_id}\", ...],\n\"none\": [\"{group_i_id}\", \"{group_ii_id}\", ...]\n}\n```\n\nYou can use any combination of the `any`, `all`, and `none` fields in the filter.\nWith `any`, the search returns customers in groups `a` or `b` or any other group specified in the list.\nWith `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list.\nWith `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list.\n\nIf any of the search conditions are not met, including when an invalid or non-existent group ID is provided,\nthe result is an empty object (`{}`)." + "description": "A filter to select customers based on the [groups](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerGroup) they belong to.\nGroup membership is controlled by sellers and developers.\n\nThe `group_ids` filter has the following syntax:\n```\n\"group_ids\": {\n\"any\": [\"{group_a_id}\", \"{group_b_id}\", ...],\n\"all\": [\"{group_1_id}\", \"{group_2_id}\", ...],\n\"none\": [\"{group_i_id}\", \"{group_ii_id}\", ...]\n}\n```\n\nYou can use any combination of the `any`, `all`, and `none` fields in the filter.\nWith `any`, the search returns customers in groups `a` or `b` or any other group specified in the list.\nWith `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list.\nWith `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list.\n\nIf any of the search conditions are not met, including when an invalid or non-existent group ID is provided,\nthe result is an empty object (`{}`)." }, "custom_attribute": { "$ref": "#/definitions/CustomerCustomAttributeFilters", - "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api). For example, you can call\n[RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/retrieve-customer-custom-attribute) using a customer ID from the result set." + "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api). For example, you can call\n[RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/retrieve-customer-custom-attribute) using a customer ID from the result set." }, "segment_ids": { "$ref": "#/definitions/FilterValue", - "description": " A filter to select customers based on the [segments](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerSegment) they belong to.\nSegment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria.\n\nYou can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields.\nFor the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C.\n\n```\n\"segment_ids\": {\n\"all\": [\"{segment_A_id}\", \"{segment_B_id}\"],\n\"none\": [\"{segment_C_id}\"]\n}\n```\n\nIf an invalid or non-existent segment ID is provided in the filter, Square stops processing the request\nand returns a `400 BAD_REQUEST` error that includes the segment ID." + "description": " A filter to select customers based on the [segments](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerSegment) they belong to.\nSegment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria.\n\nYou can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields.\nFor the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C.\n\n```\n\"segment_ids\": {\n\"all\": [\"{segment_A_id}\", \"{segment_B_id}\"],\n\"none\": [\"{segment_C_id}\"]\n}\n```\n\nIf an invalid or non-existent segment ID is provided in the filter, Square stops processing the request\nand returns a `400 BAD_REQUEST` error that includes the segment ID." } }, - "description": "Represents the filtering criteria in a [search query](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2023-12-13/customers-api/search-customers) results.", + "description": "Represents the filtering criteria in a [search query](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-01-18/customers-api/search-customers) results.", "x-release-status": "PUBLIC" }, "CustomerGroup": { @@ -34713,7 +34713,7 @@ "description": "Sorting criteria for query results. The default behavior is to sort \ncustomers alphabetically by `given_name` and `family_name`." } }, - "description": "Represents filtering and sorting criteria for a [SearchCustomers](https://developer.squareup.com/reference/square_2023-12-13/customers-api/search-customers) request.", + "description": "Represents filtering and sorting criteria for a [SearchCustomers](https://developer.squareup.com/reference/square_2024-01-18/customers-api/search-customers) request.", "x-release-status": "PUBLIC" }, "CustomerSegment": { @@ -34759,7 +34759,7 @@ "description": "Indicates the order in which results should be sorted based on the\nsort field value. Strings use standard alphabetic comparison\nto determine order. Strings representing numbers are sorted as strings.\n\nThe default value is `ASC`." } }, - "description": "Represents the sorting criteria in a [search query](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2023-12-13/customers-api/search-customers) results.", + "description": "Represents the sorting criteria in a [search query](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-01-18/customers-api/search-customers) results.", "x-release-status": "PUBLIC" }, "CustomerTaxIds": { @@ -34771,7 +34771,7 @@ "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only." } }, - "description": "Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "description": "Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC" }, "CustomerTextFilter": { @@ -34841,7 +34841,7 @@ "DeleteBookingCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/delete-booking-custom-attribute-definition) request.", + "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/delete-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -34860,7 +34860,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/delete-booking-custom-attribute-definition) response\ncontaining error messages when errors occurred during the request. The successful response does not contain any payload.", + "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/delete-booking-custom-attribute-definition) response\ncontaining error messages when errors occurred during the request. The successful response does not contain any payload.", "x-release-status": "PUBLIC", "example": { "errors": [] @@ -34869,7 +34869,7 @@ "DeleteBookingCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/delete-booking-custom-attribute) request.", + "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/delete-booking-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -34889,7 +34889,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/delete-booking-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/delete-booking-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "errors": [] @@ -35015,7 +35015,7 @@ "DeleteCustomerCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/delete-customer-custom-attribute-definition) request.", + "description": "Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/delete-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie" @@ -35039,7 +35039,7 @@ "DeleteCustomerCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/delete-customer-custom-attribute) request.", + "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/delete-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie" @@ -35056,14 +35056,14 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/delete-customer-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/delete-customer-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": {} }, "DeleteCustomerGroupRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/delete-customer-group) endpoint.", + "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/delete-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -35080,7 +35080,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/delete-customer-group) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/delete-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -35160,7 +35160,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2023-12-13/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2023-12-13/invoices-api/list-invoices)." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-01-18/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2024-01-18/invoices-api/list-invoices)." } }, "description": "Describes a `DeleteInvoice` request.", @@ -35184,7 +35184,7 @@ "DeleteLocationCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/delete-location-custom-attributeDefinition) request.", + "description": "Represents a [DeleteLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/delete-location-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35210,7 +35210,7 @@ "DeleteLocationCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/delete-location-custom-attribute) request.", + "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/delete-location-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35228,7 +35228,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/delete-location-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/delete-location-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -35260,7 +35260,7 @@ "DeleteMerchantCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/delete-merchant-custom-attributeDefinition) request.", + "description": "Represents a [DeleteMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/delete-merchant-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35286,7 +35286,7 @@ "DeleteMerchantCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/delete-merchant-custom-attribute) request.", + "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/delete-merchant-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35304,7 +35304,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/delete-merchant-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/delete-merchant-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -35440,7 +35440,7 @@ "DeleteSubscriptionActionRequest": { "type": "object", "properties": {}, - "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/delete-subscription-action)\nendpoint.", + "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/delete-subscription-action)\nendpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -35459,7 +35459,7 @@ "description": "The subscription that has the specified action deleted." } }, - "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/delete-subscription-action)\nendpoint.", + "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/delete-subscription-action)\nendpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35492,7 +35492,7 @@ "DeleteWebhookSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Deletes a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription).", + "description": "Deletes a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription).", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5" @@ -35509,7 +35509,7 @@ "description": "Information on errors encountered during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/delete-webhook-subscription) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/delete-webhook-subscription) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -36107,7 +36107,7 @@ "description": "The retrieved card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](https://developer.squareup.com/reference/square_2023-12-13/cards-api/disable-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](https://developer.squareup.com/reference/square_2024-01-18/cards-api/disable-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -36573,7 +36573,7 @@ "x-read-only": true } }, - "description": "An employee object that is used by the external API.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMember](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember).", + "description": "An employee object that is used by the external API.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMember](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -36597,7 +36597,7 @@ "description": "Can be a custom-set hourly wage or the calculated effective hourly\nwage based on the annual wage and hours worked per week." } }, - "description": "The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMemberWage).", + "description": "The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMemberWage).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -37596,7 +37596,7 @@ "GetPaymentRefundRequest": { "type": "object", "properties": {}, - "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/get-payment-refund).", + "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/get-payment-refund).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -37617,7 +37617,7 @@ "description": "The requested `PaymentRefund`." } }, - "description": "Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/get-payment-refund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", + "description": "Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/get-payment-refund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", "x-release-status": "PUBLIC", "example": { "refund": { @@ -37649,7 +37649,7 @@ "GetPaymentRequest": { "type": "object", "properties": {}, - "description": "Describes a request to retrieve a payment using \n[GetPayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/get-payment).", + "description": "Describes a request to retrieve a payment using \n[GetPayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/get-payment).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -37670,7 +37670,7 @@ "description": "The requested `Payment`." } }, - "description": "Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/get-payment).", + "description": "Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/get-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -38088,7 +38088,7 @@ "maxLength": 191, "type": "string" }, - "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) to whom this gift card is linked.", + "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) to whom this gift card is linked.", "x-read-only": true } }, @@ -38113,7 +38113,7 @@ }, "location_id": { "type": "string", - "description": "The ID of the [business location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the activity occurred." + "description": "The ID of the [business location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the activity occurred." }, "created_at": { "type": "string", @@ -38143,7 +38143,7 @@ }, "redeem_activity_details": { "$ref": "#/definitions/GiftCardActivityRedeem", - "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/create-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) to create the `REDEEM` activity." + "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/create-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) to create the `REDEEM` activity." }, "clear_balance_activity_details": { "$ref": "#/definitions/GiftCardActivityClearBalance", @@ -38163,7 +38163,7 @@ }, "refund_activity_details": { "$ref": "#/definitions/GiftCardActivityRefund", - "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that process payments using the Square Payments API, Square creates a `REFUND` activity that \nupdates the gift card balance after the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/refund-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) to create the `REFUND` activity." + "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that process payments using the Square Payments API, Square creates a `REFUND` activity that \nupdates the gift card balance after the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/refund-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) to create the `REFUND` activity." }, "unlinked_activity_refund_activity_details": { "$ref": "#/definitions/GiftCardActivityUnlinkedActivityRefund", @@ -38200,7 +38200,7 @@ "x-read-only": true } }, - "description": "Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", + "description": "Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", "x-release-status": "PUBLIC" }, "GiftCardActivityActivate": { @@ -38208,15 +38208,15 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "line_item_uid": { "type": "string", - "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "reference_id": { "type": "string", @@ -38227,10 +38227,10 @@ "items": { "type": "string" }, - "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." + "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." } }, - "description": "Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustDecrement": { @@ -38249,7 +38249,7 @@ "description": "The reason to decrease the gift card balance." } }, - "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustIncrement": { @@ -38268,7 +38268,7 @@ "description": "The reason to increase the balance." } }, - "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityBlock": { @@ -38282,7 +38282,7 @@ "description": "The reason to block the gift card." } }, - "description": "Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityClearBalance": { @@ -38296,7 +38296,7 @@ "description": "The reason to decrease the gift card balance." } }, - "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityDeactivate": { @@ -38310,7 +38310,7 @@ "description": "The reason to decrease the balance." } }, - "description": "Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityImport": { @@ -38324,7 +38324,7 @@ "description": "The balance amount on the imported gift card." } }, - "description": "Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", + "description": "Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", "x-release-status": "PUBLIC" }, "GiftCardActivityImportReversal": { @@ -38338,7 +38338,7 @@ "description": "The amount of money cleared from the third-party gift card when \nthe import was reversed." } }, - "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityLoad": { @@ -38346,15 +38346,15 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "line_item_uid": { "type": "string", - "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "reference_id": { "type": "string", @@ -38365,10 +38365,10 @@ "items": { "type": "string" }, - "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." + "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks." } }, - "description": "Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityRedeem": { @@ -38379,7 +38379,7 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2023-12-13/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-01-18/gift-card-activities-api/create-gift-card-activity) request." }, "payment_id": { "type": "string", @@ -38396,7 +38396,7 @@ "x-read-only": true } }, - "description": "Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityRefund": { @@ -38404,7 +38404,7 @@ "properties": { "redeem_activity_id": { "type": "string", - "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/refund-payment) request \nrepresents a redemption made by the same gift card. Note that you must use `RefundPayment` \nto refund a gift card payment to the same gift card if the payment was processed by Square.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card." + "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/refund-payment) request \nrepresents a redemption made by the same gift card. Note that you must use `RefundPayment` \nto refund a gift card payment to the same gift card if the payment was processed by Square.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card." }, "amount_money": { "$ref": "#/definitions/Money", @@ -38420,7 +38420,7 @@ "x-read-only": true } }, - "description": "Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityTransferBalanceFrom": { @@ -38439,7 +38439,7 @@ "description": "The amount deducted from the gift card for the transfer. This value is a positive integer." } }, - "description": "Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityTransferBalanceTo": { @@ -38458,7 +38458,7 @@ "description": "The amount added to the gift card balance for the transfer. This value is a positive integer." } }, - "description": "Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnblock": { @@ -38472,7 +38472,7 @@ "description": "The reason to unblock a gift card." } }, - "description": "Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnlinkedActivityRefund": { @@ -38495,7 +38495,7 @@ "x-read-only": true } }, - "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType).", + "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "InventoryAdjustment": { @@ -38513,26 +38513,26 @@ }, "from_state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2023-12-13/enums/InventoryState) of the related quantity\nof items before the adjustment." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-01-18/enums/InventoryState) of the related quantity\nof items before the adjustment." }, "to_state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2023-12-13/enums/InventoryState) of the related quantity\nof items after the adjustment." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-01-18/enums/InventoryState) of the related quantity\nof items after the adjustment." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the related\nquantity of items is being tracked." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "quantity": { "maxLength": 26, @@ -38563,23 +38563,23 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2023-12-13/objects/Employee) responsible for the\ninventory adjustment." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-01-18/objects/Employee) responsible for the\ninventory adjustment." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) responsible for the\ninventory adjustment." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) responsible for the\ninventory adjustment." }, "transaction_id": { "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2023-12-13/objects/Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", + "description": "The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2024-01-18/objects/Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", "x-read-only": true }, "refund_id": { "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2023-12-13/objects/Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", + "description": "The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2024-01-18/objects/Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", "x-read-only": true }, "purchase_order_id": { @@ -38640,7 +38640,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](https://developer.squareup.com/reference/square_2023-12-13/enums/InventoryChangeType) for all possible values." + "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](https://developer.squareup.com/reference/square_2024-01-18/enums/InventoryChangeType) for all possible values." }, "physical_count": { "$ref": "#/definitions/InventoryPhysicalCount", @@ -38652,20 +38652,20 @@ }, "transfer": { "$ref": "#/definitions/InventoryTransfer", - "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-change-inventory) endpoint when the seller has an active Retail Plus subscription." + "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-change-inventory) endpoint when the seller has an active Retail Plus subscription." }, "measurement_unit": { "$ref": "#/definitions/CatalogMeasurementUnit", - "description": "The [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "description": "The [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "x-read-only": true }, "measurement_unit_id": { "type": "string", - "description": "The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "description": "The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "x-read-only": true } }, - "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) instance.", + "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) instance.", "x-release-status": "PUBLIC" }, "InventoryCount": { @@ -38674,21 +38674,21 @@ "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "state": { "type": "string", - "description": "The current [inventory state](https://developer.squareup.com/reference/square_2023-12-13/enums/InventoryState) for the related\nquantity of items." + "description": "The current [inventory state](https://developer.squareup.com/reference/square_2024-01-18/enums/InventoryState) for the related\nquantity of items." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the related\nquantity of items is being tracked." }, "quantity": { "maxLength": 26, @@ -38703,7 +38703,7 @@ }, "is_estimated": { "type": "boolean", - "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-change-inventory),\n[BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-retrieve-inventory-changes),\n[BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/batch-retrieve-inventory-counts), and\n[RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2023-12-13/inventory-api/retrieve-inventory-changes).", + "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-change-inventory),\n[BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-retrieve-inventory-changes),\n[BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/batch-retrieve-inventory-counts), and\n[RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-01-18/inventory-api/retrieve-inventory-changes).", "x-release-status": "BETA", "x-is-beta": true, "x-read-only": true @@ -38718,31 +38718,31 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryPhysicalCount)." + "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryPhysicalCount)." }, "reference_id": { "maxLength": 255, "type": "string", - "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryPhysicalCount) to an external\nsystem." + "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryPhysicalCount) to an external\nsystem." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "state": { "type": "string", - "description": "The current [inventory state](https://developer.squareup.com/reference/square_2023-12-13/enums/InventoryState) for the related\nquantity of items." + "description": "The current [inventory state](https://developer.squareup.com/reference/square_2024-01-18/enums/InventoryState) for the related\nquantity of items." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the related\nquantity of items is being tracked." }, "quantity": { "maxLength": 26, @@ -38757,12 +38757,12 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2023-12-13/objects/Employee) responsible for the\nphysical count." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-01-18/objects/Employee) responsible for the\nphysical count." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) responsible for the\nphysical count." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) responsible for the\nphysical count." }, "occurred_at": { "maxLength": 34, @@ -38794,27 +38794,27 @@ }, "state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2023-12-13/enums/InventoryState) for the quantity of\nitems being transferred." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-01-18/enums/InventoryState) for the quantity of\nitems being transferred." }, "from_location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the related\nquantity of items was tracked before the transfer." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the related\nquantity of items was tracked before the transfer." }, "to_location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the related\nquantity of items was tracked after the transfer." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the related\nquantity of items was tracked after the transfer." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "quantity": { "maxLength": 26, @@ -38840,12 +38840,12 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2023-12-13/objects/Employee) responsible for the\ninventory transfer." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-01-18/objects/Employee) responsible for the\ninventory transfer." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) responsible for the\ninventory transfer." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) responsible for the\ninventory transfer." } }, "description": "Represents the transfer of a quantity of product inventory at a\nparticular time from one location to another.", @@ -38873,7 +38873,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/retrieve-order) endpoint using the order ID." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/retrieve-order) endpoint using the order ID." }, "primary_recipient": { "$ref": "#/definitions/InvoiceRecipient", @@ -38955,7 +38955,7 @@ }, "subscription_id": { "type": "string", - "description": "The ID of the [subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", + "description": "The ID of the [subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", "x-read-only": true }, "sale_or_service_date": { @@ -38997,10 +38997,10 @@ }, "cash_app_pay": { "type": "boolean", - "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) in the United States." + "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) in the United States." } }, - "description": "The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) on the Square-hosted invoice payment page.", + "description": "The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) on the Square-hosted invoice payment page.", "x-release-status": "PUBLIC" }, "InvoiceCustomField": { @@ -39089,7 +39089,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice)." + "description": "The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice)." }, "request_method": { "type": "string", @@ -39125,7 +39125,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](https://developer.squareup.com/reference/square_2023-12-13/cards-api/list-cards) and include the `customer_id` of the invoice recipient." + "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](https://developer.squareup.com/reference/square_2024-01-18/cards-api/list-cards) and include the `customer_id` of the invoice recipient." }, "reminders": { "type": "array", @@ -39150,7 +39150,7 @@ "x-read-only": true } }, - "description": "Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", + "description": "Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC" }, "InvoiceQuery": { @@ -39472,7 +39472,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/list-booking-custom-attribute-definitions) request.", + "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/list-booking-custom-attribute-definitions) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -39502,7 +39502,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/list-booking-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/list-booking-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definitions": [ @@ -39550,10 +39550,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/list-booking-custom-attributes) request.", + "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/list-booking-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -39583,7 +39583,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/list-booking-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/list-booking-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "PUBLIC", "example": { "custom_attributes": [ @@ -39626,7 +39626,7 @@ "minLength": 0, "maxLength": 192, "type": "string", - "description": "The [customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved." + "description": "The [customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved." }, "team_member_id": { "minLength": 0, @@ -39832,7 +39832,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListCards](https://developer.squareup.com/reference/square_2023-12-13/cards-api/list-cards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListCards](https://developer.squareup.com/reference/square_2024-01-18/cards-api/list-cards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "cards": [ @@ -40083,12 +40083,12 @@ }, "types": { "type": "string", - "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2023-12-13/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-01-18/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." }, "catalog_version": { "type": "integer", "format": "int64", - "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", "x-release-status": "BETA", "x-is-beta": true } @@ -40184,7 +40184,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?limit\u003d2" @@ -40212,7 +40212,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definitions": [ @@ -40259,10 +40259,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/list-customer-custom-attributes) request.", + "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/list-customer-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR" @@ -40290,7 +40290,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/list-customer-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/list-customer-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "PUBLIC", "example": { "custom_attributes": [ @@ -40327,7 +40327,7 @@ "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/list-customer-groups) endpoint.", + "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/list-customer-groups) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -40355,7 +40355,7 @@ "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint. This value is present only if the request\nsucceeded and additional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "groups": [ @@ -41125,7 +41125,7 @@ }, "type": { "type": "string", - "description": "If a [type](https://developer.squareup.com/reference/square_2023-12-13/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." + "description": "If a [type](https://developer.squareup.com/reference/square_2024-01-18/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." }, "location_id": { "type": "string", @@ -41234,11 +41234,11 @@ "properties": { "type": { "type": "string", - "description": "If a [type](https://developer.squareup.com/reference/square_2023-12-13/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." + "description": "If a [type](https://developer.squareup.com/reference/square_2024-01-18/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." }, "state": { "type": "string", - "description": "If a [state](https://developer.squareup.com/reference/square_2023-12-13/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." + "description": "If a [state](https://developer.squareup.com/reference/square_2024-01-18/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." }, "limit": { "maximum": 200, @@ -41571,7 +41571,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/list-location-custom-attribute-definitions) request.", + "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/list-location-custom-attribute-definitions) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -41600,7 +41600,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/list-location-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/list-location-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -41652,10 +41652,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/list-location-custom-attributes) request.", + "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/list-location-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -41684,7 +41684,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/list-location-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/list-location-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -41711,7 +41711,7 @@ "ListLocationsRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in requests to the\n[ListLocations](https://developer.squareup.com/reference/square_2023-12-13/locations-api/list-locations) endpoint.", + "description": "Defines the fields that are included in requests to the\n[ListLocations](https://developer.squareup.com/reference/square_2024-01-18/locations-api/list-locations) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -41733,7 +41733,7 @@ "description": "The business locations." } }, - "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](https://developer.squareup.com/reference/square_2023-12-13/locations-api/list-locations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](https://developer.squareup.com/reference/square_2024-01-18/locations-api/list-locations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "locations": [ @@ -41897,7 +41897,7 @@ "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/list-loyalty-promotions) request.", + "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/list-loyalty-promotions) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -41926,7 +41926,7 @@ "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/list-loyalty-promotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", + "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/list-loyalty-promotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", "x-release-status": "PUBLIC", "example": { "loyalty_promotions": [ @@ -42017,7 +42017,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) request.", + "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42046,7 +42046,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42098,10 +42098,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/list-merchant-custom-attributes) request.", + "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/list-merchant-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42130,7 +42130,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/list-merchant-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/list-merchant-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42162,7 +42162,7 @@ "description": "The cursor generated by the previous response." } }, - "description": "Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2023-12-13/merchants-api/list-merchants) endpoint.", + "description": "Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2024-01-18/merchants-api/list-merchants) endpoint.", "x-release-status": "PUBLIC" }, "ListMerchantsResponse": { @@ -42187,7 +42187,7 @@ "description": "If the response is truncated, the cursor to use in next request to fetch next set of objects." } }, - "description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2023-12-13/merchants-api/list-merchants) endpoint.", + "description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2024-01-18/merchants-api/list-merchants) endpoint.", "x-release-status": "PUBLIC", "example": { "merchant": [ @@ -42320,7 +42320,7 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." } }, "description": "Represents a list request for order custom attributes.", @@ -42460,7 +42460,7 @@ }, "status": { "type": "string", - "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2023-12-13/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-01-18/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." }, "source_type": { "type": "string", @@ -42471,7 +42471,7 @@ "description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100" } }, - "description": "Describes a request to list refunds using\n[ListPaymentRefunds](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/list-payment-refunds).\n\nThe maximum results per page is 100.", + "description": "Describes a request to list refunds using\n[ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/list-payment-refunds).\n\nThe maximum results per page is 100.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -42499,7 +42499,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/list-payment-refunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", + "description": "Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/list-payment-refunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "refunds": [ @@ -42573,7 +42573,7 @@ "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`" } }, - "description": "Describes a request to list payments using \n[ListPayments](https://developer.squareup.com/reference/square_2023-12-13/payments-api/list-payments). \n\nThe maximum results per page is 100.", + "description": "Describes a request to list payments using \n[ListPayments](https://developer.squareup.com/reference/square_2024-01-18/payments-api/list-payments). \n\nThe maximum results per page is 100.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -42601,7 +42601,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2023-12-13/payments-api/list-payments).", + "description": "Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2024-01-18/payments-api/list-payments).", "x-release-status": "PUBLIC", "example": { "payments": [ @@ -42906,7 +42906,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/list-refunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2023-12-13/orders-api/search-orders)", + "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/list-refunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-01-18/orders-api/search-orders)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -42943,7 +42943,7 @@ "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -43042,7 +43042,7 @@ "description": "The upper limit on the number of subscription events to return\nin a paged response." } }, - "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/list-subscription-events)\nendpoint.", + "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/list-subscription-events)\nendpoint.", "x-release-status": "PUBLIC" }, "ListSubscriptionEventsResponse": { @@ -43067,7 +43067,7 @@ "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of events.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/list-subscription-events).", + "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/list-subscription-events).", "x-release-status": "PUBLIC", "example": { "subscription_events": [ @@ -43309,7 +43309,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/list-transactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2023-12-13/orders-api/search-orders)", + "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/list-transactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-01-18/orders-api/search-orders)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -43346,7 +43346,7 @@ "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/list-transactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/list-transactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -43470,10 +43470,10 @@ "items": { "$ref": "#/definitions/EventTypeMetadata" }, - "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2023-12-13/objects/EventTypeMetadata)." + "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-01-18/objects/EventTypeMetadata)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/list-webhook-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/list-webhook-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "event_types": [ @@ -43498,11 +43498,11 @@ }, "include_disabled": { "type": "boolean", - "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)s are returned." + "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)s are returned." }, "sort_order": { "type": "string", - "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." + "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." }, "limit": { "maximum": 100, @@ -43511,7 +43511,7 @@ "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100" } }, - "description": "Lists all [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)s owned by your application.", + "description": "Lists all [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)s owned by your application.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions" @@ -43532,14 +43532,14 @@ "items": { "$ref": "#/definitions/WebhookSubscription" }, - "description": "The requested list of [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)s." + "description": "The requested list of [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)s." }, "cursor": { "type": "string", "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/list-webhook-subscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/list-webhook-subscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "subscriptions": [ @@ -43643,7 +43643,7 @@ "items": { "type": "string" }, - "description": "The Square features that are enabled for the location.\nSee [LocationCapability](https://developer.squareup.com/reference/square_2023-12-13/enums/LocationCapability) for possible values.", + "description": "The Square features that are enabled for the location.\nSee [LocationCapability](https://developer.squareup.com/reference/square_2024-01-18/enums/LocationCapability) for possible values.", "x-read-only": true }, "status": { @@ -43665,7 +43665,7 @@ }, "country": { "type": "string", - "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](https://developer.squareup.com/reference/square_2023-12-13/enums/Country) for possible values.", + "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](https://developer.squareup.com/reference/square_2024-01-18/enums/Country) for possible values.", "x-read-only": true }, "language_code": { @@ -43676,7 +43676,7 @@ }, "currency": { "type": "string", - "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](https://developer.squareup.com/reference/square_2023-12-13/enums/Currency) for possible values.", + "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](https://developer.squareup.com/reference/square_2024-01-18/enums/Currency) for possible values.", "x-read-only": true }, "phone_number": { @@ -43774,7 +43774,7 @@ "properties": { "location_id": { "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location)." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location)." }, "booking_site_url": { "type": "string", @@ -43804,7 +43804,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram) to which the account belongs." + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram) to which the account belongs." }, "balance": { "type": "integer", @@ -43819,7 +43819,7 @@ }, "customer_id": { "type": "string", - "description": "The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) that is associated with the account." + "description": "The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) that is associated with the account." }, "enrolled_at": { "type": "string", @@ -43847,7 +43847,7 @@ "description": "The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. \n\nThe total number of points in this field equals the number of points in the `balance` field." } }, - "description": "Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", + "description": "Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", "x-release-status": "PUBLIC" }, "LoyaltyAccountExpiringPointDeadline": { @@ -43948,12 +43948,12 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount) associated with the event.", + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount) associated with the event.", "x-read-only": true }, "location_id": { "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the event occurred.", + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the event occurred.", "x-read-only": true }, "source": { @@ -43986,7 +43986,7 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -43996,7 +43996,7 @@ }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders." } }, "description": "Provides metadata when the event `type` is `ACCUMULATE_POINTS`.", @@ -44012,14 +44012,14 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "loyalty_promotion_id": { "minLength": 1, "maxLength": 255, "type": "string", - "description": "The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion).", + "description": "The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion).", "x-read-only": true }, "points": { @@ -44030,7 +44030,7 @@ "order_id": { "minLength": 1, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", "x-read-only": true } }, @@ -44046,7 +44046,7 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -44072,13 +44072,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "points": { @@ -44116,13 +44116,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "points": { @@ -44146,7 +44146,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -44197,7 +44197,7 @@ "minLength": 1, "type": "string" }, - "description": "The [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." + "description": "The [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." } }, "description": "Filter events by location.", @@ -44212,7 +44212,7 @@ "loyalty_account_id": { "minLength": 1, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount) associated with loyalty events." + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount) associated with loyalty events." } }, "description": "Filter events by loyalty account.", @@ -44227,7 +44227,7 @@ "order_id": { "minLength": 1, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) associated with the event." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) associated with the event." } }, "description": "Filter events by the order associated with the event.", @@ -44244,7 +44244,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -44276,18 +44276,18 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", "x-read-only": true } }, @@ -44348,7 +44348,7 @@ "minLength": 1, "type": "string" }, - "description": "The [locations](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) at which the program is active." + "description": "The [locations](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) at which the program is active." }, "created_at": { "type": "string", @@ -44365,7 +44365,7 @@ "items": { "$ref": "#/definitions/LoyaltyProgramAccrualRule" }, - "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/list-loyalty-promotions)." + "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/list-loyalty-promotions)." } }, "description": "Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. \nSquare sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. \nFor more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).", @@ -44403,7 +44403,7 @@ "description": "Additional data for rules with the `CATEGORY` accrual type." } }, - "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram).", + "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram).", "x-release-status": "PUBLIC" }, "LoyaltyProgramAccrualRuleCategoryData": { @@ -44415,7 +44415,7 @@ "category_id": { "minLength": 1, "type": "string", - "description": "The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) that buyers can purchase to earn\npoints." + "description": "The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) that buyers can purchase to earn\npoints." } }, "description": "Represents additional data for rules with the `CATEGORY` accrual type.", @@ -44430,7 +44430,7 @@ "item_variation_id": { "minLength": 1, "type": "string", - "description": "The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject) that buyers can purchase to earn\npoints." + "description": "The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject) that buyers can purchase to earn\npoints." } }, "description": "Represents additional data for rules with the `ITEM_VARIATION` accrual type.", @@ -44452,14 +44452,14 @@ "items": { "type": "string" }, - "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded categories." + "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded categories." }, "excluded_item_variation_ids": { "type": "array", "items": { "type": "string" }, - "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded item variations." + "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded item variations." }, "tax_mode": { "type": "string", @@ -44584,7 +44584,7 @@ }, "pricing_rule_reference": { "$ref": "#/definitions/CatalogObjectReference", - "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/retrieve-catalog-object) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details)." + "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/retrieve-catalog-object) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details)." } }, "description": "Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers.", @@ -44668,7 +44668,7 @@ }, "loyalty_program_id": { "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram) associated with the promotion.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram) associated with the promotion.", "x-read-only": true }, "minimum_spend_amount_money": { @@ -44681,7 +44681,7 @@ "minLength": 1, "type": "string" }, - "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both." + "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both." }, "qualifying_category_ids": { "type": "array", @@ -44689,10 +44689,10 @@ "minLength": 1, "type": "string" }, - "description": "The IDs of any qualifying `CATEGORY` [catalog objects](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both." + "description": "The IDs of any qualifying `CATEGORY` [catalog objects](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both." } }, - "description": "Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", + "description": "Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionAvailableTimeData": { @@ -44719,7 +44719,7 @@ "description": "A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)\n(`VEVENT`). Each event represents an available time period per day or days of the week. \nA day can have a maximum of one available time period.\n\nOnly `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and\ntimestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,\nan end date (using the `UNTIL` keyword), or both. For more information, see\n[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).\n\nNote that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request\nbut are always included in the response." } }, - "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion).", + "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentive": { @@ -44741,7 +44741,7 @@ "description": "Additional data for a `POINTS_ADDITION` incentive type." } }, - "description": "Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", + "description": "Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentivePointsAdditionData": { @@ -44756,7 +44756,7 @@ "description": "The number of additional points to earn each time the promotion is triggered. For example,\nsuppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also\nqualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer\nearns a total of 8 points (5 program points + 3 promotion points \u003d 8 points)." } }, - "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotionIncentive).", + "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentivePointsMultiplierData": { @@ -44776,7 +44776,7 @@ "description": "The multiplier used to calculate the number of points earned each time the promotion is triggered,\nspecified as a string representation of a decimal. Square supports multipliers up to 10x, with three\npoint precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the\nbase loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a\n`multiplier` of \"1.5\", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier \u003d 6 points).\nFractional points are dropped.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) This `multiplier` field.\n- The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value." } }, - "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotionIncentive).", + "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionTriggerLimit": { @@ -44796,7 +44796,7 @@ "description": "The time period the limit applies to." } }, - "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", + "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", "x-release-status": "PUBLIC" }, "LoyaltyReward": { @@ -44821,13 +44821,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount) to which the reward belongs." + "description": "The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount) to which the reward belongs." }, "reward_tier_id": { "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgramRewardTier) used to create the reward." + "description": "The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgramRewardTier) used to create the reward." }, "points": { "minimum": 1, @@ -44837,7 +44837,7 @@ }, "order_id": { "type": "string", - "description": "The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) to which the reward is attached." + "description": "The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) to which the reward is attached." }, "created_at": { "type": "string", @@ -44855,7 +44855,7 @@ "x-read-only": true } }, - "description": "Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", + "description": "Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", "x-release-status": "PUBLIC" }, "MeasurementUnit": { @@ -44989,7 +44989,7 @@ }, "currency": { "type": "string", - "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2023-12-13/enums/Currency) for possible values." + "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2024-01-18/enums/Currency) for possible values." } }, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", @@ -45189,7 +45189,7 @@ "customer_id": { "maxLength": 191, "type": "string", - "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", + "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "x-release-status": "BETA", "x-is-beta": true }, @@ -45300,7 +45300,7 @@ }, "closed_at": { "type": "string", - "description": "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2023-12-13/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", + "description": "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2024-01-18/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", "x-read-only": true }, "state": { @@ -45347,7 +45347,7 @@ }, "pricing_options": { "$ref": "#/definitions/OrderPricingOptions", - "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogPricingRule)." + "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogPricingRule)." }, "rewards": { "type": "array", @@ -45428,7 +45428,7 @@ "description": "The location ID the order belongs to." } }, - "description": "A lightweight description of an [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) that is returned when \n`returned_entries` is `true` on a [SearchOrdersRequest](https://developer.squareup.com/reference/square_2023-12-13/orders-api/search-orders).", + "description": "A lightweight description of an [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) that is returned when \n`returned_entries` is `true` on a [SearchOrdersRequest](https://developer.squareup.com/reference/square_2024-01-18/orders-api/search-orders).", "x-release-status": "PUBLIC" }, "OrderFulfillment": { @@ -45974,7 +45974,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) ID applied to this line item." + "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) ID applied to this line item." }, "catalog_version": { "type": "integer", @@ -46004,7 +46004,7 @@ "items": { "$ref": "#/definitions/OrderLineItemModifier" }, - "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier)s applied to this line item." + "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier)s applied to this line item." }, "applied_taxes": { "type": "array", @@ -46173,7 +46173,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogDiscount)." + "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogDiscount)." }, "catalog_version": { "type": "integer", @@ -46227,7 +46227,7 @@ }, "pricing_rule_id": { "type": "string", - "description": "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", + "description": "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "x-read-only": true } }, @@ -46247,7 +46247,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier)." + "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier)." }, "catalog_version": { "type": "integer", @@ -46265,7 +46265,7 @@ }, "base_price_money": { "$ref": "#/definitions/Money", - "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier) price." + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier) price." }, "total_price_money": { "$ref": "#/definitions/Money", @@ -46282,7 +46282,7 @@ "x-is-beta": true } }, - "description": "A [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier).", + "description": "A [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier).", "x-release-status": "PUBLIC" }, "OrderLineItemPricingBlocklists": { @@ -46366,7 +46366,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTax)." + "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTax)." }, "catalog_version": { "type": "integer", @@ -46457,7 +46457,7 @@ "x-is-beta": true } }, - "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogPricingRule).", + "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogPricingRule).", "x-release-status": "PUBLIC" }, "OrderQuantityUnit": { @@ -46465,7 +46465,7 @@ "properties": { "measurement_unit": { "$ref": "#/definitions/MeasurementUnit", - "description": "A [MeasurementUnit](https://developer.squareup.com/reference/square_2023-12-13/objects/MeasurementUnit) that represents the\nunit of measure for the quantity." + "description": "A [MeasurementUnit](https://developer.squareup.com/reference/square_2024-01-18/objects/MeasurementUnit) that represents the\nunit of measure for the quantity." }, "precision": { "type": "integer", @@ -46473,7 +46473,7 @@ }, "catalog_object_id": { "type": "string", - "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit." + "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit." }, "catalog_version": { "type": "integer", @@ -46554,7 +46554,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogDiscount)." + "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogDiscount)." }, "catalog_version": { "type": "integer", @@ -46631,7 +46631,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) ID applied to this return line item." + "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) ID applied to this return line item." }, "catalog_version": { "type": "integer", @@ -46652,7 +46652,7 @@ "items": { "$ref": "#/definitions/OrderReturnLineItemModifier" }, - "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier)s applied to this line item." + "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier)s applied to this line item." }, "applied_taxes": { "type": "array", @@ -46730,7 +46730,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier)." + "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier)." }, "catalog_version": { "type": "integer", @@ -46744,7 +46744,7 @@ }, "base_price_money": { "$ref": "#/definitions/Money", - "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogModifier) price." + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogModifier) price." }, "total_price_money": { "$ref": "#/definitions/Money", @@ -46783,7 +46783,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2023-12-13/objects/OrderServiceCharge)." + "description": "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2024-01-18/objects/OrderServiceCharge)." }, "catalog_version": { "type": "integer", @@ -46865,7 +46865,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogTax)." + "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogTax)." }, "catalog_version": { "type": "integer", @@ -46960,7 +46960,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)." + "description": "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)." }, "catalog_version": { "type": "integer", @@ -47134,7 +47134,7 @@ "description": "The user-provided reason to pause the subscription." } }, - "description": "Defines input parameters in a request to the\n[PauseSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/pause-subscription) endpoint.", + "description": "Defines input parameters in a request to the\n[PauseSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/pause-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -47160,7 +47160,7 @@ "description": "The list of a `PAUSE` action and a possible `RESUME` action created by the request." } }, - "description": "Defines output parameters in a response from the\n[PauseSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/pause-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[PauseSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/pause-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -47217,10 +47217,10 @@ "items": { "type": "string" }, - "description": "The IDs of the [payments](https://developer.squareup.com/reference/square_2023-12-13/objects/Payment) to collect.\nThe payment total must match the order total." + "description": "The IDs of the [payments](https://developer.squareup.com/reference/square_2024-01-18/objects/Payment) to collect.\nThe payment total must match the order total." } }, - "description": "Defines the fields that are included in requests to the\n[PayOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/pay-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[PayOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/pay-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -47245,10 +47245,10 @@ }, "order": { "$ref": "#/definitions/Order", - "description": "The paid, updated [order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order)." + "description": "The paid, updated [order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order)." } }, - "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/pay-order) endpoint.", + "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/pay-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -47562,7 +47562,7 @@ "team_member_id": { "maxLength": 192, "type": "string", - "description": "An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) associated with taking the payment.", + "description": "An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) associated with taking the payment.", "x-read-only": true }, "refund_ids": { @@ -48430,7 +48430,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." }, "idempotency_key": { "maxLength": 128, @@ -48663,7 +48663,7 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) where the reward is redeemed." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) where the reward is redeemed." } }, "description": "A request to redeem a loyalty reward.", @@ -48816,7 +48816,7 @@ }, "customer_id": { "type": "string", - "description": "The [Customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Cards\nAPI. Only allowed when `unlinked\u003dtrue`." + "description": "The [Customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Cards\nAPI. Only allowed when `unlinked\u003dtrue`." }, "reason": { "maxLength": 192, @@ -48832,10 +48832,10 @@ "team_member_id": { "maxLength": 192, "type": "string", - "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) ID to associate with this refund." + "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) ID to associate with this refund." } }, - "description": "Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/refund-payment).", + "description": "Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/refund-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -48868,7 +48868,7 @@ "description": "The successfully created `PaymentRefund`." } }, - "description": "Defines the response returned by\n[RefundPayment](https://developer.squareup.com/reference/square_2023-12-13/refunds-api/refund-payment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", + "description": "Defines the response returned by\n[RefundPayment](https://developer.squareup.com/reference/square_2024-01-18/refunds-api/refund-payment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", "x-release-status": "PUBLIC", "example": { "refund": { @@ -48904,7 +48904,7 @@ "description": "A domain name as described in RFC-1034 that will be registered with ApplePay." } }, - "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2023-12-13/apple-pay-api/register-domain) endpoint.", + "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-01-18/apple-pay-api/register-domain) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -48932,10 +48932,10 @@ }, "status": { "type": "string", - "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2023-12-13/enums/RegisterDomainResponseStatus) for possible values." + "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2024-01-18/enums/RegisterDomainResponseStatus) for possible values." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2023-12-13/apple-pay-api/register-domain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-01-18/apple-pay-api/register-domain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "status": "VERIFIED" @@ -48952,7 +48952,7 @@ "RemoveGroupFromCustomerRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2023-12-13/customers-api/remove-group-from-customer) endpoint.", + "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-01-18/customers-api/remove-group-from-customer) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -48969,7 +48969,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2023-12-13/customers-api/remove-group-from-customer)\nendpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-01-18/customers-api/remove-group-from-customer)\nendpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -49077,7 +49077,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the\n[ResumeSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/resume-subscription) endpoint.", + "description": "Defines input parameters in a request to the\n[ResumeSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/resume-subscription) endpoint.", "x-release-status": "PUBLIC" }, "ResumeSubscriptionResponse": { @@ -49104,7 +49104,7 @@ "x-is-beta": true } }, - "description": "Defines output parameters in a response from the \n[ResumeSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/resume-subscription) endpoint.", + "description": "Defines output parameters in a response from the \n[ResumeSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/resume-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -49147,7 +49147,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) request.", + "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -49170,7 +49170,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -49193,14 +49193,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/retrieve-booking-custom-attribute) request.", + "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/retrieve-booking-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -49224,7 +49224,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/retrieve-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/retrieve-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -49359,7 +49359,7 @@ "description": "The retrieved card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](https://developer.squareup.com/reference/square_2023-12-13/cards-api/retrieve-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](https://developer.squareup.com/reference/square_2024-01-18/cards-api/retrieve-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -49479,7 +49479,7 @@ "catalog_version": { "type": "integer", "format": "int64", - "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true }, @@ -49616,7 +49616,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) request.", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie" @@ -49637,7 +49637,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -49659,14 +49659,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.", + "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie" @@ -49687,7 +49687,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/retrieve-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/retrieve-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -49703,7 +49703,7 @@ "RetrieveCustomerGroupRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/retrieve-customer-group) endpoint.", + "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/retrieve-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -49724,7 +49724,7 @@ "description": "The retrieved customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/retrieve-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/retrieve-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -50130,7 +50130,7 @@ }, "adjustment": { "$ref": "#/definitions/InventoryAdjustment", - "description": "The requested [InventoryAdjustment](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryAdjustment)." + "description": "The requested [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryAdjustment)." } }, "description": "", @@ -50166,7 +50166,7 @@ "properties": { "location_ids": { "type": "string", - "description": "The [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." + "description": "The [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, "cursor": { "type": "string", @@ -50248,7 +50248,7 @@ "properties": { "location_ids": { "type": "string", - "description": "The [Location](https://developer.squareup.com/reference/square_2023-12-13/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." + "description": "The [Location](https://developer.squareup.com/reference/square_2024-01-18/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, "cursor": { "type": "string", @@ -50334,7 +50334,7 @@ }, "count": { "$ref": "#/definitions/InventoryPhysicalCount", - "description": "The requested [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryPhysicalCount)." + "description": "The requested [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryPhysicalCount)." } }, "description": "", @@ -50388,7 +50388,7 @@ }, "transfer": { "$ref": "#/definitions/InventoryTransfer", - "description": "The requested [InventoryTransfer](https://developer.squareup.com/reference/square_2023-12-13/objects/InventoryTransfer)." + "description": "The requested [InventoryTransfer](https://developer.squareup.com/reference/square_2024-01-18/objects/InventoryTransfer)." } }, "description": "", @@ -50456,7 +50456,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) request.", + "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50478,7 +50478,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50501,14 +50501,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/retrieve-location-custom-attribute) request.", + "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/retrieve-location-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50530,7 +50530,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/retrieve-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/retrieve-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50547,7 +50547,7 @@ "RetrieveLocationRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](https://developer.squareup.com/reference/square_2023-12-13/locations-api/retrieve-location) endpoint.", + "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](https://developer.squareup.com/reference/square_2024-01-18/locations-api/retrieve-location) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -50566,7 +50566,7 @@ "description": "The requested location." } }, - "description": "Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2023-12-13/locations-api/retrieve-location)\nendpoint returns in a response.", + "description": "Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2024-01-18/locations-api/retrieve-location)\nendpoint returns in a response.", "x-release-status": "PUBLIC", "example": { "location": { @@ -50713,7 +50713,7 @@ "RetrieveLoyaltyProgramRequest": { "type": "object", "properties": {}, - "description": "A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", + "description": "A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dmain" @@ -50793,7 +50793,7 @@ "RetrieveLoyaltyPromotionRequest": { "type": "object", "properties": {}, - "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-promotion) request.", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id\u003dloypromo_f0f9b849-725e-378d-b810-511237e07b67", @@ -50815,7 +50815,7 @@ "description": "The retrieved loyalty promotion." } }, - "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2023-12-13/loyalty-api/retrieve-loyalty-promotion) response.", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-01-18/loyalty-api/retrieve-loyalty-promotion) response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -50900,7 +50900,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) request.", + "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50922,7 +50922,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50945,14 +50945,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) request.", + "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50974,7 +50974,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -50991,7 +50991,7 @@ "RetrieveMerchantRequest": { "type": "object", "properties": {}, - "description": "Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2023-12-13/merchants-api/retrieve-merchant) endpoint.", + "description": "Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-01-18/merchants-api/retrieve-merchant) endpoint.", "x-release-status": "PUBLIC" }, "RetrieveMerchantResponse": { @@ -51009,7 +51009,7 @@ "description": "The requested `Merchant` object." } }, - "description": "The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2023-12-13/merchants-api/retrieve-merchant) endpoint.", + "description": "The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-01-18/merchants-api/retrieve-merchant) endpoint.", "x-release-status": "PUBLIC", "example": { "merchant": { @@ -51152,7 +51152,7 @@ }, "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2023-12-13/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-01-18/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." } }, "description": "Represents a get request for an order custom attribute.", @@ -51449,7 +51449,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/retrieve-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/retrieve-subscription) endpoint.", "x-release-status": "PUBLIC" }, "RetrieveSubscriptionResponse": { @@ -51467,7 +51467,7 @@ "description": "The subscription retrieved." } }, - "description": "Defines output parameters in a response from the\n[RetrieveSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/retrieve-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/retrieve-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -51658,7 +51658,7 @@ "description": "The requested transaction." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/retrieve-transaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/retrieve-transaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -51718,7 +51718,7 @@ "RetrieveVendorRequest": { "type": "object", "properties": {}, - "description": "Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/retrieve-vendor).", + "description": "Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/retrieve-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -51735,10 +51735,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) object." + "description": "The successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) object." } }, - "description": "Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/retrieve-vendor).", + "description": "Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/retrieve-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51825,7 +51825,7 @@ "RetrieveWebhookSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Retrieves a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) using its id.", + "description": "Retrieves a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) using its id.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5" @@ -51843,10 +51843,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The requested [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)." + "description": "The requested [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) will not be\npresent.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -52355,14 +52355,14 @@ "items": { "$ref": "#/definitions/CustomAttributeFilter" }, - "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-items) endpoint." + "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-items) endpoint." }, "archived_state": { "type": "string", "description": "The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items." } }, - "description": "Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-items) endpoint.", + "description": "Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-items) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -52435,7 +52435,7 @@ "description": "Ids of returned item variations matching the specified query expression." } }, - "description": "Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2023-12-13/catalog-api/search-catalog-items) endpoint.", + "description": "Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-01-18/catalog-api/search-catalog-items) endpoint.", "x-release-status": "PUBLIC", "example": { "items": [ @@ -53334,7 +53334,7 @@ "loyalty_account_id": { "minLength": 1, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2023-12-13/objects/LoyaltyAccount) to which the loyalty reward belongs." + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-01-18/objects/LoyaltyAccount) to which the loyalty reward belongs." }, "status": { "type": "string", @@ -53425,7 +53425,7 @@ "description": "A list of customer IDs to filter by.\n\nMax: 10 customer IDs." } }, - "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](https://developer.squareup.com/reference/square_2023-12-13/objects/FulfillmentRecipient) `customer_id`.", + "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](https://developer.squareup.com/reference/square_2024-01-18/objects/FulfillmentRecipient) `customer_id`.", "x-release-status": "BETA", "x-is-beta": true }, @@ -53445,7 +53445,7 @@ "description": "The time range for filtering on the `closed_at` timestamp. If you use this\nvalue, you must set the `sort_field` in the `OrdersSearchSort` object to\n`CLOSED_AT`." } }, - "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2023-12-13/objects/SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", + "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2024-01-18/objects/SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", "x-release-status": "PUBLIC" }, "SearchOrdersFilter": { @@ -53453,7 +53453,7 @@ "properties": { "state_filter": { "$ref": "#/definitions/SearchOrdersStateFilter", - "description": "Filter by [OrderState](https://developer.squareup.com/reference/square_2023-12-13/enums/OrderState)." + "description": "Filter by [OrderState](https://developer.squareup.com/reference/square_2024-01-18/enums/OrderState)." }, "date_time_filter": { "$ref": "#/definitions/SearchOrdersDateTimeFilter", @@ -53485,17 +53485,17 @@ "items": { "type": "string" }, - "description": "A list of [fulfillment types](https://developer.squareup.com/reference/square_2023-12-13/enums/FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field." + "description": "A list of [fulfillment types](https://developer.squareup.com/reference/square_2024-01-18/enums/FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field." }, "fulfillment_states": { "type": "array", "items": { "type": "string" }, - "description": "A list of [fulfillment states](https://developer.squareup.com/reference/square_2023-12-13/enums/FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field." + "description": "A list of [fulfillment states](https://developer.squareup.com/reference/square_2024-01-18/enums/FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field." } }, - "description": "Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2023-12-13/objects/Fulfillment) information.", + "description": "Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2024-01-18/objects/Fulfillment) information.", "x-release-status": "PUBLIC" }, "SearchOrdersQuery": { @@ -53538,7 +53538,7 @@ }, "return_entries": { "type": "boolean", - "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2023-12-13/objects/OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." + "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2024-01-18/objects/OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." } }, "description": "The request does not have any required fields. When given no query criteria,\n`SearchOrders` returns all results for all of the seller\u0027s locations. When retrieving additional\npages using a `cursor`, the `query` must be equal to the `query` used to retrieve the first page of\nresults.", @@ -53581,14 +53581,14 @@ "items": { "$ref": "#/definitions/OrderEntry" }, - "description": "A list of [OrderEntries](https://developer.squareup.com/reference/square_2023-12-13/objects/OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." + "description": "A list of [OrderEntries](https://developer.squareup.com/reference/square_2024-01-18/objects/OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." }, "orders": { "type": "array", "items": { "$ref": "#/definitions/Order" }, - "description": "A list of\n[Order](https://developer.squareup.com/reference/square_2023-12-13/objects/Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." + "description": "A list of\n[Order](https://developer.squareup.com/reference/square_2024-01-18/objects/Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." }, "cursor": { "type": "string", @@ -53599,10 +53599,10 @@ "items": { "$ref": "#/definitions/Error" }, - "description": "[Errors](https://developer.squareup.com/reference/square_2023-12-13/objects/Error) encountered during the search." + "description": "[Errors](https://developer.squareup.com/reference/square_2024-01-18/objects/Error) encountered during the search." } }, - "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](https://developer.squareup.com/reference/square_2023-12-13/orders-api/search-orders).", + "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](https://developer.squareup.com/reference/square_2024-01-18/orders-api/search-orders).", "x-release-status": "PUBLIC", "example": { "order_entries": [ @@ -53631,7 +53631,7 @@ "properties": { "sort_field": { "type": "string", - "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2023-12-13/objects/SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`." + "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2024-01-18/objects/SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`." }, "sort_order": { "type": "string", @@ -53649,7 +53649,7 @@ "items": { "type": "string" }, - "description": "Filters by the [Source](https://developer.squareup.com/reference/square_2023-12-13/objects/OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names." + "description": "Filters by the [Source](https://developer.squareup.com/reference/square_2024-01-18/objects/OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names." } }, "description": "A filter based on order `source` information.", @@ -53849,7 +53849,7 @@ "x-is-beta": true } }, - "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/search-subscriptions) endpoint.", + "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC" }, "SearchSubscriptionsQuery": { @@ -53889,7 +53889,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/search-subscriptions) endpoint.", + "description": "Defines input parameters in a request to the \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -53931,7 +53931,7 @@ "description": "When the total number of resulting subscription exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines output parameters in a response from the\n[SearchSubscriptions](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/search-subscriptions) endpoint.", + "description": "Defines output parameters in a response from the\n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC", "example": { "subscriptions": [ @@ -54541,7 +54541,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } }, - "description": "Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/search-vendors).", + "description": "Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -54573,14 +54573,14 @@ "maxLength": 100, "type": "string" }, - "description": "The names of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects to retrieve." + "description": "The names of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects to retrieve." }, "status": { "type": "array", "items": { "type": "string" }, - "description": "The statuses of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects to retrieve." + "description": "The statuses of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects to retrieve." } }, "description": "Defines supported query expressions to search for vendors by.", @@ -54599,7 +54599,7 @@ "description": "Specifies the sort order for the returned vendors." } }, - "description": "Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/search-vendors).", + "description": "Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true }, @@ -54618,14 +54618,14 @@ "items": { "$ref": "#/definitions/Vendor" }, - "description": "The [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) objects matching the specified search filter." + "description": "The [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) objects matching the specified search filter." }, "cursor": { "type": "string", "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } }, - "description": "Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/search-vendors).", + "description": "Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -54670,7 +54670,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogItemVariation) object representing the service booked in this segment." + "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogItemVariation) object representing the service booked in this segment." }, "team_member_id_filter": { "$ref": "#/definitions/FilterValue", @@ -55106,11 +55106,11 @@ "properties": { "product": { "type": "string", - "description": "__Read only__ The [product](https://developer.squareup.com/reference/square_2023-12-13/enums/Product) type of the application." + "description": "__Read only__ The [product](https://developer.squareup.com/reference/square_2024-01-18/enums/Product) type of the application." }, "application_id": { "type": "string", - "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](https://developer.squareup.com/reference/square_2023-12-13/enums/Product) type is `EXTERNAL_API`." + "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](https://developer.squareup.com/reference/square_2024-01-18/enums/Product) type is `EXTERNAL_API`." }, "name": { "type": "string", @@ -55241,12 +55241,12 @@ }, "plan_variation_id": { "type": "string", - "description": "The ID of the subscribed-to [subscription plan variation](https://developer.squareup.com/reference/square_2023-12-13/objects/CatalogSubscriptionPlanVariation).", + "description": "The ID of the subscribed-to [subscription plan variation](https://developer.squareup.com/reference/square_2024-01-18/objects/CatalogSubscriptionPlanVariation).", "x-read-only": true }, "customer_id": { "type": "string", - "description": "The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) profile.", + "description": "The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) profile.", "x-read-only": true }, "start_date": { @@ -55277,7 +55277,7 @@ "items": { "type": "string" }, - "description": "The IDs of the [invoices](https://developer.squareup.com/reference/square_2023-12-13/objects/Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", + "description": "The IDs of the [invoices](https://developer.squareup.com/reference/square_2024-01-18/objects/Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", "x-read-only": true }, "price_override_money": { @@ -55296,7 +55296,7 @@ }, "card_id": { "type": "string", - "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2023-12-13/objects/Customer) [card](https://developer.squareup.com/reference/square_2023-12-13/objects/Card)\nused to charge for the subscription." + "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2024-01-18/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-01-18/objects/Card)\nused to charge for the subscription." }, "timezone": { "type": "string", @@ -55314,7 +55314,7 @@ "items": { "$ref": "#/definitions/SubscriptionAction" }, - "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/retrieve-subscription) with the query parameter\nof `include\u003dactions` or from \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/search-subscriptions) with the input parameter \nof `include:[\"actions\"]`.", + "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/retrieve-subscription) with the query parameter\nof `include\u003dactions` or from \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/search-subscriptions) with the input parameter \nof `include:[\"actions\"]`.", "x-release-status": "BETA", "x-is-beta": true }, @@ -55550,7 +55550,7 @@ "description": "A list of PhaseInputs, to pass phase-specific information used in the swap." } }, - "description": "Defines input parameters in a call to the\n[SwapPlan](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/swap-plan) endpoint.", + "description": "Defines input parameters in a call to the\n[SwapPlan](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -55587,7 +55587,7 @@ "description": "A list of a `SWAP_PLAN` action created by the request." } }, - "description": "Defines output parameters in a response of the \n[SwapPlan](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/swap-plan) endpoint.", + "description": "Defines output parameters in a response of the \n[SwapPlan](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -55745,7 +55745,7 @@ "minLength": 0, "maxLength": 32, "type": "string", - "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2023-12-13/objects/TeamMember) object for the team member associated with the booking profile.", + "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-01-18/objects/TeamMember) object for the team member associated with the booking profile.", "x-read-only": true }, "description": { @@ -55842,7 +55842,7 @@ }, "amount_money": { "$ref": "#/definitions/Money", - "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](https://developer.squareup.com/reference/square_2023-12-13/objects/Payment) will be equal to the\n`amount_money` of the tender." + "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](https://developer.squareup.com/reference/square_2024-01-18/objects/Payment) will be equal to the\n`amount_money` of the tender." }, "tip_money": { "$ref": "#/definitions/Money", @@ -55893,7 +55893,7 @@ "payment_id": { "maxLength": 192, "type": "string", - "description": "The ID of the [Payment](https://developer.squareup.com/reference/square_2023-12-13/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." + "description": "The ID of the [Payment](https://developer.squareup.com/reference/square_2024-01-18/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." } }, "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", @@ -55904,10 +55904,10 @@ "properties": { "status": { "type": "string", - "description": "The bank account payment\u0027s current state.\n\nSee [TenderBankAccountPaymentDetailsStatus](https://developer.squareup.com/reference/square_2023-12-13/enums/TenderBankAccountDetailsStatus) for possible values." + "description": "The bank account payment\u0027s current state.\n\nSee [TenderBankAccountPaymentDetailsStatus](https://developer.squareup.com/reference/square_2024-01-18/enums/TenderBankAccountDetailsStatus) for possible values." } }, - "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](https://developer.squareup.com/reference/square_2023-12-13/objects/BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", + "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](https://developer.squareup.com/reference/square_2024-01-18/objects/BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", "x-release-status": "PUBLIC" }, "TenderBuyNowPayLaterDetails": { @@ -55920,7 +55920,7 @@ }, "status": { "type": "string", - "description": "The buy now pay later payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](https://developer.squareup.com/reference/square_2023-12-13/enums/TenderBuyNowPayLaterDetailsStatus)\nfor possible values." + "description": "The buy now pay later payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](https://developer.squareup.com/reference/square_2024-01-18/enums/TenderBuyNowPayLaterDetailsStatus)\nfor possible values." } }, "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", @@ -55931,7 +55931,7 @@ "properties": { "status": { "type": "string", - "description": "The credit card payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2023-12-13/enums/TenderCardDetailsStatus)\nfor possible values." + "description": "The credit card payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2024-01-18/enums/TenderCardDetailsStatus)\nfor possible values." }, "card": { "$ref": "#/definitions/Card", @@ -55965,7 +55965,7 @@ "properties": { "status": { "type": "string", - "description": "The Square Account payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderSquareAccountDetailsStatus](https://developer.squareup.com/reference/square_2023-12-13/enums/TenderSquareAccountDetailsStatus)\nfor possible values." + "description": "The Square Account payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderSquareAccountDetailsStatus](https://developer.squareup.com/reference/square_2024-01-18/enums/TenderSquareAccountDetailsStatus)\nfor possible values." } }, "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", @@ -56432,10 +56432,10 @@ "properties": { "event_type": { "type": "string", - "description": "The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)." + "description": "The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)." } }, - "description": "Tests a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) by sending a test event to its notification URL.", + "description": "Tests a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) by sending a test event to its notification URL.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5/test", @@ -56456,10 +56456,10 @@ }, "subscription_test_result": { "$ref": "#/definitions/SubscriptionTestResult", - "description": "The [SubscriptionTestResult](https://developer.squareup.com/reference/square_2023-12-13/objects/SubscriptionTestResult)." + "description": "The [SubscriptionTestResult](https://developer.squareup.com/reference/square_2024-01-18/objects/SubscriptionTestResult)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/test-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](https://developer.squareup.com/reference/square_2023-12-13/objects/SubscriptionTestResult) field is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/test-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](https://developer.squareup.com/reference/square_2024-01-18/objects/SubscriptionTestResult) field is not\npresent.", "x-release-status": "PUBLIC", "example": { "subscription_test_result": { @@ -56551,7 +56551,7 @@ "reference_id": { "maxLength": 40, "type": "string", - "description": "If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set." + "description": "If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set." }, "product": { "type": "string", @@ -56646,7 +56646,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/update-booking-custom-attribute-definition) request.", + "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/update-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -56676,7 +56676,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/update-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/update-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -56832,7 +56832,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie", @@ -56859,7 +56859,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/update-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/update-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -56887,7 +56887,7 @@ "description": "The `CustomerGroup` object including all the updates you want to make." } }, - "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/update-customer-group) endpoint.", + "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/update-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -56912,7 +56912,7 @@ "description": "The successfully updated customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2023-12-13/customer-groups-api/update-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-01-18/customer-groups-api/update-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -57356,7 +57356,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/update-location-custom-attribute-definition) request.", + "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/update-location-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -57384,7 +57384,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/update-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/update-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -57410,7 +57410,7 @@ "description": "The `Location` object with only the fields to update." } }, - "description": "The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2023-12-13/locations-api/update-location) endpoint.", + "description": "The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2024-01-18/locations-api/update-location) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -57454,7 +57454,7 @@ "description": "The updated `Location` object." } }, - "description": "The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2023-12-13/locations-api/update-location) endpoint.", + "description": "The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2024-01-18/locations-api/update-location) endpoint.", "x-release-status": "PUBLIC", "example": { "location": { @@ -57629,7 +57629,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) request.", + "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -57657,7 +57657,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -57847,7 +57847,7 @@ "description": "A value you specify that uniquely identifies this update request.\n\nIf you are unsure whether a particular update was applied to an order successfully,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate updates to the order.\nThe latest order version is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Defines the fields that are included in requests to the\n[UpdateOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/update-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[UpdateOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/update-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -57888,7 +57888,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](https://developer.squareup.com/reference/square_2023-12-13/orders-api/update-order) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](https://developer.squareup.com/reference/square_2024-01-18/orders-api/update-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58081,7 +58081,7 @@ "description": "A unique string that identifies this `UpdatePayment` request. Keys can be any valid string\nbut must be unique for every `UpdatePayment` request.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Describes a request to update a payment using\n[UpdatePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/update-payment).", + "description": "Describes a request to update a payment using\n[UpdatePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/update-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -58115,7 +58115,7 @@ "description": "The updated payment." } }, - "description": "Defines the response returned by\n[UpdatePayment](https://developer.squareup.com/reference/square_2023-12-13/payments-api/update-payment).", + "description": "Defines the response returned by\n[UpdatePayment](https://developer.squareup.com/reference/square_2024-01-18/payments-api/update-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -58300,7 +58300,7 @@ "description": "The subscription object containing the current version, and fields to update.\nUnset fields will be left at their current server values, and JSON `null` values will\nbe treated as a request to clear the relevant data." } }, - "description": "Defines input parameters in a request to the \n[UpdateSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/update-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[UpdateSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/update-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -58326,7 +58326,7 @@ "description": "The updated subscription." } }, - "description": "Defines output parameters in a response from the\n[UpdateSubscription](https://developer.squareup.com/reference/square_2023-12-13/subscriptions-api/update-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[UpdateSubscription](https://developer.squareup.com/reference/square_2024-01-18/subscriptions-api/update-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -58433,10 +58433,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The specified [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) to be updated." + "description": "The specified [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) to be updated." } }, - "description": "Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/update-vendor).", + "description": "Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/update-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58463,10 +58463,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) that has been updated." + "description": "The [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) that has been updated." } }, - "description": "Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2023-12-13/vendors-api/update-vendor).", + "description": "Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-01-18/vendors-api/update-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58594,10 +58594,10 @@ "properties": { "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) to update." + "description": "The [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) to update." } }, - "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription).", + "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription).", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5", @@ -58621,10 +58621,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The updated [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription)." + "description": "The updated [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/update-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/update-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) is not\npresent.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -58648,10 +58648,10 @@ "idempotency_key": { "maxLength": 45, "type": "string", - "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request." + "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request." } }, - "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) by replacing the existing signature key with a new one.", + "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) by replacing the existing signature key with a new one.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5/signature-key", @@ -58676,7 +58676,7 @@ "x-read-only": true } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2023-12-13/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2023-12-13/objects/WebhookSubscription) is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-01-18/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-01-18/objects/WebhookSubscription) is not\npresent.", "x-release-status": "PUBLIC", "example": { "signature_key": "1k9bIJKCeTmSQwyagtNRLg" @@ -58749,7 +58749,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/upsert-booking-custom-attribute) request.", + "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/upsert-booking-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -58778,7 +58778,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/booking-custom-attributes-api/upsert-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/booking-custom-attributes-api/upsert-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -58975,7 +58975,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/upsert-customer-custom-attribute) request.", + "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/upsert-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie", @@ -59001,7 +59001,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/customer-custom-attributes-api/upsert-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/customer-custom-attributes-api/upsert-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -59030,7 +59030,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/upsert-location-custom-attribute) request.", + "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/upsert-location-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59057,7 +59057,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/location-custom-attributes-api/upsert-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/location-custom-attributes-api/upsert-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59087,7 +59087,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/upsert-merchant-custom-attribute) request.", + "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/upsert-merchant-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59114,7 +59114,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2023-12-13/merchant-custom-attributes-api/upsert-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-01-18/merchant-custom-attributes-api/upsert-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -60255,53 +60255,53 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor).\nThis field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor).\nThis field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "created_at": { "maxLength": 34, "type": "string", - "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) was created.", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) was created.", "x-read-only": true }, "updated_at": { "maxLength": 34, "type": "string", - "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor) was last updated.", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor) was last updated.", "x-read-only": true }, "name": { "maxLength": 100, "type": "string", - "description": "The name of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor).\nThis field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The name of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor).\nThis field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "address": { "$ref": "#/definitions/Address", - "description": "The address of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The address of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/VendorContact" }, - "description": "The contacts of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The contacts of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "account_number": { "maxLength": 100, "type": "string", - "description": "The account number of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The account number of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "note": { "maxLength": 4096, "type": "string", - "description": "A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "version": { "type": "integer", - "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "status": { "$ref": "#/definitions/VendorStatus", - "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." } }, "description": "Represents a supplier to a seller.", @@ -60317,33 +60317,33 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact).\nThis field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact)." + "description": "A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact).\nThis field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact)." }, "name": { "maxLength": 255, "type": "string", - "description": "The name of the [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact).\nThis field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor)." + "description": "The name of the [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact).\nThis field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor)." }, "email_address": { "maxLength": 255, "type": "string", - "description": "The email address of the [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact)." + "description": "The email address of the [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact)." }, "phone_number": { "maxLength": 255, "type": "string", - "description": "The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact)." + "description": "The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact)." }, "removed": { "type": "boolean", - "description": "The state of the [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact)." + "description": "The state of the [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact)." }, "ordinal": { "type": "integer", - "description": "The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2023-12-13/objects/VendorContact)." + "description": "The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2024-01-18/objects/VendorContact)." } }, - "description": "Represents a contact of a [Vendor](https://developer.squareup.com/reference/square_2023-12-13/objects/Vendor).", + "description": "Represents a contact of a [Vendor](https://developer.squareup.com/reference/square_2024-01-18/objects/Vendor).", "x-release-status": "BETA", "x-is-beta": true }, @@ -60374,7 +60374,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](https://developer.squareup.com/reference/square_2023-12-13/transactions-api/void-transaction) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](https://developer.squareup.com/reference/square_2024-01-18/transactions-api/void-transaction) endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": {}, From 08a73e90c533473912797573d7506d5e86552dd5 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Thu, 18 Jan 2024 14:36:17 -0700 Subject: [PATCH 15/19] a few more fixes of syntax from new dietarypreferences stuff --- api.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/api.json b/api.json index e4ab159..2362245 100644 --- a/api.json +++ b/api.json @@ -28545,7 +28545,7 @@ "x-is-beta": true }, "food_and_beverage_details": { - "$ref": "#/definitions/FoodAndBeverageDetails", + "$ref": "#/definitions/CatalogItemFoodAndBeverageDetails", "description": "The food and beverage-specific details for the `FOOD_AND_BEV` item." }, "reporting_category": { @@ -28581,14 +28581,14 @@ "dietary_preferences": { "type": "array", "items": { - "$ref": "#/definitions/DietaryPreference" + "$ref": "#/definitions/CatalogItemFoodAndBeverageDetailsDietaryPreference" }, "description": "The dietary preferences for the `FOOD_AND_BEV` item." }, "ingredients": { "type": "array", "items": { - "$ref": "#/definitions/Ingredient" + "$ref": "#/definitions/CatalogItemFoodAndBeverageDetailsIngredient" }, "description": "The ingredients for the `FOOD_AND_BEV` type item." } @@ -28600,7 +28600,7 @@ "type": "object", "properties": { "type": { - "$ref": "#/definitions/DietaryPreferenceType", + "$ref": "#/definitions/CatalogItemFoodAndBeverageDetailsDietaryPreferenceType", "description": "The dietary preference type. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`." }, "standard_name": { @@ -28619,7 +28619,7 @@ "type": "object", "properties": { "type": { - "$ref": "#/definitions/DietaryPreferenceType", + "$ref": "#/definitions/CatalogItemFoodAndBeverageDetailsDietaryPreferenceType", "description": "The dietary preference type of the ingredient. Supported values include `STANDARD` and `CUSTOM` as specified in `FoodAndBeverageDetails.DietaryPreferenceType`." }, "standard_name": { From 3981c8f1fef5596c58fa0650e5e911253b115a3a Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Wed, 21 Aug 2024 16:00:53 -0600 Subject: [PATCH 16/19] changed a param from being read only --- api.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api.json b/api.json index 44f7ae8..2c99072 100644 --- a/api.json +++ b/api.json @@ -44769,7 +44769,7 @@ "maxLength": 36, "type": "string", "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", - "x-read-only": true + "x-read-only": false }, "points": { "type": "integer", From 728cffc883be46ee0717a70de8b1581178998d7a Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Wed, 21 Aug 2024 16:19:04 -0600 Subject: [PATCH 17/19] changed a necessary loyalty param from being read only --- api.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api.json b/api.json index 2c99072..6d36cb2 100644 --- a/api.json +++ b/api.json @@ -44709,7 +44709,7 @@ "maxLength": 36, "type": "string", "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", - "x-read-only": true + "x-read-only": false }, "points": { "minimum": 1, From 5ec077b3d45c321f081803edb13cb1ed906ff704 Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Thu, 19 Sep 2024 11:30:17 -0600 Subject: [PATCH 18/19] changed the date to 2024-09-19 --- api.json | 2238 +++++++++++++++++++++++++++--------------------------- 1 file changed, 1119 insertions(+), 1119 deletions(-) diff --git a/api.json b/api.json index 6d36cb2..a5d9928 100644 --- a/api.json +++ b/api.json @@ -114,7 +114,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE_IN_PERSON" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -152,7 +152,7 @@ "operationId": "RevokeToken", "description": "Revokes an access token generated with the OAuth flow.\n\nIf an account has more than one OAuth access token for your application, this\nendpoint revokes all of them, regardless of which token you specify. \n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the **OAuth**\npage for your application in the Developer Dashboard.", "x-release-status": "PUBLIC", - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2ClientSecret": [] @@ -188,7 +188,7 @@ "operationId": "ObtainToken", "description": "Returns an OAuth access token and a refresh token unless the \n`short_lived` parameter is set to `true`, in which case the endpoint \nreturns only an access token.\n\nThe `grant_type` parameter specifies the type of OAuth request. If \n`grant_type` is `authorization_code`, you must include the authorization \ncode you received when a seller granted you authorization. If `grant_type` \nis `refresh_token`, you must provide a valid refresh token. If you\u0027re using \nan old version of the Square APIs (prior to March 13, 2019), `grant_type` \ncan be `migration_token` and you must provide a valid migration token.\n\nYou can use the `scopes` parameter to limit the set of permissions granted \nto the access token and refresh token. You can use the `short_lived` parameter \nto create an access token that expires in 24 hours.\n\n__Note:__ OAuth tokens should be encrypted and stored on a secure server. \nApplication clients should never interact directly with OAuth tokens.", "x-release-status": "PUBLIC", - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [], "parameters": [ { @@ -221,7 +221,7 @@ "description": "Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).\n\nAdd the access token to the Authorization header of the request.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nwhere `ACCESS_TOKEN` is a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).\n\nIf the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -252,7 +252,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -321,7 +321,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -369,7 +369,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -424,7 +424,7 @@ "description": "Activates a domain for use with Apple Pay on the Web and Square. A validation\nis performed on this domain by Apple to ensure that it is properly set up as\nan Apple Pay enabled domain.\n\nThis endpoint provides an easy way for platform developers to bulk activate\nApple Pay on the Web with Square for merchants using their platform.\n\nNote: You will need to host a valid domain verification file on your domain to support Apple Pay. The\ncurrent version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,\nand should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your\ndomain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding\nlong-lived caches that might not keep in sync with the correct file version.\n\nTo learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -458,12 +458,12 @@ ], "summary": "ListBankAccounts", "operationId": "ListBankAccounts", - "description": "Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2024-08-21/objects/BankAccount) objects linked to a Square account.", + "description": "Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2024-09-19/objects/BankAccount) objects linked to a Square account.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -511,12 +511,12 @@ ], "summary": "GetBankAccountByV1Id", "operationId": "GetBankAccountByV1Id", - "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2024-08-21/objects/BankAccount) identified by V1 bank account ID.", + "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2024-09-19/objects/BankAccount) identified by V1 bank account ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -550,12 +550,12 @@ ], "summary": "GetBankAccount", "operationId": "GetBankAccount", - "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2024-08-21/objects/BankAccount)\nlinked to a Square account.", + "description": "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2024-09-19/objects/BankAccount)\nlinked to a Square account.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "BANK_ACCOUNTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -594,7 +594,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -619,7 +619,7 @@ }, { "name": "customer_id", - "description": "The [customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.", + "description": "The [customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.", "type": "string", "in": "query", "required": false @@ -673,7 +673,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -714,7 +714,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -755,7 +755,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -796,7 +796,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -827,7 +827,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -871,7 +871,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -912,7 +912,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -949,7 +949,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -993,7 +993,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1041,7 +1041,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1082,7 +1082,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1123,7 +1123,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1169,7 +1169,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1208,7 +1208,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1268,7 +1268,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1309,7 +1309,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_BUSINESS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1348,7 +1348,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1359,7 +1359,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking) object representing the to-be-retrieved booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking) object representing the to-be-retrieved booking.", "type": "string", "in": "path", "required": true @@ -1385,7 +1385,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1396,7 +1396,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking) object representing the to-be-updated booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking) object representing the to-be-updated booking.", "type": "string", "in": "path", "required": true @@ -1433,7 +1433,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1444,7 +1444,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking) object representing the to-be-cancelled booking.", + "description": "The ID of the [Booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking) object representing the to-be-cancelled booking.", "type": "string", "in": "path", "required": true @@ -1481,7 +1481,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1492,7 +1492,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking).", "type": "string", "in": "path", "required": true @@ -1513,7 +1513,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -1541,7 +1541,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1552,7 +1552,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking).", "type": "string", "in": "path", "required": true @@ -1585,7 +1585,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1596,7 +1596,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking).", "type": "string", "in": "path", "required": true @@ -1610,7 +1610,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -1643,7 +1643,7 @@ "x-oauthpermissions": [ "APPOINTMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1654,7 +1654,7 @@ "parameters": [ { "name": "booking_id", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking).", + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking).", "type": "string", "in": "path", "required": true @@ -1698,7 +1698,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1763,7 +1763,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1804,7 +1804,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1843,7 +1843,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1882,7 +1882,7 @@ "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -1951,12 +1951,12 @@ ], "summary": "RetrieveCashDrawerShift", "operationId": "RetrieveCashDrawerShift", - "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2024-08-21/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.", + "description": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2024-09-19/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2002,7 +2002,7 @@ "x-oauthpermissions": [ "CASH_DRAWER_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2057,12 +2057,12 @@ ], "summary": "BatchDeleteCatalogObjects", "operationId": "BatchDeleteCatalogObjects", - "description": "Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code.", + "description": "Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2098,12 +2098,12 @@ ], "summary": "BatchRetrieveCatalogObjects", "operationId": "BatchRetrieveCatalogObjects", - "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) objects, references to\nits [CatalogModifierList](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTax) objects that apply to it.", + "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) objects, references to\nits [CatalogModifierList](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTax) objects that apply to it.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2144,7 +2144,7 @@ "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2185,7 +2185,7 @@ "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2211,12 +2211,12 @@ ], "summary": "ListCatalog", "operationId": "ListCatalog", - "description": "Returns a list of all [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s of the specified types in the catalog.\n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) values,\nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-objects)\nand set the `include_deleted_objects` attribute value to `true`.", + "description": "Returns a list of all [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s of the specified types in the catalog.\n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) values,\nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-objects)\nand set the `include_deleted_objects` attribute value to `true`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2234,14 +2234,14 @@ }, { "name": "types", - "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", "type": "string", "in": "query", "required": false }, { "name": "catalog_version", - "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", "x-is-beta": true, "type": "integer", "format": "int64", @@ -2266,12 +2266,12 @@ ], "summary": "UpsertCatalogObject", "operationId": "UpsertCatalogObject", - "description": "Creates a new or updates the specified [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code.", + "description": "Creates a new or updates the specified [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2307,12 +2307,12 @@ ], "summary": "DeleteCatalogObject", "operationId": "DeleteCatalogObject", - "description": "Deletes a single [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code.", + "description": "Deletes a single [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2344,12 +2344,12 @@ ], "summary": "RetrieveCatalogObject", "operationId": "RetrieveCatalogObject", - "description": "Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) as a\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem)\ninformation including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTax) objects that apply to it.", + "description": "Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) as a\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem)\ninformation including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifierList) objects, and the ids of\nany [CatalogTax](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTax) objects that apply to it.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2374,7 +2374,7 @@ }, { "name": "catalog_version", - "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "x-is-beta": true, "type": "integer", "format": "int64", @@ -2406,12 +2406,12 @@ ], "summary": "SearchCatalogObjects", "operationId": "SearchCatalogObjects", - "description": "Searches for [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-items)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", + "description": "Searches for [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-items)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2447,12 +2447,12 @@ ], "summary": "SearchCatalogItems", "operationId": "SearchCatalogItems", - "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-objects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", + "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-objects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2488,12 +2488,12 @@ ], "summary": "UpdateItemModifierLists", "operationId": "UpdateItemModifierLists", - "description": "Updates the [CatalogModifierList](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) without having\nto perform an upsert on the entire item.", + "description": "Updates the [CatalogModifierList](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) without having\nto perform an upsert on the entire item.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2529,12 +2529,12 @@ ], "summary": "UpdateItemTaxes", "operationId": "UpdateItemTaxes", - "description": "Updates the [CatalogTax](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTax) objects that apply to the\ntargeted [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) without having to perform an\nupsert on the entire item.", + "description": "Updates the [CatalogTax](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTax) objects that apply to the\ntargeted [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) without having to perform an\nupsert on the entire item.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ITEMS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2575,7 +2575,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2640,7 +2640,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2676,12 +2676,12 @@ ], "summary": "BulkCreateCustomers", "operationId": "BulkCreateCustomers", - "description": "Creates multiple [customer profiles](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) for a business.\n\nThis endpoint takes a map of individual create requests and returns a map of responses.\n\nYou must provide at least one of the following values in each create request:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`", + "description": "Creates multiple [customer profiles](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) for a business.\n\nThis endpoint takes a map of individual create requests and returns a map of responses.\n\nYou must provide at least one of the following values in each create request:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2722,7 +2722,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2763,7 +2763,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2799,12 +2799,12 @@ ], "summary": "BulkUpdateCustomers", "operationId": "BulkUpdateCustomers", - "description": "Updates multiple customer profiles.\n\nThis endpoint takes a map of individual update requests and returns a map of responses.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-08-21/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-08-21/gift-cards-api).", + "description": "Updates multiple customer profiles.\n\nThis endpoint takes a map of individual update requests and returns a map of responses.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-09-19/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-09-19/gift-cards-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2840,12 +2840,12 @@ ], "summary": "ListCustomerCustomAttributeDefinitions", "operationId": "ListCustomerCustomAttributeDefinitions", - "description": "Lists the customer-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the customer-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2884,12 +2884,12 @@ ], "summary": "CreateCustomerCustomAttributeDefinition", "operationId": "CreateCustomerCustomAttributeDefinition", - "description": "Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/upsert-customer-custom-attribute) or\n[BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nto set the custom attribute for customer profiles in the seller\u0027s Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", + "description": "Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/upsert-customer-custom-attribute) or\n[BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nto set the custom attribute for customer profiles in the seller\u0027s Customer Directory.\n\nSellers can view all custom attributes in exported customer data, including those set to\n`VISIBILITY_HIDDEN`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2925,12 +2925,12 @@ ], "summary": "DeleteCustomerCustomAttributeDefinition", "operationId": "DeleteCustomerCustomAttributeDefinition", - "description": "Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller\u0027s Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller\u0027s Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -2962,12 +2962,12 @@ ], "summary": "RetrieveCustomerCustomAttributeDefinition", "operationId": "RetrieveCustomerCustomAttributeDefinition", - "description": "Retrieves a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3006,12 +3006,12 @@ ], "summary": "UpdateCustomerCustomAttributeDefinition", "operationId": "UpdateCustomerCustomAttributeDefinition", - "description": "Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", + "description": "Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3054,12 +3054,12 @@ ], "summary": "BulkUpsertCustomerCustomAttributes", "operationId": "BulkUpsertCustomerCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a customer ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a customer ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3100,7 +3100,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3144,7 +3144,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3185,7 +3185,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3222,7 +3222,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3259,7 +3259,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3307,7 +3307,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3348,7 +3348,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3394,7 +3394,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3433,7 +3433,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3478,7 +3478,7 @@ "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3510,12 +3510,12 @@ ], "summary": "UpdateCustomer", "operationId": "UpdateCustomer", - "description": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null`.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-08-21/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-08-21/gift-cards-api).", + "description": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null`.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.\n\nYou cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-09-19/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-09-19/gift-cards-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3564,7 +3564,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3614,7 +3614,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3657,12 +3657,12 @@ ], "summary": "ListCustomerCustomAttributes", "operationId": "ListCustomerCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3673,7 +3673,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3694,7 +3694,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -3717,12 +3717,12 @@ ], "summary": "DeleteCustomerCustomAttribute", "operationId": "DeleteCustomerCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3733,7 +3733,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3761,12 +3761,12 @@ ], "summary": "RetrieveCustomerCustomAttribute", "operationId": "RetrieveCustomerCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3777,7 +3777,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3791,7 +3791,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "type": "boolean", "in": "query", "required": false @@ -3819,12 +3819,12 @@ ], "summary": "UpsertCustomerCustomAttribute", "operationId": "UpsertCustomerCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3835,7 +3835,7 @@ "parameters": [ { "name": "customer_id", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer).", + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer).", "type": "string", "in": "path", "required": true @@ -3879,7 +3879,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3923,7 +3923,7 @@ "x-oauthpermissions": [ "CUSTOMERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -3970,7 +3970,7 @@ "x-oauthpermissions": [ "DEVICES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4034,7 +4034,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4092,7 +4092,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4133,7 +4133,7 @@ "x-oauthpermissions": [ "DEVICE_CREDENTIAL_MANAGEMENT" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4173,7 +4173,7 @@ "x-oauthpermissions": [ "DEVICES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4213,7 +4213,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4266,7 +4266,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4305,7 +4305,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4344,7 +4344,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4390,7 +4390,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4438,7 +4438,7 @@ "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4482,7 +4482,7 @@ "x-oauthpermissions": [ "DISPUTES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4523,12 +4523,12 @@ ], "summary": "SubmitEvidence", "operationId": "SubmitEvidence", - "description": "Submits evidence to the cardholder\u0027s bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2024-08-21/disputes-api/create-dispute-evidence-file) and\n[CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2024-08-21/disputes-api/create-dispute-evidence-text) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", + "description": "Submits evidence to the cardholder\u0027s bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2024-09-19/disputes-api/create-dispute-evidence-file) and\n[CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2024-09-19/disputes-api/create-dispute-evidence-text) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "DISPUTES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4568,7 +4568,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4633,7 +4633,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4672,7 +4672,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -4710,7 +4710,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -4738,7 +4738,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -4766,7 +4766,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -4804,7 +4804,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4815,14 +4815,14 @@ "parameters": [ { "name": "type", - "description": "If a [type](https://developer.squareup.com/reference/square_2024-08-21/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", + "description": "If a [type](https://developer.squareup.com/reference/square_2024-09-19/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.", "type": "string", "in": "query", "required": false }, { "name": "state", - "description": "If a [state](https://developer.squareup.com/reference/square_2024-08-21/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", + "description": "If a [state](https://developer.squareup.com/reference/square_2024-09-19/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.", "type": "string", "in": "query", "required": false @@ -4864,12 +4864,12 @@ ], "summary": "CreateGiftCard", "operationId": "CreateGiftCard", - "description": "Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card\nhas a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) and create an `ACTIVATE`\nactivity with the initial balance. Alternatively, you can use [RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment)\nto refund a payment to the new gift card.", + "description": "Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card\nhas a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) and create an `ACTIVATE`\nactivity with the initial balance. Alternatively, you can use [RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment)\nto refund a payment to the new gift card.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4910,7 +4910,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -4928,7 +4928,7 @@ }, { "name": "type", - "description": "If a [type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", + "description": "If a [type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.", "type": "string", "in": "query", "required": false @@ -4991,12 +4991,12 @@ ], "summary": "CreateGiftCardActivity", "operationId": "CreateGiftCardActivity", - "description": "Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).\nFor example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use.", + "description": "Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).\nFor example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5037,7 +5037,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5078,7 +5078,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5119,7 +5119,7 @@ "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5167,7 +5167,7 @@ "x-oauthpermissions": [ "GIFTCARDS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5215,7 +5215,7 @@ "x-oauthpermissions": [ "GIFTCARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5249,13 +5249,13 @@ ], "summary": "DeprecatedRetrieveInventoryAdjustment", "operationId": "DeprecatedRetrieveInventoryAdjustment", - "description": "Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/retrieve-inventory-adjustment) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/retrieve-inventory-adjustment) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5266,7 +5266,7 @@ "parameters": [ { "name": "adjustment_id", - "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryAdjustment) to retrieve.", + "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryAdjustment) to retrieve.", "type": "string", "in": "path", "required": true @@ -5289,12 +5289,12 @@ ], "summary": "RetrieveInventoryAdjustment", "operationId": "RetrieveInventoryAdjustment", - "description": "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`.", + "description": "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5305,7 +5305,7 @@ "parameters": [ { "name": "adjustment_id", - "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryAdjustment) to retrieve.", + "description": "ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryAdjustment) to retrieve.", "type": "string", "in": "path", "required": true @@ -5328,13 +5328,13 @@ ], "summary": "DeprecatedBatchChangeInventory", "operationId": "DeprecatedBatchChangeInventory", - "description": "Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-change-inventory) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-change-inventory) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5370,13 +5370,13 @@ ], "summary": "DeprecatedBatchRetrieveInventoryChanges", "operationId": "DeprecatedBatchRetrieveInventoryChanges", - "description": "Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5412,13 +5412,13 @@ ], "summary": "DeprecatedBatchRetrieveInventoryCounts", "operationId": "DeprecatedBatchRetrieveInventoryCounts", - "description": "Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5459,7 +5459,7 @@ "x-oauthpermissions": [ "INVENTORY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5500,7 +5500,7 @@ "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5536,12 +5536,12 @@ ], "summary": "BatchRetrieveInventoryCounts", "operationId": "BatchRetrieveInventoryCounts", - "description": "Returns current counts for the provided\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s at the requested\n[Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", + "description": "Returns current counts for the provided\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s at the requested\n[Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notification.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5577,13 +5577,13 @@ ], "summary": "DeprecatedRetrieveInventoryPhysicalCount", "operationId": "DeprecatedRetrieveInventoryPhysicalCount", - "description": "Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/retrieve-inventory-physical-count) after the endpoint URL\nis updated to conform to the standard convention.", + "description": "Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/retrieve-inventory-physical-count) after the endpoint URL\nis updated to conform to the standard convention.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5594,7 +5594,7 @@ "parameters": [ { "name": "physical_count_id", - "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryPhysicalCount) to retrieve.", + "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryPhysicalCount) to retrieve.", "type": "string", "in": "path", "required": true @@ -5617,12 +5617,12 @@ ], "summary": "RetrieveInventoryPhysicalCount", "operationId": "RetrieveInventoryPhysicalCount", - "description": "Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", + "description": "Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryPhysicalCount)\nobject with the provided `physical_count_id`.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5633,7 +5633,7 @@ "parameters": [ { "name": "physical_count_id", - "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryPhysicalCount) to retrieve.", + "description": "ID of the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryPhysicalCount) to retrieve.", "type": "string", "in": "path", "required": true @@ -5656,13 +5656,13 @@ ], "summary": "RetrieveInventoryTransfer", "operationId": "RetrieveInventoryTransfer", - "description": "Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryTransfer) object\nwith the provided `transfer_id`.", + "description": "Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryTransfer) object\nwith the provided `transfer_id`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5673,7 +5673,7 @@ "parameters": [ { "name": "transfer_id", - "description": "ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryTransfer) to retrieve.", + "description": "ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryTransfer) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -5697,12 +5697,12 @@ ], "summary": "RetrieveInventoryCount", "operationId": "RetrieveInventoryCount", - "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) at a given set of\n[Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", + "description": "Retrieves the current calculated stock count for a given\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) at a given set of\n[Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5713,14 +5713,14 @@ "parameters": [ { "name": "catalog_object_id", - "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) to retrieve.", + "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "location_ids", - "description": "The [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "description": "The [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", "type": "string", "in": "query", "required": false @@ -5750,13 +5750,13 @@ ], "summary": "RetrieveInventoryChanges", "operationId": "RetrieveInventoryChanges", - "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) at the requested\n[Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-retrieve-inventory-changes)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", + "description": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) at the requested\n[Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-retrieve-inventory-changes)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nThere are no limits on how far back the caller can page. This endpoint can be\nused to display recent changes for a specific item. For more\nsophisticated queries, use a batch endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "INVENTORY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5767,14 +5767,14 @@ "parameters": [ { "name": "catalog_object_id", - "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) to retrieve.", + "description": "ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "location_ids", - "description": "The [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", + "description": "The [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations.", "type": "string", "in": "query", "required": false @@ -5809,7 +5809,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5855,13 +5855,13 @@ ], "summary": "CreateInvoice", "operationId": "CreateInvoice", - "description": "Creates a draft [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer\u0027s email address or charge the customer’s card on file).", + "description": "Creates a draft [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer\u0027s email address or charge the customer’s card on file).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5903,7 +5903,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5945,7 +5945,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -5964,7 +5964,7 @@ }, { "name": "version", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/list-invoices).", + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/list-invoices).", "type": "integer", "in": "query", "required": false @@ -5990,7 +5990,7 @@ "x-oauthpermissions": [ "INVOICES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6028,7 +6028,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6077,7 +6077,7 @@ "x-oauthpermissions": [ "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6088,14 +6088,14 @@ "parameters": [ { "name": "invoice_id", - "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to delete the attachment from.", + "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to delete the attachment from.", "type": "string", "in": "path", "required": true }, { "name": "attachment_id", - "description": "The ID of the [attachment](https://developer.squareup.com/reference/square_2024-08-21/objects/InvoiceAttachment) to delete.", + "description": "The ID of the [attachment](https://developer.squareup.com/reference/square_2024-09-19/objects/InvoiceAttachment) to delete.", "type": "string", "in": "path", "required": true @@ -6124,7 +6124,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6136,7 +6136,7 @@ "parameters": [ { "name": "invoice_id", - "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to cancel.", + "description": "The ID of the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to cancel.", "type": "string", "in": "path", "required": true @@ -6174,7 +6174,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6223,7 +6223,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6274,7 +6274,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6315,7 +6315,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6352,7 +6352,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6390,7 +6390,7 @@ "TIMECARDS_SETTINGS_WRITE", "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6440,7 +6440,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6497,7 +6497,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6537,7 +6537,7 @@ "x-oauthpermissions": [ "TIMECARDS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6578,7 +6578,7 @@ "x-oauthpermissions": [ "TIMECARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6619,7 +6619,7 @@ "x-oauthpermissions": [ "TIMECARDS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6656,7 +6656,7 @@ "x-oauthpermissions": [ "TIMECARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6694,7 +6694,7 @@ "TIMECARDS_WRITE", "TIMECARDS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6743,7 +6743,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6796,7 +6796,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6835,7 +6835,7 @@ "x-oauthpermissions": [ "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6882,7 +6882,7 @@ "TIMECARDS_SETTINGS_WRITE", "TIMECARDS_SETTINGS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6931,7 +6931,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6960,7 +6960,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -6996,13 +6996,13 @@ ], "summary": "ListLocationCustomAttributeDefinitions", "operationId": "ListLocationCustomAttributeDefinitions", - "description": "Lists the location-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the location-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7051,13 +7051,13 @@ ], "summary": "CreateLocationCustomAttributeDefinition", "operationId": "CreateLocationCustomAttributeDefinition", - "description": "Creates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with locations.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/upsert-location-custom-attribute) or\n[BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nto set the custom attribute for locations.", + "description": "Creates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with locations.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/upsert-location-custom-attribute) or\n[BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nto set the custom attribute for locations.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7093,13 +7093,13 @@ ], "summary": "DeleteLocationCustomAttributeDefinition", "operationId": "DeleteLocationCustomAttributeDefinition", - "description": "Deletes a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall locations.\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall locations.\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7132,13 +7132,13 @@ ], "summary": "RetrieveLocationCustomAttributeDefinition", "operationId": "RetrieveLocationCustomAttributeDefinition", - "description": "Retrieves a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7179,13 +7179,13 @@ ], "summary": "UpdateLocationCustomAttributeDefinition", "operationId": "UpdateLocationCustomAttributeDefinition", - "description": "Updates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", + "description": "Updates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7229,13 +7229,13 @@ ], "summary": "BulkDeleteLocationCustomAttributes", "operationId": "BulkDeleteLocationCustomAttributes", - "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for locations as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for locations as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7271,13 +7271,13 @@ ], "summary": "BulkUpsertLocationCustomAttributes", "operationId": "BulkUpsertLocationCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for locations as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for one or more locations.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nThis `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a location ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for locations as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for one or more locations.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nThis `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a location ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7318,7 +7318,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7355,7 +7355,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7405,7 +7405,7 @@ "PAYMENTS_WRITE", "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7449,13 +7449,13 @@ ], "summary": "ListLocationCustomAttributes", "operationId": "ListLocationCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a location.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a location.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7466,7 +7466,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7498,7 +7498,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -7522,13 +7522,13 @@ ], "summary": "DeleteLocationCustomAttribute", "operationId": "DeleteLocationCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a location.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a location.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7539,7 +7539,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7569,13 +7569,13 @@ ], "summary": "RetrieveLocationCustomAttribute", "operationId": "RetrieveLocationCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a location.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a location.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7586,7 +7586,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7602,7 +7602,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -7632,13 +7632,13 @@ ], "summary": "UpsertLocationCustomAttribute", "operationId": "UpsertLocationCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for a location.\nUse this endpoint to set the value of a custom attribute for a specified location.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for a location.\nUse this endpoint to set the value of a custom attribute for a specified location.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7649,7 +7649,7 @@ "parameters": [ { "name": "location_id", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location).", + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location).", "x-is-beta": true, "type": "string", "in": "path", @@ -7696,7 +7696,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7769,7 +7769,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7812,13 +7812,13 @@ ], "summary": "CaptureTransaction", "operationId": "CaptureTransaction", - "description": "Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "description": "Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7861,13 +7861,13 @@ ], "summary": "VoidTransaction", "operationId": "VoidTransaction", - "description": "Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", + "description": "Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7915,7 +7915,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7956,7 +7956,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -7997,7 +7997,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8008,7 +8008,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount) to retrieve.", + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount) to retrieve.", "type": "string", "in": "path", "required": true @@ -8031,12 +8031,12 @@ ], "summary": "AccumulateLoyaltyPoints", "operationId": "AccumulateLoyaltyPoints", - "description": "Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/calculate-loyalty-points)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "description": "Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Square computes points based on the most\nrecently created promotion. A purchase must first qualify for program points to be eligible for promotion points.\n\n- If you are not using the Orders API to manage orders, provide `points` with the number of points to add.\nYou must first perform a client-side computation of the points earned from the loyalty program and\nloyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/calculate-loyalty-points)\nto compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8047,7 +8047,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount).", + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount).", "type": "string", "in": "path", "required": true @@ -8079,12 +8079,12 @@ ], "summary": "AdjustLoyaltyPoints", "operationId": "AdjustLoyaltyPoints", - "description": "Adds points to or subtracts points from a buyer\u0027s account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/accumulate-loyalty-points)\nto add points when a buyer pays for the purchase.", + "description": "Adds points to or subtracts points from a buyer\u0027s account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/accumulate-loyalty-points)\nto add points when a buyer pays for the purchase.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8095,7 +8095,7 @@ "parameters": [ { "name": "account_id", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount).", + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount).", "type": "string", "in": "path", "required": true @@ -8132,7 +8132,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8168,13 +8168,13 @@ ], "summary": "ListLoyaltyPrograms", "operationId": "ListLoyaltyPrograms", - "description": "Returns a list of loyalty programs in the seller\u0027s account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.", + "description": "Returns a list of loyalty programs in the seller\u0027s account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8205,7 +8205,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8239,12 +8239,12 @@ ], "summary": "CalculateLoyaltyPoints", "operationId": "CalculateLoyaltyPoints", - "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/list-loyalty-promotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", + "description": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\npurchase amount. Square uses this amount to calculate the points earned from the base loyalty program,\nbut not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode`\nsetting of the accrual rule indicates how taxes should be treated for loyalty points accrual.\nIf the purchase qualifies for program points, call\n[ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/list-loyalty-promotions) and perform a client-side computation\nto calculate whether the purchase also qualifies for promotion points. For more information, see\n[Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8255,7 +8255,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram), which defines the rules for accruing points.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram), which defines the rules for accruing points.", "type": "string", "in": "path", "required": true @@ -8287,12 +8287,12 @@ ], "summary": "ListLoyaltyPromotions", "operationId": "ListLoyaltyPromotions", - "description": "Lists the loyalty promotions associated with a [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", + "description": "Lists the loyalty promotions associated with a [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8303,7 +8303,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", "type": "string", "in": "path", "required": true @@ -8345,12 +8345,12 @@ ], "summary": "CreateLoyaltyPromotion", "operationId": "CreateLoyaltyPromotion", - "description": "Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", + "description": "Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8361,7 +8361,7 @@ "parameters": [ { "name": "program_id", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-program)\nusing the `main` keyword.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-program)\nusing the `main` keyword.", "type": "string", "in": "path", "required": true @@ -8398,7 +8398,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8409,14 +8409,14 @@ "parameters": [ { "name": "promotion_id", - "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion) to retrieve.", + "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion) to retrieve.", "type": "string", "in": "path", "required": true }, { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-program) using the `main` keyword.", "type": "string", "in": "path", "required": true @@ -8444,7 +8444,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8455,14 +8455,14 @@ "parameters": [ { "name": "promotion_id", - "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", + "description": "The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.", "type": "string", "in": "path", "required": true }, { "name": "program_id", - "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "type": "string", "in": "path", "required": true @@ -8490,7 +8490,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8526,12 +8526,12 @@ ], "summary": "SearchLoyaltyRewards", "operationId": "SearchLoyaltyRewards", - "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-reward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", + "description": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-reward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8567,12 +8567,12 @@ ], "summary": "DeleteLoyaltyReward", "operationId": "DeleteLoyaltyReward", - "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/create-loyalty-reward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", + "description": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/create-loyalty-reward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8583,7 +8583,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward) to delete.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward) to delete.", "type": "string", "in": "path", "required": true @@ -8609,7 +8609,7 @@ "x-oauthpermissions": [ "LOYALTY_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8620,7 +8620,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward) to retrieve.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward) to retrieve.", "type": "string", "in": "path", "required": true @@ -8648,7 +8648,7 @@ "x-oauthpermissions": [ "LOYALTY_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8659,7 +8659,7 @@ "parameters": [ { "name": "reward_id", - "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward) to redeem.", + "description": "The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward) to redeem.", "type": "string", "in": "path", "required": true @@ -8691,12 +8691,12 @@ ], "summary": "ListMerchants", "operationId": "ListMerchants", - "description": "Provides details about the merchant associated with a given access token.\n\nThe access token used to connect your application to a Square seller is associated\nwith a single merchant. That means that `ListMerchants` returns a list\nwith a single `Merchant` object. You can specify your personal access token\nto get your own merchant information or specify an OAuth token to get the\ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-08-21/merchants-api/retrieve-merchant)\nendpoint to retrieve the merchant information.", + "description": "Provides details about the merchant associated with a given access token.\n\nThe access token used to connect your application to a Square seller is associated\nwith a single merchant. That means that `ListMerchants` returns a list\nwith a single `Merchant` object. You can specify your personal access token\nto get your own merchant information or specify an OAuth token to get the\ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-09-19/merchants-api/retrieve-merchant)\nendpoint to retrieve the merchant information.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8730,13 +8730,13 @@ ], "summary": "ListMerchantCustomAttributeDefinitions", "operationId": "ListMerchantCustomAttributeDefinitions", - "description": "Lists the merchant-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the merchant-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8785,13 +8785,13 @@ ], "summary": "CreateMerchantCustomAttributeDefinition", "operationId": "CreateMerchantCustomAttributeDefinition", - "description": "Creates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with a merchant connecting to your application.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/upsert-merchant-custom-attribute) or\n[BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nto set the custom attribute for a merchant.", + "description": "Creates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with a merchant connecting to your application.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/upsert-merchant-custom-attribute) or\n[BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nto set the custom attribute for a merchant.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8827,13 +8827,13 @@ ], "summary": "DeleteMerchantCustomAttributeDefinition", "operationId": "DeleteMerchantCustomAttributeDefinition", - "description": "Deletes a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nthe merchant.\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nthe merchant.\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8866,13 +8866,13 @@ ], "summary": "RetrieveMerchantCustomAttributeDefinition", "operationId": "RetrieveMerchantCustomAttributeDefinition", - "description": "Retrieves a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8913,13 +8913,13 @@ ], "summary": "UpdateMerchantCustomAttributeDefinition", "operationId": "UpdateMerchantCustomAttributeDefinition", - "description": "Updates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", + "description": "Updates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -8963,13 +8963,13 @@ ], "summary": "BulkDeleteMerchantCustomAttributes", "operationId": "BulkDeleteMerchantCustomAttributes", - "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for a merchant as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for a merchant as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9005,13 +9005,13 @@ ], "summary": "BulkUpsertMerchantCustomAttributes", "operationId": "BulkUpsertMerchantCustomAttributes", - "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for a merchant as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for a merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nThis `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a merchant ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for a merchant as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for a merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nThis `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides a merchant ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9052,7 +9052,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9086,13 +9086,13 @@ ], "summary": "ListMerchantCustomAttributes", "operationId": "ListMerchantCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9103,7 +9103,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-08-21/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-09-19/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9135,7 +9135,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -9159,13 +9159,13 @@ ], "summary": "DeleteMerchantCustomAttribute", "operationId": "DeleteMerchantCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a merchant.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a merchant.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9176,7 +9176,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-08-21/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-09-19/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9206,13 +9206,13 @@ ], "summary": "RetrieveMerchantCustomAttribute", "operationId": "RetrieveMerchantCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a merchant.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9223,7 +9223,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-08-21/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-09-19/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9239,7 +9239,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -9269,13 +9269,13 @@ ], "summary": "UpsertMerchantCustomAttribute", "operationId": "UpsertMerchantCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for a merchant.\nUse this endpoint to set the value of a custom attribute for a specified merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for a merchant.\nUse this endpoint to set the value of a custom attribute for a specified merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "MERCHANT_PROFILE_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9286,7 +9286,7 @@ "parameters": [ { "name": "merchant_id", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-08-21/objects/Merchant).", + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-09-19/objects/Merchant).", "x-is-beta": true, "type": "string", "in": "path", @@ -9333,7 +9333,7 @@ "x-oauthpermissions": [ "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9373,7 +9373,7 @@ "MERCHANT_PROFILE_WRITE", "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9425,7 +9425,7 @@ "PAYMENT_METHODS_READ", "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9458,7 +9458,7 @@ "PAYMENT_METHODS_READ", "MERCHANT_PROFILE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9501,7 +9501,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9547,7 +9547,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9591,7 +9591,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9629,7 +9629,7 @@ "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9668,7 +9668,7 @@ "ORDERS_READ", "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9713,12 +9713,12 @@ ], "summary": "CreateOrder", "operationId": "CreateOrder", - "description": "Creates a new [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/update-order) endpoint.", + "description": "Creates a new [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/update-order) endpoint.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9754,12 +9754,12 @@ ], "summary": "BatchRetrieveOrders", "operationId": "BatchRetrieveOrders", - "description": "Retrieves a set of [orders](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", + "description": "Retrieves a set of [orders](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9799,7 +9799,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -9839,7 +9839,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9875,13 +9875,13 @@ ], "summary": "ListOrderCustomAttributeDefinitions", "operationId": "ListOrderCustomAttributeDefinitions", - "description": "Lists the order-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the order-related [custom attribute definitions](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9936,7 +9936,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -9972,13 +9972,13 @@ ], "summary": "DeleteOrderCustomAttributeDefinition", "operationId": "DeleteOrderCustomAttributeDefinition", - "description": "Deletes an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\n\nOnly the definition owner can delete a custom attribute definition.", + "description": "Deletes an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\n\nOnly the definition owner can delete a custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10011,13 +10011,13 @@ ], "summary": "RetrieveOrderCustomAttributeDefinition", "operationId": "RetrieveOrderCustomAttributeDefinition", - "description": "Retrieves an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10064,7 +10064,7 @@ "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10108,13 +10108,13 @@ ], "summary": "BulkDeleteOrderCustomAttributes", "operationId": "BulkDeleteOrderCustomAttributes", - "description": "Deletes order [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete\nrequests and returns a map of individual delete responses. Each delete request has a unique ID\nand provides an order ID and custom attribute. Each delete response is returned with the ID\nof the corresponding request.\n\nTo delete a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes order [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete\nrequests and returns a map of individual delete responses. Each delete request has a unique ID\nand provides an order ID and custom attribute. Each delete response is returned with the ID\nof the corresponding request.\n\nTo delete a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10150,13 +10150,13 @@ ], "summary": "BulkUpsertOrderCustomAttributes", "operationId": "BulkUpsertOrderCustomAttributes", - "description": "Creates or updates order [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides an order ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates order [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nThis `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert\nrequests and returns a map of individual upsert responses. Each upsert request has a unique ID\nand provides an order ID and custom attribute. Each upsert response is returned with the ID\nof the corresponding request.\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10192,12 +10192,12 @@ ], "summary": "SearchOrders", "operationId": "SearchOrders", - "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](https://developer.squareup.com/reference/square_2024-08-21/objects/SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](https://developer.squareup.com/reference/square_2024-08-21/objects/OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", + "description": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](https://developer.squareup.com/reference/square_2024-09-19/objects/SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return results as complete `Order` objects or as\n[OrderEntry](https://developer.squareup.com/reference/square_2024-09-19/objects/OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10233,12 +10233,12 @@ ], "summary": "RetrieveOrder", "operationId": "RetrieveOrder", - "description": "Retrieves an [Order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) by ID.", + "description": "Retrieves an [Order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) by ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10270,13 +10270,13 @@ ], "summary": "UpdateOrder", "operationId": "UpdateOrder", - "description": "Updates an open [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", + "description": "Updates an open [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the update is\nbeing applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nidentifying the fields to clear.\n\nTo pay for an order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10320,13 +10320,13 @@ ], "summary": "ListOrderCustomAttributes", "operationId": "ListOrderCustomAttributes", - "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Lists the [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10337,7 +10337,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10369,7 +10369,7 @@ }, { "name": "with_definitions", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -10393,13 +10393,13 @@ ], "summary": "DeleteOrderCustomAttribute", "operationId": "DeleteOrderCustomAttribute", - "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10410,7 +10410,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10440,13 +10440,13 @@ ], "summary": "RetrieveOrderCustomAttribute", "operationId": "RetrieveOrderCustomAttribute", - "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\nalso known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Retrieves a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) associated with an order.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\nalso known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10457,7 +10457,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10481,7 +10481,7 @@ }, { "name": "with_definition", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.", "x-is-beta": true, "type": "boolean", "in": "query", @@ -10503,13 +10503,13 @@ ], "summary": "UpsertOrderCustomAttribute", "operationId": "UpsertOrderCustomAttribute", - "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) for an order.\n\nUse this endpoint to set the value of a custom attribute for a specific order.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", + "description": "Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) for an order.\n\nUse this endpoint to set the value of a custom attribute for a specific order.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.)\n\nTo create or update a custom attribute owned by another application, the `visibility` setting\nmust be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10520,7 +10520,7 @@ "parameters": [ { "name": "order_id", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order).", + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order).", "x-is-beta": true, "type": "string", "in": "path", @@ -10561,14 +10561,14 @@ ], "summary": "PayOrder", "operationId": "PayOrder", - "description": "Pay for an [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2024-08-21/objects/Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/create-payment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", + "description": "Pay for an [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2024-09-19/objects/Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/create-payment).\nAny approved payments that reference the same `order_id` not specified in the\n`payment_ids` is canceled.\n- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).\nUsing a delayed capture payment with `PayOrder` completes the approved payment.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "PAYMENTS_WRITE", "ORDERS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10618,7 +10618,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10733,7 +10733,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10774,7 +10774,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10815,7 +10815,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10852,7 +10852,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10900,7 +10900,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10939,7 +10939,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -10985,7 +10985,7 @@ "description": "Retrieves a list of all payouts for the default location.\nYou can filter payouts by location ID, status, time range, and order them in ascending or descending order.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -11062,7 +11062,7 @@ "description": "Retrieves details of a specific payout identified by a payout ID.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -11097,7 +11097,7 @@ "description": "Retrieves a list of all payout entries for a specific payout.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -11155,7 +11155,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11201,7 +11201,7 @@ }, { "name": "status", - "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-08-21/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-09-19/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.", "type": "string", "in": "query", "required": false @@ -11241,7 +11241,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11282,7 +11282,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11321,7 +11321,7 @@ "x-oauthpermissions": [ "ONLINE_STORE_SITE_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11347,12 +11347,12 @@ ], "summary": "DeleteSnippet", "operationId": "DeleteSnippet", - "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-08-21/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-09-19/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11384,12 +11384,12 @@ ], "summary": "RetrieveSnippet", "operationId": "RetrieveSnippet", - "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-08-21/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-09-19/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11421,12 +11421,12 @@ ], "summary": "UpsertSnippet", "operationId": "UpsertSnippet", - "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-08-21/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", + "description": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](https://developer.squareup.com/reference/square_2024-09-19/sites-api/list-sites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "ONLINE_STORE_SNIPPETS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11479,7 +11479,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11528,7 +11528,7 @@ "SUBSCRIPTIONS_READ", "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11571,7 +11571,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11612,7 +11612,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11662,7 +11662,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11716,7 +11716,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11767,7 +11767,7 @@ "SUBSCRIPTIONS_READ", "ITEMS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11818,7 +11818,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11857,7 +11857,7 @@ "x-oauthpermissions": [ "SUBSCRIPTIONS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11916,7 +11916,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -11975,7 +11975,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12034,7 +12034,7 @@ "ORDERS_WRITE", "INVOICES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12088,7 +12088,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12129,7 +12129,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12170,7 +12170,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12211,7 +12211,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12252,7 +12252,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12289,7 +12289,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12337,7 +12337,7 @@ "x-oauthpermissions": [ "EMPLOYEES_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12374,7 +12374,7 @@ "x-oauthpermissions": [ "EMPLOYEES_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12423,7 +12423,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12465,7 +12465,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12507,7 +12507,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12548,7 +12548,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12587,7 +12587,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -12625,7 +12625,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12666,7 +12666,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12707,7 +12707,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12746,7 +12746,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12784,7 +12784,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -12817,12 +12817,12 @@ ], "summary": "CreateTerminalRefund", "operationId": "CreateTerminalRefund", - "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2024-08-21/refunds-api).", + "description": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2024-09-19/refunds-api).", "x-release-status": "PUBLIC", "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12863,7 +12863,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12904,7 +12904,7 @@ "x-oauthpermissions": [ "PAYMENTS_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12943,7 +12943,7 @@ "x-oauthpermissions": [ "PAYMENTS_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -12981,7 +12981,7 @@ "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13014,13 +13014,13 @@ ], "summary": "BulkCreateVendors", "operationId": "BulkCreateVendors", - "description": "Creates one or more [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects to represent suppliers to a seller.", + "description": "Creates one or more [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects to represent suppliers to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13056,13 +13056,13 @@ ], "summary": "BulkRetrieveVendors", "operationId": "BulkRetrieveVendors", - "description": "Retrieves one or more vendors of specified [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) IDs.", + "description": "Retrieves one or more vendors of specified [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) IDs.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13098,13 +13098,13 @@ ], "summary": "BulkUpdateVendors", "operationId": "BulkUpdateVendors", - "description": "Updates one or more of existing [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects as suppliers to a seller.", + "description": "Updates one or more of existing [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects as suppliers to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13140,13 +13140,13 @@ ], "summary": "CreateVendor", "operationId": "CreateVendor", - "description": "Creates a single [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) object to represent a supplier to a seller.", + "description": "Creates a single [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) object to represent a supplier to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13182,13 +13182,13 @@ ], "summary": "SearchVendors", "operationId": "SearchVendors", - "description": "Searches for vendors using a filter against supported [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) properties and a supported sorter.", + "description": "Searches for vendors using a filter against supported [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) properties and a supported sorter.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13224,13 +13224,13 @@ ], "summary": "RetrieveVendor", "operationId": "RetrieveVendor", - "description": "Retrieves the vendor of a specified [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) ID.", + "description": "Retrieves the vendor of a specified [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) ID.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_READ" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13241,7 +13241,7 @@ "parameters": [ { "name": "vendor_id", - "description": "ID of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) to retrieve.", + "description": "ID of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) to retrieve.", "x-is-beta": true, "type": "string", "in": "path", @@ -13263,13 +13263,13 @@ ], "summary": "UpdateVendor", "operationId": "UpdateVendor", - "description": "Updates an existing [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) object as a supplier to a seller.", + "description": "Updates an existing [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) object as a supplier to a seller.", "x-release-status": "BETA", "x-is-beta": true, "x-oauthpermissions": [ "VENDOR_WRITE" ], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [ @@ -13315,7 +13315,7 @@ "description": "Lists all webhook event types that can be subscribed to.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13350,7 +13350,7 @@ "description": "Lists all webhook subscriptions owned by your application.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13366,14 +13366,14 @@ }, { "name": "include_disabled", - "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)s are returned.", + "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)s are returned.", "type": "boolean", "in": "query", "required": false }, { "name": "sort_order", - "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", + "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", "type": "string", "in": "query", "required": false @@ -13404,7 +13404,7 @@ "description": "Creates a webhook subscription.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13441,7 +13441,7 @@ "description": "Deletes a webhook subscription.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13450,7 +13450,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to delete.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to delete.", "type": "string", "in": "path", "required": true @@ -13474,7 +13474,7 @@ "description": "Retrieves a webhook subscription identified by its ID.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13483,7 +13483,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to retrieve.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to retrieve.", "type": "string", "in": "path", "required": true @@ -13507,7 +13507,7 @@ "description": "Updates a webhook subscription.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13516,7 +13516,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to update.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to update.", "type": "string", "in": "path", "required": true @@ -13551,7 +13551,7 @@ "description": "Updates a webhook subscription by replacing the existing signature key with a new one.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13560,7 +13560,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to update.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to update.", "type": "string", "in": "path", "required": true @@ -13595,7 +13595,7 @@ "description": "Tests a webhook subscription by sending a test event to the notification URL.", "x-release-status": "PUBLIC", "x-oauthpermissions": [], - "x-sq-version": "2024-08-21", + "x-sq-version": "2024-09-19", "security": [ { "oauth2": [] @@ -13604,7 +13604,7 @@ "parameters": [ { "name": "subscription_id", - "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to test.", + "description": "[REQUIRED] The ID of the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to test.", "type": "string", "in": "path", "required": true @@ -14034,7 +14034,7 @@ "description": "Requested items can be archived or not archived." } ], - "description": "Defines the values for the `archived_state` query expression \nused in [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-items) \nto return the archived, not archived or either type of catalog items.", + "description": "Defines the values for the `archived_state` query expression \nused in [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-items) \nto return the archived, not archived or either type of catalog items.", "x-release-status": "PUBLIC" }, "BankAccountStatus": { @@ -14945,79 +14945,79 @@ "x-enum-elements": [ { "name": "ITEM", - "description": "The `CatalogObject` instance is of the [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field." }, { "name": "IMAGE", - "description": "The `CatalogObject` instance is of the [CatalogImage](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." + "description": "The `CatalogObject` instance is of the [CatalogImage](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field." }, { "name": "CATEGORY", - "description": "The `CatalogObject` instance is of the [CatalogCategory](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." + "description": "The `CatalogObject` instance is of the [CatalogCategory](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field." }, { "name": "ITEM_VARIATION", - "description": "The `CatalogObject` instance is of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field." }, { "name": "TAX", - "description": "The `CatalogObject` instance is of the [CatalogTax](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." + "description": "The `CatalogObject` instance is of the [CatalogTax](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field." }, { "name": "DISCOUNT", - "description": "The `CatalogObject` instance is of the [CatalogDiscount](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." + "description": "The `CatalogObject` instance is of the [CatalogDiscount](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field." }, { "name": "MODIFIER_LIST", - "description": "The `CatalogObject` instance is of the [CatalogModifierList](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." + "description": "The `CatalogObject` instance is of the [CatalogModifierList](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field." }, { "name": "MODIFIER", - "description": "The `CatalogObject` instance is of the [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." + "description": "The `CatalogObject` instance is of the [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field." }, { "name": "PRICING_RULE", - "description": "The `CatalogObject` instance is of the [CatalogPricingRule](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." + "description": "The `CatalogObject` instance is of the [CatalogPricingRule](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field." }, { "name": "PRODUCT_SET", - "description": "The `CatalogObject` instance is of the [CatalogProductSet](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." + "description": "The `CatalogObject` instance is of the [CatalogProductSet](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field." }, { "name": "TIME_PERIOD", - "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." + "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field." }, { "name": "MEASUREMENT_UNIT", - "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." + "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field." }, { "name": "SUBSCRIPTION_PLAN_VARIATION", - "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field." }, { "name": "ITEM_OPTION", - "description": "The `CatalogObject` instance is of the [CatalogItemOption](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemOption](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field." }, { "name": "ITEM_OPTION_VAL", - "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." + "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of \"Size\" may have item option values such as \"Small\" or \"Medium\".\nThe item-option-value-specific data must be on the `item_option_value_data` field." }, { "name": "CUSTOM_ATTRIBUTE_DEFINITION", - "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." + "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field." }, { "name": "QUICK_AMOUNTS_SETTINGS", - "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." + "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field." }, { "name": "SUBSCRIPTION_PLAN", - "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field." + "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field." }, { "name": "AVAILABILITY_PERIOD", - "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field." + "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field." } ], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", @@ -18009,7 +18009,7 @@ "description": "Specifies that the employee is in the Inactive state." } ], - "description": "The status of the Employee being retrieved.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMemberStatus).", + "description": "The status of the Employee being retrieved.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMemberStatus).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -18944,7 +18944,7 @@ "x-enum-elements": [ { "name": "PICKUP", - "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)." + "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)." }, { "name": "SHIPMENT", @@ -18984,7 +18984,7 @@ "description": "The balance was decreased because the order used to purchase or reload the\ngift card was refunded." } ], - "description": "Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).", + "description": "Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustIncrementReason": { @@ -19008,7 +19008,7 @@ "description": "The transaction is voided." } ], - "description": "Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).", + "description": "Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityBlockReason": { @@ -19022,7 +19022,7 @@ "description": "The gift card is blocked because the buyer initiated a chargeback on the gift card purchase." } ], - "description": "Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).", + "description": "Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityClearBalanceReason": { @@ -19046,7 +19046,7 @@ "description": "The gift card balance was cleared for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API." } ], - "description": "Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).", + "description": "Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityDeactivateReason": { @@ -19070,7 +19070,7 @@ "description": "A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API." } ], - "description": "Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).", + "description": "Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardActivityRedeemStatus": { @@ -19094,7 +19094,7 @@ "description": "The gift card redemption is canceled. A redemption is canceled if the authorization \non the gift card is voided." } ], - "description": "Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", + "description": "Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", "x-release-status": "PUBLIC" }, "GiftCardActivityType": { @@ -19178,7 +19178,7 @@ "description": "Added money to a gift card as the result of a transfer from the balance of another gift card.\n`TRANSFER_BALANCE_TO` activities are managed by Square and cannot be created using the Gift Card Activities API." } ], - "description": "Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivity).", + "description": "Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivity).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnblockReason": { @@ -19192,7 +19192,7 @@ "description": "The gift card is unblocked because a chargeback was ruled in favor of the seller." } ], - "description": "Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard).", + "description": "Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard).", "x-release-status": "PUBLIC" }, "GiftCardGANSource": { @@ -19237,7 +19237,7 @@ }, { "name": "PENDING", - "description": "The gift card is pending activation.\nThis is the initial state when a gift card is created. Typically, you\u0027ll call\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) to create an\n`ACTIVATE` activity that activates the gift card with an initial balance before first use." + "description": "The gift card is pending activation.\nThis is the initial state when a gift card is created. Typically, you\u0027ll call\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) to create an\n`ACTIVATE` activity that activates the gift card with an initial balance before first use." } ], "description": "Indicates the gift card state.", @@ -19415,7 +19415,7 @@ "description": "Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\naccount for the amount of the payment request if the buyer has approved the payment. The buyer receives a\nrequest to approve the payment when the invoice is sent or the invoice is updated.\n\nThis payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. \n\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`." } ], - "description": "Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2024-08-21/objects/InvoicePaymentRequest).", + "description": "Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2024-09-19/objects/InvoicePaymentRequest).", "x-release-status": "PUBLIC" }, "InvoiceCustomFieldPlacement": { @@ -19458,7 +19458,7 @@ "description": "Directs Square to send invoices and receipts to the customer using SMS (text message).\n\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`." } ], - "description": "Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to the customer.", + "description": "Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to the customer.", "x-release-status": "PUBLIC" }, "InvoicePaymentReminderStatus": { @@ -19499,7 +19499,7 @@ "x-enum-elements": [ { "name": "EMAIL", - "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice))." + "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice))." }, { "name": "CHARGE_CARD_ON_FILE", @@ -19515,7 +19515,7 @@ }, { "name": "SMS", - "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." + "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API." }, { "name": "SMS_CHARGE_CARD_ON_FILE", @@ -19761,11 +19761,11 @@ "x-enum-elements": [ { "name": "ACCUMULATE_POINTS", - "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgramAccrualRule)." + "description": "Points are added to a loyalty account for a purchase that\nqualified for points based on an [accrual rule](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgramAccrualRule)." }, { "name": "CREATE_REWARD", - "description": "A [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward) is created." + "description": "A [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward) is created." }, { "name": "REDEEM_REWARD", @@ -19789,7 +19789,7 @@ }, { "name": "ACCUMULATE_PROMOTION_POINTS", - "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion)." + "description": " Points are added to a loyalty account for a purchase that\nqualified for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion)." } ], "description": "The type of the loyalty event.", @@ -19923,7 +19923,7 @@ "description": "Add a specified number of points to those earned from the base loyalty program.\nFor example, \"Earn 10 additional points.\"" } ], - "description": "Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", + "description": "Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionStatus": { @@ -19952,7 +19952,7 @@ "description": "The loyalty promotion is scheduled to start in the future. Square changes the\npromotion status to `ACTIVE` when the `start_date` is reached." } ], - "description": "Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion).", + "description": "Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionTriggerLimitInterval": { @@ -19971,7 +19971,7 @@ "description": "The limit applies per day, according to the `available_time` schedule specified for the promotion.\nFor example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion\na maximum of once per day." } ], - "description": "Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion).", + "description": "Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyRewardStatus": { @@ -20413,7 +20413,7 @@ "x-enum-elements": [ { "name": "PICKUP", - "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)." + "description": "A recipient to pick up the fulfillment from a physical [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)." }, { "name": "SHIPMENT", @@ -20980,14 +20980,14 @@ "x-enum-elements": [ { "name": "NAME", - "description": "To sort the result by the name of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects." + "description": "To sort the result by the name of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects." }, { "name": "CREATED_AT", - "description": "To sort the result by the creation time of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects." + "description": "To sort the result by the creation time of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects." } ], - "description": "The field to sort the returned [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects by.", + "description": "The field to sort the returned [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects by.", "x-release-status": "BETA", "x-is-beta": true }, @@ -21207,7 +21207,7 @@ "description": "Once every two years" } ], - "description": "Determines the billing cadence of a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/Subscription)", + "description": "Determines the billing cadence of a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/Subscription)", "x-release-status": "PUBLIC" }, "SubscriptionEventInfoCode": { @@ -21309,7 +21309,7 @@ "description": "Relative pricing" } ], - "description": "Determines the pricing of a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/Subscription)", + "description": "Determines the pricing of a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/Subscription)", "x-release-status": "PUBLIC" }, "SubscriptionStatus": { @@ -22067,7 +22067,7 @@ "description": "Vendor is inactive and cannot receive purchase orders." } ], - "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor),\nwhether a [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) is active or inactive.", + "description": "The status of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor),\nwhether a [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) is active or inactive.", "x-release-status": "BETA", "x-is-beta": true }, @@ -22254,10 +22254,10 @@ }, "location_id": { "type": "string", - "description": "The [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the purchase was made." + "description": "The [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the purchase was made." } }, - "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/accumulate-loyalty-points) request.", + "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/accumulate-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?account_id\u003d5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", @@ -22294,7 +22294,7 @@ "description": "The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event\nis always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included\nif the purchase also qualifies for a loyalty promotion." } }, - "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/accumulate-loyalty-points) response.", + "description": "Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/accumulate-loyalty-points) response.", "x-release-status": "PUBLIC", "example": { "events": [ @@ -22317,7 +22317,7 @@ "AddGroupToCustomerRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-08-21/customers-api/add-group-to-customer) endpoint.", + "description": "Defines the fields that are included in the request body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-09-19/customers-api/add-group-to-customer) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -22334,7 +22334,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-08-21/customers-api/add-group-to-customer) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-09-19/customers-api/add-group-to-customer) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -22455,7 +22455,7 @@ "description": "Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative\nbalance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting\nthe specified number of points would result in a negative balance. The default value is `false`." } }, - "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/adjust-loyalty-points) request.", + "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/adjust-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?account_id\u003d5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd", @@ -22483,7 +22483,7 @@ "description": "The resulting event data for the adjustment." } }, - "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/adjust-loyalty-points) request.", + "description": "Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/adjust-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "event": { @@ -22543,13 +22543,13 @@ "minLength": 0, "maxLength": 36, "type": "string", - "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) object representing the service booked in this segment." + "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) object representing the service booked in this segment." }, "team_member_id": { "minLength": 1, "maxLength": 32, "type": "string", - "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) object representing the team member booked in this segment." + "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) object representing the team member booked in this segment." }, "service_variation_version": { "type": "integer", @@ -22936,7 +22936,7 @@ "catalog_version": { "type": "integer", "format": "int64", - "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response. \nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true }, @@ -22984,14 +22984,14 @@ "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s returned." + "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s returned." }, "related_objects": { "type": "array", "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s referenced by the object in the `objects` field." + "description": "A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s referenced by the object in the `objects` field." } }, "description": "", @@ -23184,7 +23184,7 @@ "maximum": 1000, "minimum": 1, "type": "integer", - "description": "The number of [records](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryChange) to return." + "description": "The number of [records](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryChange) to return." } }, "description": "", @@ -23302,7 +23302,7 @@ "maximum": 1000, "minimum": 1, "type": "integer", - "description": "The number of [records](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryCount) to return." + "description": "The number of [records](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryCount) to return." } }, "description": "", @@ -23869,25 +23869,25 @@ "minLength": 0, "maxLength": 32, "type": "string", - "description": "The ID of the [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed." + "description": "The ID of the [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed." }, "customer_id": { "minLength": 0, "maxLength": 192, "type": "string", - "description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) object representing the customer receiving the booked service." + "description": "The ID of the [Customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) object representing the customer receiving the booked service." }, "customer_note": { "minLength": 0, "maxLength": 4096, "type": "string", - "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) instance." + "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) instance." }, "seller_note": { "minLength": 0, "maxLength": 4096, "type": "string", - "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) instance.\nThis field should not be visible to customers." + "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) instance.\nThis field should not be visible to customers." }, "appointment_segments": { "type": "array", @@ -23961,7 +23961,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking)." + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking)." }, "key": { "minLength": 1, @@ -23969,7 +23969,7 @@ "description": "The key of the custom attribute to delete. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key." } }, - "description": "Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-delete-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.", + "description": "Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-delete-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.", "x-release-status": "PUBLIC", "example": { "booking_id": "Z57QXKM2FGXEQDV42W8RBZY7BR", @@ -23981,7 +23981,7 @@ "properties": { "booking_id": { "type": "string", - "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking) associated with the custom attribute." + "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking) associated with the custom attribute." }, "errors": { "type": "array", @@ -23991,7 +23991,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "booking_id": "N3NCVYY3WS27HF0HKANA3R9FP8", @@ -24009,7 +24009,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking)." + "description": "The ID of the target [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -24021,7 +24021,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes)\nrequest. An individual request contains a booking ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -24036,7 +24036,7 @@ "properties": { "booking_id": { "type": "string", - "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking) associated with the custom attribute." + "description": "The ID of the [booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking) associated with the custom attribute." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -24050,7 +24050,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -24215,7 +24215,7 @@ "description": "The tax ID associated with the customer profile. This field is available only for\ncustomers of sellers in EU countries or the United Kingdom. For more information, see\n[Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids)." } }, - "description": "Defines the customer data provided in individual create requests for a\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-create-customers) operation.", + "description": "Defines the customer data provided in individual create requests for a\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-create-customers) operation.", "x-release-status": "PUBLIC" }, "BulkCreateCustomersRequest": { @@ -24232,7 +24232,7 @@ "description": "A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }`\nkey-value pairs.\n\nEach key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)\nthat uniquely identifies the create request. Each value contains the customer data used to create the\ncustomer profile." } }, - "description": "Defines the body parameters that can be included in requests to the\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-create-customers) endpoint.", + "description": "Defines the body parameters that can be included in requests to the\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-create-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -24291,7 +24291,7 @@ "description": "Any top-level errors that prevented the bulk operation from running." } }, - "description": "Defines the fields included in the response body from the\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-create-customers) endpoint.", + "description": "Defines the fields included in the response body from the\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-create-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "responses": { @@ -24471,10 +24471,10 @@ "additionalProperties": { "$ref": "#/definitions/Vendor" }, - "description": "Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." + "description": "Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs." } }, - "description": "Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/bulk-create-vendors).", + "description": "Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/bulk-create-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24529,10 +24529,10 @@ "additionalProperties": { "$ref": "#/definitions/CreateVendorResponse" }, - "description": "A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2024-08-21/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." + "description": "A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2024-09-19/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified\nin the input." } }, - "description": "Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/bulk-create-vendors).", + "description": "Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/bulk-create-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24601,7 +24601,7 @@ "description": "A map containing 1 to 25 individual Delete requests. For each request, provide an\narbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the\ninformation needed to delete a custom attribute." } }, - "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) request.", + "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -24638,7 +24638,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "description": "Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -24669,10 +24669,10 @@ "items": { "type": "string" }, - "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) to delete." + "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) to delete." } }, - "description": "Defines the body parameters that can be included in requests to the\n[BulkDeleteCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-delete-customers) endpoint.", + "description": "Defines the body parameters that can be included in requests to the\n[BulkDeleteCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-delete-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -24702,7 +24702,7 @@ "description": "Any top-level errors that prevented the bulk operation from running." } }, - "description": "Defines the fields included in the response body from the\n[BulkDeleteCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-delete-customers) endpoint.", + "description": "Defines the fields included in the response body from the\n[BulkDeleteCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-delete-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "responses": { @@ -24734,7 +24734,7 @@ "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." } }, - "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-delete-location-custom-attributes) request.", + "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-delete-location-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24766,7 +24766,7 @@ "x-read-only": true } }, - "description": "Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", + "description": "Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true }, @@ -24791,7 +24791,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-delete-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "description": "Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-delete-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24826,7 +24826,7 @@ "description": "Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request" } }, - "description": "Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest.", + "description": "Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-delete-location-custom-attributes)\nrequest.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24848,7 +24848,7 @@ "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response." } }, - "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request.", + "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24876,7 +24876,7 @@ "x-read-only": true } }, - "description": "Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", + "description": "Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", "x-release-status": "BETA", "x-is-beta": true }, @@ -24901,7 +24901,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", + "description": "Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual delete request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24928,7 +24928,7 @@ "description": "Errors that occurred while processing the individual MerchantCustomAttributeDeleteRequest request" } }, - "description": "Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest.", + "description": "Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes)\nrequest.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -24985,7 +24985,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order)." + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order)." } }, "description": "Represents one delete within the bulk operation.", @@ -25036,7 +25036,7 @@ "maxLength": 36, "type": "string" }, - "description": "A non-empty list of [Booking](https://developer.squareup.com/reference/square_2024-08-21/objects/Booking) IDs specifying bookings to retrieve." + "description": "A non-empty list of [Booking](https://developer.squareup.com/reference/square_2024-09-19/objects/Booking) IDs specifying bookings to retrieve." } }, "description": "Request payload for bulk retrieval of bookings.", @@ -25142,10 +25142,10 @@ "items": { "type": "string" }, - "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) to retrieve." + "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) to retrieve." } }, - "description": "Defines the body parameters that can be included in requests to the\n[BulkRetrieveCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-retrieve-customers) endpoint.", + "description": "Defines the body parameters that can be included in requests to the\n[BulkRetrieveCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-retrieve-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -25175,7 +25175,7 @@ "description": "Any top-level errors that prevented the bulk operation from running." } }, - "description": "Defines the fields included in the response body from the\n[BulkRetrieveCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-retrieve-customers) endpoint.", + "description": "Defines the fields included in the response body from the\n[BulkRetrieveCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-retrieve-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "responses": { @@ -25238,7 +25238,7 @@ "description": "A non-empty list of IDs of team members whose booking profiles you want to retrieve." } }, - "description": "Request payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-08-21/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", + "description": "Request payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-09-19/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", "x-release-status": "PUBLIC", "example": { "team_member_ids": [ @@ -25256,7 +25256,7 @@ "additionalProperties": { "$ref": "#/definitions/RetrieveTeamMemberBookingProfileResponse" }, - "description": "The returned team members\u0027 booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMemberBookingProfile) the value." + "description": "The returned team members\u0027 booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMemberBookingProfile) the value." }, "errors": { "type": "array", @@ -25266,7 +25266,7 @@ "description": "Errors that occurred during the request." } }, - "description": "Response payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-08-21/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", + "description": "Response payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-09-19/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.", "x-release-status": "PUBLIC", "example": { "team_member_booking_profiles": { @@ -25307,10 +25307,10 @@ "items": { "type": "string" }, - "description": "IDs of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects to retrieve." + "description": "IDs of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects to retrieve." } }, - "description": "Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/bulk-retrieve-vendors).", + "description": "Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/bulk-retrieve-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25336,10 +25336,10 @@ "additionalProperties": { "$ref": "#/definitions/RetrieveVendorResponse" }, - "description": "The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2024-08-21/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." + "description": "The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2024-09-19/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs." } }, - "description": "Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/bulk-retrieve-vendors).", + "description": "Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/bulk-retrieve-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25400,7 +25400,7 @@ "description": "The ID of the location to associate with the swapped subscriptions." } }, - "description": "Defines input parameters in a call to the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/bulk-swap-plan) endpoint.", + "description": "Defines input parameters in a call to the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/bulk-swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25426,7 +25426,7 @@ "description": "The number of affected subscriptions." } }, - "description": "Defines output parameters in a response of the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/bulk-swap-plan) endpoint.", + "description": "Defines output parameters in a response of the\n[BulkSwapPlan](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/bulk-swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25492,7 +25492,7 @@ "description": "The current version of the customer profile.\n\nAs a best practice, you should include this field to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol." } }, - "description": "Defines the customer data provided in individual update requests for a\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-update-customers) operation.", + "description": "Defines the customer data provided in individual update requests for a\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-update-customers) operation.", "x-release-status": "PUBLIC" }, "BulkUpdateCustomersRequest": { @@ -25506,10 +25506,10 @@ "additionalProperties": { "$ref": "#/definitions/BulkUpdateCustomerData" }, - "description": "A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }`\nkey-value pairs.\n\nEach key is the ID of the [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) to update. To update a customer profile\nthat was created by merging existing profiles, provide the ID of the newly created profile.\n\nEach value contains the updated customer data. Only new or changed fields are required. To add or\nupdate a field, specify the new value. To remove a field, specify `null`." + "description": "A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }`\nkey-value pairs.\n\nEach key is the ID of the [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) to update. To update a customer profile\nthat was created by merging existing profiles, provide the ID of the newly created profile.\n\nEach value contains the updated customer data. Only new or changed fields are required. To add or\nupdate a field, specify the new value. To remove a field, specify `null`." } }, - "description": "Defines the body parameters that can be included in requests to the\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-update-customers) endpoint.", + "description": "Defines the body parameters that can be included in requests to the\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-update-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -25547,7 +25547,7 @@ "description": "Any top-level errors that prevented the bulk operation from running." } }, - "description": "Defines the fields included in the response body from the\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-update-customers) endpoint.", + "description": "Defines the fields included in the response body from the\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-update-customers) endpoint.", "x-release-status": "PUBLIC", "example": { "responses": { @@ -25714,10 +25714,10 @@ "additionalProperties": { "$ref": "#/definitions/UpdateVendorRequest" }, - "description": "A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2024-08-21/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." + "description": "A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2024-09-19/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)\nobjects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs." } }, - "description": "Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/bulk-update-vendors).", + "description": "Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/bulk-update-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25758,10 +25758,10 @@ "additionalProperties": { "$ref": "#/definitions/UpdateVendorResponse" }, - "description": "A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2024-08-21/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." + "description": "A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2024-09-19/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)\nobjects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or \n`Vendor`-ID/error-object pairs." } }, - "description": "Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/bulk-update-vendors).", + "description": "Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/bulk-update-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -25834,7 +25834,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) request.", + "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -25894,7 +25894,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -25976,7 +25976,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -26030,7 +26030,7 @@ "customer_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer)." + "description": "The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -26042,7 +26042,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC" }, "BulkUpsertCustomerCustomAttributesResponse": { @@ -26063,7 +26063,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "PUBLIC", "example": { "values": { @@ -26144,7 +26144,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.", "x-release-status": "PUBLIC", "example": { "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8", @@ -26172,7 +26172,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-upsert-location-custom-attributes) request.", + "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-upsert-location-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26213,7 +26213,7 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)." + "description": "The ID of the target [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -26225,7 +26225,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nrequest. An individual request contains a location ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-upsert-location-custom-attributes)\nrequest. An individual request contains a location ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "BETA", "x-is-beta": true }, @@ -26247,7 +26247,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-upsert-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-upsert-location-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26307,7 +26307,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/bulk-upsert-location-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/bulk-upsert-location-custom-attributes) operation.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26336,7 +26336,7 @@ "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the\ninformation needed to create or update a custom attribute." } }, - "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) request.", + "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26370,7 +26370,7 @@ "merchant_id": { "minLength": 1, "type": "string", - "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-08-21/objects/Merchant)." + "description": "The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-09-19/objects/Merchant)." }, "custom_attribute": { "$ref": "#/definitions/CustomAttribute", @@ -26382,7 +26382,7 @@ "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nrequest. An individual request contains a merchant ID, the custom attribute to create or update,\nand an optional idempotency key.", + "description": "Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes)\nrequest. An individual request contains a merchant ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "BETA", "x-is-beta": true }, @@ -26404,7 +26404,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", + "description": "Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) response,\nwhich contains a map of responses that each corresponds to an individual upsert request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26453,7 +26453,7 @@ "description": "Any errors that occurred while processing the individual request." } }, - "description": "Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) operation.", + "description": "Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) operation.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -26529,7 +26529,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order)." + "description": "The ID of the target [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order)." } }, "description": "Represents one upsert within the bulk operation.", @@ -26747,7 +26747,7 @@ "properties": { "order_id": { "type": "string", - "description": "The [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`." + "description": "The [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) ID for which to calculate the points.\nSpecify this field if your application uses the Orders API to process orders.\nOtherwise, specify the `transaction_amount_money`." }, "transaction_amount_money": { "$ref": "#/definitions/Money", @@ -26757,10 +26757,10 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion\u0027s\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit." + "description": "The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount). Optionally specify this field\nif your application uses the Orders API to process orders.\n\nIf specified, the `promotion_points` field in the response shows the number of points the buyer would\nearn from the purchase. In this case, Square uses the account ID to determine whether the promotion\u0027s\n`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.\nIf not specified, the `promotion_points` field shows the number of points the purchase qualifies\nfor regardless of the trigger limit." } }, - "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/calculate-loyalty-points) request.", + "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/calculate-loyalty-points) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -26791,7 +26791,7 @@ "description": "The number of points that the buyer can earn from a loyalty promotion. To be eligible\nto earn promotion points, the purchase must first qualify for program points. When `order_id`\nis not provided in the request, this value is always 0." } }, - "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/calculate-loyalty-points) response.", + "description": "Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/calculate-loyalty-points) response.", "x-release-status": "PUBLIC", "example": { "points": 6, @@ -27094,7 +27094,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/list-invoices)." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/list-invoices)." } }, "description": "Describes a `CancelInvoice` request.", @@ -27196,7 +27196,7 @@ "CancelLoyaltyPromotionRequest": { "type": "object", "properties": {}, - "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/cancel-loyalty-promotion) request.", + "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/cancel-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id\u003dloypromo_f0f9b849-725e-378d-b810-511237e07b67", @@ -27218,7 +27218,7 @@ "description": "The canceled loyalty promotion." } }, - "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/cancel-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "description": "Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/cancel-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -27269,7 +27269,7 @@ "description": "The `idempotency_key` identifying the payment to be canceled." } }, - "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-08-21/payments-api/cancel-payment-by-idempotency-key).", + "description": "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-09-19/payments-api/cancel-payment-by-idempotency-key).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -27288,14 +27288,14 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-08-21/payments-api/cancel-payment-by-idempotency-key).\nOn success, `errors` is empty.", + "description": "Defines the response returned by \n[CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-09-19/payments-api/cancel-payment-by-idempotency-key).\nOn success, `errors` is empty.", "x-release-status": "PUBLIC", "example": {} }, "CancelPaymentRequest": { "type": "object", "properties": {}, - "description": "Describes the request to cancel (void) a payment using\n[CancelPayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/cancel-payment).\nYou can only cancel a payment that is approved (not completed).\nFor more information, see\n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", + "description": "Describes the request to cancel (void) a payment using\n[CancelPayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/cancel-payment).\nYou can only cancel a payment that is approved (not completed).\nFor more information, see\n[Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -27316,7 +27316,7 @@ "description": "The successfully canceled `Payment` object." } }, - "description": "Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/cancel-payment).", + "description": "Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/cancel-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -27385,7 +27385,7 @@ "CancelSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Defines input parameters in a request to the \n[CancelSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/cancel-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[CancelSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/cancel-subscription) endpoint.", "x-release-status": "PUBLIC" }, "CancelSubscriptionResponse": { @@ -27412,7 +27412,7 @@ "x-is-beta": true } }, - "description": "Defines output parameters in a response from the \n[CancelSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/cancel-subscription) endpoint.", + "description": "Defines output parameters in a response from the \n[CancelSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/cancel-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -27619,7 +27619,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/capture-transaction) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/capture-transaction) endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": {}, @@ -27846,7 +27846,7 @@ "minLength": 2, "maxLength": 2, "type": "string", - "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](https://developer.squareup.com/reference/square_2024-08-21/enums/Country)." + "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](https://developer.squareup.com/reference/square_2024-09-19/enums/Country)." }, "buyer_cashtag": { "minLength": 1, @@ -28325,7 +28325,7 @@ }, "custom_attribute_definition_id": { "type": "string", - "description": "The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogCustomAttributeDefinition) this value belongs to.", + "description": "The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogCustomAttributeDefinition) this value belongs to.", "x-read-only": true }, "type": { @@ -28442,7 +28442,7 @@ "description": "The permanent ID for the CatalogObject created by the server." } }, - "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/upsert-catalog-object) or\n[BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/batch-upsert-catalog-objects) to\ncreate a [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", + "description": "A mapping between a temporary client-supplied ID and a permanent server-generated ID.\n\nWhen calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/upsert-catalog-object) or\n[BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/batch-upsert-catalog-objects) to\ncreate a [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) instance, you can supply\na temporary ID for the to-be-created object, especially when the object is to be referenced\nelsewhere in the same request body. This temporary ID can be any string unique within\nthe call, but must be prefixed by \"#\".\n\nAfter the request is submitted and the object created, a permanent server-generated ID is assigned\nto the new object. The permanent ID is unique across the Square catalog.", "x-release-status": "PUBLIC" }, "CatalogImage": { @@ -28450,15 +28450,15 @@ "properties": { "name": { "type": "string", - "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-objects).\nIt is not unique and should not be shown in a buyer facing context." + "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-objects).\nIt is not unique and should not be shown in a buyer facing context." }, "url": { "type": "string", - "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/create-catalog-image) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field." + "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/create-catalog-image) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field." }, "caption": { "type": "string", - "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-objects)." + "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-objects)." }, "photo_studio_order_id": { "type": "string", @@ -28590,7 +28590,7 @@ "description": { "maxLength": 4096, "type": "string", - "description": "The item\u0027s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", + "description": "The item\u0027s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -28644,7 +28644,7 @@ "items": { "$ref": "#/definitions/CatalogObject" }, - "description": "A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) objects for this item. An item must have\nat least one variation." + "description": "A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) objects for this item. An item must have\nat least one variation." }, "product_type": { "type": "string", @@ -28718,7 +28718,7 @@ "description": "The item\u0027s reporting category." } }, - "description": "A [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", + "description": "A [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", "x-release-status": "PUBLIC", "example": { "object": { @@ -28930,7 +28930,7 @@ }, "name": { "type": "string", - "description": "The item variation\u0027s name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem)\nuses [item options](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points." + "description": "The item variation\u0027s name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem)\nuses [item options](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points." }, "sku": { "type": "string", @@ -29030,12 +29030,12 @@ }, "stockable_conversion": { "$ref": "#/definitions/CatalogStockConversion", - "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogStockConversion) type,\nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion,\nyou can accurately track inventory when an item variation is sold in one unit, but stocked in\nanother unit.", + "description": "The unit conversion rule, as prescribed by the [CatalogStockConversion](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogStockConversion) type,\nthat describes how this non-stockable (i.e., sellable/receivable) item variation is converted\nto/from the stockable item variation sharing the same parent item. With the stock conversion,\nyou can accurately track inventory when an item variation is sold in one unit, but stocked in\nanother unit.", "x-release-status": "BETA", "x-is-beta": true } }, - "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine\u0027s inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", + "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine\u0027s inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", "x-release-status": "PUBLIC" }, "CatalogMeasurementUnit": { @@ -29261,7 +29261,7 @@ "additionalProperties": { "$ref": "#/definitions/CatalogCustomAttributeValue" }, - "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\u0027s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.)." + "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\u0027s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `\"cocoa_brand\"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.)." }, "catalog_v1_ids": { "type": "array", @@ -29601,10 +29601,10 @@ }, "item_variations_for_item_option_values_query": { "$ref": "#/definitions/CatalogQueryItemVariationsForItemOptionValues", - "description": "A query expression to return item variations (of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs." + "description": "A query expression to return item variations (of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) type) that\ncontain all of the specified `CatalogItemOption` IDs." } }, - "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-objects).\nAny combination of the following types may be used together:\n- [exact_query](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogQueryExact)\n- [prefix_query](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogQueryPrefix)\n- [range_query](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogQueryRange)\n- [sorted_attribute_query](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogQuerySortedAttribute)\n- [text_query](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogQueryText)\n\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\nSearchable attribute and objects queryable by searchable attributes:\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", + "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-objects).\nAny combination of the following types may be used together:\n- [exact_query](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogQueryExact)\n- [prefix_query](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogQueryPrefix)\n- [range_query](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogQueryRange)\n- [sorted_attribute_query](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogQuerySortedAttribute)\n- [text_query](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogQueryText)\n\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\nSearchable attribute and objects queryable by searchable attributes:\n- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) objects by searchable attributes, you can use\nthe `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.", "x-release-status": "PUBLIC" }, "CatalogQueryExact": { @@ -29865,7 +29865,7 @@ "stockable_item_variation_id": { "minLength": 1, "type": "string", - "description": "References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItem) of the converted `CatalogItemVariation.`" + "description": "References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItem) of the converted `CatalogItemVariation.`" }, "stockable_quantity": { "minLength": 1, @@ -29877,10 +29877,10 @@ "minLength": 1, "maxLength": 16, "type": "string", - "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point." + "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point." } }, - "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", + "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", "x-release-status": "BETA", "x-is-beta": true }, @@ -29899,7 +29899,7 @@ "items": { "$ref": "#/definitions/SubscriptionPhase" }, - "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-08-21/objects/SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error" + "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-09-19/objects/SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error" }, "subscription_plan_variations": { "type": "array", @@ -29946,7 +29946,7 @@ "items": { "$ref": "#/definitions/SubscriptionPhase" }, - "description": "A list containing each [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-08-21/objects/SubscriptionPhase) for this plan variation." + "description": "A list containing each [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-09-19/objects/SubscriptionPhase) for this plan variation." }, "subscription_plan_id": { "type": "string", @@ -30079,7 +30079,7 @@ "description": "The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes\nplace on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the billing anchor date\nis changed immediately." } }, - "description": "Defines input parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/change-billing-anchor-date) endpoint.", + "description": "Defines input parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/change-billing-anchor-date) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -30110,7 +30110,7 @@ "description": "A list of a single billing anchor date change for the subscription." } }, - "description": "Defines output parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/change-billing-anchor-date) endpoint.", + "description": "Defines output parameters in a request to the\n[ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/change-billing-anchor-date) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -30179,7 +30179,7 @@ }, "delay_capture": { "type": "boolean", - "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/capture-transaction) endpoint) or a Void\n(with the [VoidTransaction](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/void-transaction) endpoint).\n\nDefault value: `false`" + "description": "If `true`, the request will only perform an Auth on the provided\ncard. You can then later perform either a Capture (with the\n[CaptureTransaction](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/capture-transaction) endpoint) or a Void\n(with the [VoidTransaction](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/void-transaction) endpoint).\n\nDefault value: `false`" }, "reference_id": { "maxLength": 40, @@ -30225,7 +30225,7 @@ "description": "A token generated by SqPaymentForm\u0027s verifyBuyer() that represents\ncustomer\u0027s device info and 3ds challenge result." } }, - "description": "Defines the parameters that can be included in the body of\na request to the [Charge](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/create-payment)", + "description": "Defines the parameters that can be included in the body of\na request to the [Charge](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/charge) endpoint.\n\nDeprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/create-payment)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -30319,7 +30319,7 @@ "description": "The created transaction." } }, - "description": "Defines the fields that are included in the response body of\na request to the [Charge](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [Charge](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/charge) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -30740,7 +30740,7 @@ "description": "A value you specify that uniquely identifies this clone request.\n\nIf you are unsure whether a particular order was cloned successfully,\nyou can reattempt the call with the same idempotency key without\nworrying about creating duplicate cloned orders.\nThe originally cloned order is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Defines the fields that are included in requests to the\n[CloneOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/clone-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[CloneOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/clone-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -30766,7 +30766,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/clone-order) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [CloneOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/clone-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -31050,7 +31050,7 @@ "x-is-beta": true } }, - "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/complete-payment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", + "description": "Describes a request to complete (capture) a payment using \n[CompletePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/complete-payment).\n\nBy default, payments are set to `autocomplete` immediately after they are created.\nTo complete payments manually, set `autocomplete` to `false`.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -31071,7 +31071,7 @@ "description": "The successfully completed payment." } }, - "description": "Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/complete-payment).", + "description": "Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/complete-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -31263,7 +31263,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/create-booking-custom-attribute-definition) request.", + "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/create-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -31292,7 +31292,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/create-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/create-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -31512,7 +31512,7 @@ "description": "The card created by the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](https://developer.squareup.com/reference/square_2024-08-21/cards-api/create-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCard](https://developer.squareup.com/reference/square_2024-09-19/cards-api/create-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -31962,7 +31962,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -31993,7 +31993,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/create-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/create-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -32025,7 +32025,7 @@ "description": "The customer group to create." } }, - "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/create-customer-group) endpoint.", + "description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/create-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -32050,7 +32050,7 @@ "description": "The successfully created customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -32157,7 +32157,7 @@ "description": "The created customer." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomer](https://developer.squareup.com/reference/square_2024-08-21/customers-api/create-customer) or\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-create-customers) endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateCustomer](https://developer.squareup.com/reference/square_2024-09-19/customers-api/create-customer) or\n[BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-create-customers) endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "customer": { @@ -32409,14 +32409,14 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\u0027s locations." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\u0027s locations." }, "gift_card": { "$ref": "#/definitions/GiftCard", "description": "The gift card to create. The `type` field is required for this request. The `gan_source` \nand `gan` fields are included as follows: \n\nTo direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`.\n\nTo provide a custom GAN, include `gan_source` and `gan`.\n- For `gan_source`, specify `OTHER`. \n- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be \nunique for the seller and cannot start with the same bank identification number (BIN) as major \ncredit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly \nincrease the risk of fraud. It is the responsibility of the developer to ensure the security \nof their custom GANs. For more information, see \n[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans). \n\nTo register an unused, physical gift card that the seller previously ordered from Square, \ninclude `gan` and provide the GAN that is printed on the gift card." } }, - "description": "Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2024-08-21/gift-cards-api/create-gift-card) request.", + "description": "Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2024-09-19/gift-cards-api/create-gift-card) request.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -32635,7 +32635,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/create-location-custom-attribute-definition) request.", + "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/create-location-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -32667,7 +32667,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/create-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/create-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -32693,7 +32693,7 @@ "description": "The initial values of the location being created. The `name` field is required and must be unique within a seller account.\nAll other fields are optional, but any information you care about for the location should be included.\nThe remaining fields are automatically added based on the data from the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location)." } }, - "description": "The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2024-08-21/locations-api/create-location) endpoint.", + "description": "The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2024-09-19/locations-api/create-location) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -32725,7 +32725,7 @@ "description": "The newly created `Location` object." } }, - "description": "The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2024-08-21/locations-api/create-location) endpoint.", + "description": "The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2024-09-19/locations-api/create-location) endpoint.", "x-release-status": "PUBLIC", "example": { "location": { @@ -32842,7 +32842,7 @@ "description": "A unique identifier for this request, which is used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/create-loyalty-promotion) request.", + "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/create-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -32891,7 +32891,7 @@ "description": "The new loyalty promotion." } }, - "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/create-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", + "description": "Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/create-loyalty-promotion) response.\nEither `loyalty_promotion` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -33005,7 +33005,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) request.", + "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -33037,7 +33037,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -33753,7 +33753,7 @@ }, "customer_id": { "type": "string", - "description": "The [Customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Cards API." + "description": "The [Customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Cards API." }, "location_id": { "type": "string", @@ -33761,7 +33761,7 @@ }, "team_member_id": { "type": "string", - "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) ID to associate with \nthis payment." + "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) ID to associate with \nthis payment." }, "reference_id": { "maxLength": 40, @@ -33816,7 +33816,7 @@ "description": "An optional field for specifying the offline payment details. This is intended for\ninternal 1st-party callers only." } }, - "description": "Describes a request to create a payment using \n[CreatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/create-payment).", + "description": "Describes a request to create a payment using \n[CreatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/create-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -33853,7 +33853,7 @@ "description": "The newly created payment." } }, - "description": "Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/create-payment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", + "description": "Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/create-payment).\n\nIf there are errors processing the request, the `payment` field might not be\npresent, or it might be present with a status of `FAILED`.", "x-release-status": "PUBLIC", "example": { "payment": { @@ -33940,7 +33940,7 @@ "minLength": 1, "maxLength": 192, "type": "string", - "description": "The ID of the tender to refund.\n\nA [`Transaction`](https://developer.squareup.com/reference/square_2024-08-21/objects/Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API." + "description": "The ID of the tender to refund.\n\nA [`Transaction`](https://developer.squareup.com/reference/square_2024-09-19/objects/Transaction) has one or more `tenders` (i.e., methods\nof payment) associated with it, and you refund each tender separately with\nthe Connect API." }, "reason": { "maxLength": 192, @@ -33952,7 +33952,7 @@ "description": "The amount of money to refund.\n\nNote that you specify the amount in the\n__smallest denomination of the applicable currency__. For example, US dollar\namounts are specified in cents. See\n[Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.\n\nThis amount cannot exceed the amount that was originally charged to the\ntender that corresponds to `tender_id`." } }, - "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/create-refund) endpoint.\n\nDeprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment)", + "description": "Defines the body parameters that can be included in\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/create-refund) endpoint.\n\nDeprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -33990,7 +33990,7 @@ "description": "The created refund." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/create-refund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/create-refund) endpoint.\n\nOne of `errors` or `refund` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -34160,7 +34160,7 @@ "customer_id": { "minLength": 1, "type": "string", - "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) subscribing to the subscription plan variation." + "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) subscribing to the subscription plan variation." }, "start_date": { "type": "string", @@ -34181,7 +34181,7 @@ }, "card_id": { "type": "string", - "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-08-21/objects/Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription." + "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-09-19/objects/Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription." }, "timezone": { "type": "string", @@ -34209,7 +34209,7 @@ "description": "array of phases for this subscription" } }, - "description": "Defines input parameters in a request to the \n[CreateSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/create-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[CreateSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/create-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -34247,7 +34247,7 @@ "description": "The newly created subscription.\n\nFor more information, see\n[Subscription object](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#subscription-object)." } }, - "description": "Defines output parameters in a response from the\n[CreateSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/create-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[CreateSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/create-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -34591,14 +34591,14 @@ "minLength": 1, "maxLength": 128, "type": "string", - "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/create-vendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation." + "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/create-vendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation." }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The requested [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) to be created." + "description": "The requested [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) to be created." } }, - "description": "Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/create-vendor).", + "description": "Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/create-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -34639,10 +34639,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The successfully created [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) object." + "description": "The successfully created [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) object." } }, - "description": "Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/create-vendor).", + "description": "Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/create-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -34684,14 +34684,14 @@ "idempotency_key": { "maxLength": 45, "type": "string", - "description": "A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/create-webhook-subscription) request." + "description": "A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/create-webhook-subscription) request." }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to create." + "description": "The [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to create." } }, - "description": "Creates a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription).", + "description": "Creates a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription).", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions", @@ -34721,10 +34721,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The new [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)." + "description": "The new [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/create-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/create-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) will not be\npresent.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -34859,7 +34859,7 @@ "description": "A query expression to filter items or item variations by matching their custom attributes\u0027\n`boolean_value` property values against the specified Boolean expression.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified." } }, - "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-items)\nendpoint to search for items or item variations.", + "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-items)\nendpoint to search for items or item variations.", "x-release-status": "PUBLIC" }, "CustomField": { @@ -34883,7 +34883,7 @@ "properties": { "id": { "type": "string", - "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/search-customers) \nor [ListCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/list-customers) endpoint." + "description": "A unique Square-assigned ID for the customer profile.\n\nIf you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/search-customers) \nor [ListCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/list-customers) endpoint." }, "created_at": { "type": "string", @@ -34900,7 +34900,7 @@ "items": { "$ref": "#/definitions/Card" }, - "description": "Payment details of the credit, debit, and gift cards stored on file for the customer profile. \n\nDEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2024-08-21/cards-api/list-cards) (for credit and debit cards on file) \nor [ListGiftCards](https://developer.squareup.com/reference/square_2024-08-21/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter. \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).", + "description": "Payment details of the credit, debit, and gift cards stored on file for the customer profile. \n\nDEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2024-09-19/cards-api/list-cards) (for credit and debit cards on file) \nor [ListGiftCards](https://developer.squareup.com/reference/square_2024-09-19/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter. \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -34957,14 +34957,14 @@ "items": { "type": "string" }, - "description": "The IDs of [customer groups](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerGroup) the customer belongs to." + "description": "The IDs of [customer groups](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerGroup) the customer belongs to." }, "segment_ids": { "type": "array", "items": { "type": "string" }, - "description": "The IDs of [customer segments](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerSegment) the customer belongs to." + "description": "The IDs of [customer segments](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerSegment) the customer belongs to." }, "version": { "type": "integer", @@ -34991,7 +34991,7 @@ "description": "The country code to search for." } }, - "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", + "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", "x-release-status": "PUBLIC" }, "CustomerCreationSourceFilter": { @@ -35020,18 +35020,18 @@ "properties": { "key": { "type": "string", - "description": "The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api)." + "description": "The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api)." }, "filter": { "$ref": "#/definitions/CustomerCustomAttributeFilterValue", - "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api).\n\nYou must provide this `filter` field, the `updated_at` field, or both." + "description": "A filter that corresponds to the data type of the target custom attribute. For example, provide the `phone` filter to\nsearch based on the value of a `PhoneNumber`-type custom attribute. The data type is specified by the schema field of the custom attribute definition,\nwhich can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api).\n\nYou must provide this `filter` field, the `updated_at` field, or both." }, "updated_at": { "$ref": "#/definitions/TimeRange", "description": "The date range for when the custom attribute was last updated. The date range can include `start_at`, `end_at`, or\nboth. Range boundaries are inclusive. Dates are specified as RFC 3339 timestamps.\n\nYou must provide this `updated_at` field, the `filter` field, or both." } }, - "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute).", + "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute).", "x-release-status": "PUBLIC" }, "CustomerCustomAttributeFilterValue": { @@ -35051,7 +35051,7 @@ }, "selection": { "$ref": "#/definitions/FilterValue", - "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller." + "description": "A filter for a query based on the display name for a `Selection`-type custom attribute value. This filter is case-sensitive\nand can contain `any`, `all`, or both. The `none` condition is not supported.\n\nProvide the display name of each item that you want to search for. To find the display names for the selection, use the \n[Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api) to retrieve the corresponding custom attribute definition\nand then check the `schema.items.names` field. For more information, see\n[Search based on selection](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#custom-attribute-value-filter-selection).\n\nNote that when a `Selection`-type custom attribute is assigned to a customer profile, the custom attribute value is a list of one\nor more UUIDs (sourced from the `schema.items.enum` field) that map to the item names. These UUIDs are unique per seller." }, "date": { "$ref": "#/definitions/TimeRange", @@ -35070,7 +35070,7 @@ "description": "A filter for a query based on the value of an `Address`-type custom attribute. The filter can include `postal_code`, `country`, or both." } }, - "description": "A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute).", + "description": "A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute).", "x-release-status": "PUBLIC" }, "CustomerCustomAttributeFilters": { @@ -35084,7 +35084,7 @@ "description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters." } }, - "description": "The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", + "description": "The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", "x-release-status": "PUBLIC" }, "CustomerDetails": { @@ -35131,18 +35131,18 @@ }, "group_ids": { "$ref": "#/definitions/FilterValue", - "description": "A filter to select customers based on the [groups](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerGroup) they belong to.\nGroup membership is controlled by sellers and developers.\n\nThe `group_ids` filter has the following syntax:\n```\n\"group_ids\": {\n\"any\": [\"{group_a_id}\", \"{group_b_id}\", ...],\n\"all\": [\"{group_1_id}\", \"{group_2_id}\", ...],\n\"none\": [\"{group_i_id}\", \"{group_ii_id}\", ...]\n}\n```\n\nYou can use any combination of the `any`, `all`, and `none` fields in the filter.\nWith `any`, the search returns customers in groups `a` or `b` or any other group specified in the list.\nWith `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list.\nWith `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list.\n\nIf any of the search conditions are not met, including when an invalid or non-existent group ID is provided,\nthe result is an empty object (`{}`)." + "description": "A filter to select customers based on the [groups](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerGroup) they belong to.\nGroup membership is controlled by sellers and developers.\n\nThe `group_ids` filter has the following syntax:\n```\n\"group_ids\": {\n\"any\": [\"{group_a_id}\", \"{group_b_id}\", ...],\n\"all\": [\"{group_1_id}\", \"{group_2_id}\", ...],\n\"none\": [\"{group_i_id}\", \"{group_ii_id}\", ...]\n}\n```\n\nYou can use any combination of the `any`, `all`, and `none` fields in the filter.\nWith `any`, the search returns customers in groups `a` or `b` or any other group specified in the list.\nWith `all`, the search returns customers in groups `1` and `2` and all other groups specified in the list.\nWith `none`, the search returns customers not in groups `i` or `ii` or any other group specified in the list.\n\nIf any of the search conditions are not met, including when an invalid or non-existent group ID is provided,\nthe result is an empty object (`{}`)." }, "custom_attribute": { "$ref": "#/definitions/CustomerCustomAttributeFilters", - "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api). For example, you can call\n[RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/retrieve-customer-custom-attribute) using a customer ID from the result set." + "description": "A filter to select customers based on one or more custom attributes. \nThis filter can contain up to 10 custom attribute filters. Each custom attribute filter specifies filtering criteria for a target custom\nattribute. If multiple custom attribute filters are provided, they are combined as an `AND` operation.\n\nTo be valid for a search, the custom attributes must be visible to the requesting application. For more information, including example queries,\nsee [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\n\nSquare returns matching customer profiles, which do not contain custom attributes. To retrieve customer-related custom attributes,\nuse the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api). For example, you can call\n[RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/retrieve-customer-custom-attribute) using a customer ID from the result set." }, "segment_ids": { "$ref": "#/definitions/FilterValue", - "description": " A filter to select customers based on the [segments](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerSegment) they belong to.\nSegment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria.\n\nYou can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields.\nFor the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C.\n\n```\n\"segment_ids\": {\n\"all\": [\"{segment_A_id}\", \"{segment_B_id}\"],\n\"none\": [\"{segment_C_id}\"]\n}\n```\n\nIf an invalid or non-existent segment ID is provided in the filter, Square stops processing the request\nand returns a `400 BAD_REQUEST` error that includes the segment ID." + "description": " A filter to select customers based on the [segments](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerSegment) they belong to.\nSegment membership is dynamic and adjusts automatically based on whether customers meet the segment criteria.\n\nYou can provide up to three segment IDs in the filter, using any combination of the `all`, `any`, and `none` fields.\nFor the following example, the results include customers who belong to both segment A and segment B but do not belong to segment C.\n\n```\n\"segment_ids\": {\n\"all\": [\"{segment_A_id}\", \"{segment_B_id}\"],\n\"none\": [\"{segment_C_id}\"]\n}\n```\n\nIf an invalid or non-existent segment ID is provided in the filter, Square stops processing the request\nand returns a `400 BAD_REQUEST` error that includes the segment ID." } }, - "description": "Represents the filtering criteria in a [search query](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/search-customers) results.", + "description": "Represents the filtering criteria in a [search query](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/search-customers) results.", "x-release-status": "PUBLIC" }, "CustomerGroup": { @@ -35198,7 +35198,7 @@ "description": "Sorting criteria for query results. The default behavior is to sort \ncustomers alphabetically by `given_name` and `family_name`." } }, - "description": "Represents filtering and sorting criteria for a [SearchCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/search-customers) request.", + "description": "Represents filtering and sorting criteria for a [SearchCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/search-customers) request.", "x-release-status": "PUBLIC" }, "CustomerSegment": { @@ -35244,7 +35244,7 @@ "description": "Indicates the order in which results should be sorted based on the\nsort field value. Strings use standard alphabetic comparison\nto determine order. Strings representing numbers are sorted as strings.\n\nThe default value is `ASC`." } }, - "description": "Represents the sorting criteria in a [search query](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/search-customers) results.", + "description": "Represents the sorting criteria in a [search query](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/search-customers) results.", "x-release-status": "PUBLIC" }, "CustomerTaxIds": { @@ -35256,7 +35256,7 @@ "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only." } }, - "description": "Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", + "description": "Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC" }, "CustomerTextFilter": { @@ -35326,7 +35326,7 @@ "DeleteBookingCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/delete-booking-custom-attribute-definition) request.", + "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/delete-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -35345,7 +35345,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/delete-booking-custom-attribute-definition) response\ncontaining error messages when errors occurred during the request. The successful response does not contain any payload.", + "description": "Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/delete-booking-custom-attribute-definition) response\ncontaining error messages when errors occurred during the request. The successful response does not contain any payload.", "x-release-status": "PUBLIC", "example": { "errors": [] @@ -35354,7 +35354,7 @@ "DeleteBookingCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/delete-booking-custom-attribute) request.", + "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/delete-booking-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -35374,7 +35374,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/delete-booking-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/delete-booking-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "errors": [] @@ -35500,7 +35500,7 @@ "DeleteCustomerCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/delete-customer-custom-attribute-definition) request.", + "description": "Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/delete-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie" @@ -35524,7 +35524,7 @@ "DeleteCustomerCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/delete-customer-custom-attribute) request.", + "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/delete-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie" @@ -35541,14 +35541,14 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/delete-customer-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/delete-customer-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": {} }, "DeleteCustomerGroupRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/delete-customer-group) endpoint.", + "description": "Defines the fields that can be included in a request to the\n[DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/delete-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -35565,7 +35565,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/delete-customer-group) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/delete-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -35643,7 +35643,7 @@ "DeleteInvoiceAttachmentRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/delete-invoice-attachment) request.", + "description": "Represents a [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/delete-invoice-attachment) request.", "x-release-status": "PUBLIC" }, "DeleteInvoiceAttachmentResponse": { @@ -35657,7 +35657,7 @@ "description": "Information about errors encountered during the request." } }, - "description": "Represents a [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/delete-invoice-attachment) response.", + "description": "Represents a [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/delete-invoice-attachment) response.", "x-release-status": "PUBLIC", "example": {} }, @@ -35666,7 +35666,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/list-invoices)." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/get-invoice) or \n[ListInvoices](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/list-invoices)." } }, "description": "Describes a `DeleteInvoice` request.", @@ -35690,7 +35690,7 @@ "DeleteLocationCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/delete-location-custom-attributeDefinition) request.", + "description": "Represents a [DeleteLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/delete-location-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35716,7 +35716,7 @@ "DeleteLocationCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/delete-location-custom-attribute) request.", + "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/delete-location-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35734,7 +35734,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/delete-location-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/delete-location-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -35766,7 +35766,7 @@ "DeleteMerchantCustomAttributeDefinitionRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/delete-merchant-custom-attributeDefinition) request.", + "description": "Represents a [DeleteMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/delete-merchant-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35792,7 +35792,7 @@ "DeleteMerchantCustomAttributeRequest": { "type": "object", "properties": {}, - "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/delete-merchant-custom-attribute) request.", + "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/delete-merchant-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35810,7 +35810,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/delete-merchant-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", + "description": "Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/delete-merchant-custom-attribute) response.\nEither an empty object `{}` (for a successful deletion) or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -35946,7 +35946,7 @@ "DeleteSubscriptionActionRequest": { "type": "object", "properties": {}, - "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/delete-subscription-action)\nendpoint.", + "description": "Defines input parameters in a call to the \n[DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/delete-subscription-action)\nendpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -35965,7 +35965,7 @@ "description": "The subscription that has the specified action deleted." } }, - "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/delete-subscription-action)\nendpoint.", + "description": "Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/delete-subscription-action)\nendpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -35998,7 +35998,7 @@ "DeleteWebhookSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Deletes a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription).", + "description": "Deletes a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription).", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5" @@ -36015,7 +36015,7 @@ "description": "Information on errors encountered during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/delete-webhook-subscription) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/delete-webhook-subscription) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -36618,7 +36618,7 @@ "description": "The retrieved card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](https://developer.squareup.com/reference/square_2024-08-21/cards-api/disable-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [DisableCard](https://developer.squareup.com/reference/square_2024-09-19/cards-api/disable-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -36651,7 +36651,7 @@ "DisableEventsRequest": { "type": "object", "properties": {}, - "description": "Disables [Event](https://developer.squareup.com/reference/square_2024-08-21/objects/Event)s for your application.", + "description": "Disables [Event](https://developer.squareup.com/reference/square_2024-09-19/objects/Event)s for your application.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -36669,7 +36669,7 @@ "description": "Information on errors encountered during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [DisableEvents](https://developer.squareup.com/reference/square_2024-08-21/events-api/disable-events) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [DisableEvents](https://developer.squareup.com/reference/square_2024-09-19/events-api/disable-events) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -37110,7 +37110,7 @@ "x-read-only": true } }, - "description": "An employee object that is used by the external API.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMember](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember).", + "description": "An employee object that is used by the external API.\n\nDEPRECATED at version 2020-08-26. Replaced by [TeamMember](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, @@ -37134,14 +37134,14 @@ "description": "Can be a custom-set hourly wage or the calculated effective hourly\nwage based on the annual wage and hours worked per week." } }, - "description": "The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMemberWage).", + "description": "The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMemberWage).", "x-release-status": "DEPRECATED", "x-is-deprecated": true }, "EnableEventsRequest": { "type": "object", "properties": {}, - "description": "Enables [Event](https://developer.squareup.com/reference/square_2024-08-21/objects/Event)s for your application.", + "description": "Enables [Event](https://developer.squareup.com/reference/square_2024-09-19/objects/Event)s for your application.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -37159,7 +37159,7 @@ "description": "Information on errors encountered during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [EnableEvents](https://developer.squareup.com/reference/square_2024-08-21/events-api/enable-events) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [EnableEvents](https://developer.squareup.com/reference/square_2024-09-19/events-api/enable-events) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -37258,7 +37258,7 @@ "description": "The API version of the event. This corresponds to the default API version of the developer application at the time when the event was created." } }, - "description": "Contains metadata about a particular [Event](https://developer.squareup.com/reference/square_2024-08-21/objects/Event).", + "description": "Contains metadata about a particular [Event](https://developer.squareup.com/reference/square_2024-09-19/objects/Event).", "x-release-status": "BETA", "x-is-beta": true }, @@ -38175,7 +38175,7 @@ "GetPaymentRefundRequest": { "type": "object", "properties": {}, - "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/get-payment-refund).", + "description": "Describes a request to retrieve a refund using\n[GetPaymentRefund](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/get-payment-refund).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -38196,7 +38196,7 @@ "description": "The requested `PaymentRefund`." } }, - "description": "Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/get-payment-refund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", + "description": "Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/get-payment-refund).\n\nNote: If there are errors processing the request, the refund field might not be\npresent or it might be present in a FAILED state.", "x-release-status": "PUBLIC", "example": { "refund": { @@ -38228,7 +38228,7 @@ "GetPaymentRequest": { "type": "object", "properties": {}, - "description": "Describes a request to retrieve a payment using \n[GetPayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/get-payment).", + "description": "Describes a request to retrieve a payment using \n[GetPayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/get-payment).", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -38249,7 +38249,7 @@ "description": "The requested `Payment`." } }, - "description": "Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/get-payment).", + "description": "Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/get-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -38667,7 +38667,7 @@ "maxLength": 191, "type": "string" }, - "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) to whom this gift card is linked.", + "description": "The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) to whom this gift card is linked.", "x-read-only": true } }, @@ -38692,7 +38692,7 @@ }, "location_id": { "type": "string", - "description": "The ID of the [business location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the activity occurred." + "description": "The ID of the [business location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the activity occurred." }, "created_at": { "type": "string", @@ -38722,7 +38722,7 @@ }, "redeem_activity_details": { "$ref": "#/definitions/GiftCardActivityRedeem", - "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/create-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) to create the `REDEEM` activity." + "description": "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/create-payment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) to create the `REDEEM` activity." }, "clear_balance_activity_details": { "$ref": "#/definitions/GiftCardActivityClearBalance", @@ -38742,7 +38742,7 @@ }, "refund_activity_details": { "$ref": "#/definitions/GiftCardActivityRefund", - "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that refund payments to a gift card using the Square Refunds API, Square automatically\ncreates a `REFUND` activity that updates the gift card balance after a [RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment)\nrequest is completed. Applications that use a custom processing system must call\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) to create the `REFUND` activity." + "description": "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that refund payments to a gift card using the Square Refunds API, Square automatically\ncreates a `REFUND` activity that updates the gift card balance after a [RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment)\nrequest is completed. Applications that use a custom processing system must call\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) to create the `REFUND` activity." }, "unlinked_activity_refund_activity_details": { "$ref": "#/definitions/GiftCardActivityUnlinkedActivityRefund", @@ -38779,7 +38779,7 @@ "x-read-only": true } }, - "description": "Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", + "description": "Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", "x-release-status": "PUBLIC" }, "GiftCardActivityActivate": { @@ -38787,15 +38787,15 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "line_item_uid": { "type": "string", - "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "reference_id": { "type": "string", @@ -38806,10 +38806,10 @@ "items": { "type": "string" }, - "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters." + "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters." } }, - "description": "Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustDecrement": { @@ -38828,7 +38828,7 @@ "description": "The reason to decrease the gift card balance." } }, - "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityAdjustIncrement": { @@ -38847,7 +38847,7 @@ "description": "The reason to increase the balance." } }, - "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityBlock": { @@ -38861,7 +38861,7 @@ "description": "The reason to block the gift card." } }, - "description": "Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityClearBalance": { @@ -38875,7 +38875,7 @@ "description": "The reason to decrease the gift card balance." } }, - "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityDeactivate": { @@ -38889,7 +38889,7 @@ "description": "The reason to decrease the balance." } }, - "description": "Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityImport": { @@ -38903,7 +38903,7 @@ "description": "The balance amount on the imported gift card." } }, - "description": "Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", + "description": "Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", "x-release-status": "PUBLIC" }, "GiftCardActivityImportReversal": { @@ -38917,7 +38917,7 @@ "description": "The amount of money cleared from the third-party gift card when \nthe import was reversed." } }, - "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityLoad": { @@ -38925,15 +38925,15 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount added to the gift card. This value is a positive integer.\n\nApplications that use a custom order processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "line_item_uid": { "type": "string", - "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "reference_id": { "type": "string", @@ -38944,10 +38944,10 @@ "items": { "type": "string" }, - "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters." + "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters." } }, - "description": "Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityRedeem": { @@ -38958,7 +38958,7 @@ "properties": { "amount_money": { "$ref": "#/definitions/Money", - "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-08-21/gift-card-activities-api/create-gift-card-activity) request." + "description": "The amount deducted from the gift card for the redemption. This value is a positive integer.\n\nApplications that use a custom payment processing system must specify this amount in the \n[CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-09-19/gift-card-activities-api/create-gift-card-activity) request." }, "payment_id": { "type": "string", @@ -38975,7 +38975,7 @@ "x-read-only": true } }, - "description": "Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityRefund": { @@ -38983,7 +38983,7 @@ "properties": { "redeem_activity_id": { "type": "string", - "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment) request \nrepresents a gift card redemption.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card." + "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment) request \nrepresents a gift card redemption.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card." }, "amount_money": { "$ref": "#/definitions/Money", @@ -38995,11 +38995,11 @@ }, "payment_id": { "type": "string", - "description": "The ID of the refunded payment. Square populates this field if the refund is for a \npayment processed by Square. This field matches the `payment_id` in the corresponding\n[RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment) request.", + "description": "The ID of the refunded payment. Square populates this field if the refund is for a \npayment processed by Square. This field matches the `payment_id` in the corresponding\n[RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment) request.", "x-read-only": true } }, - "description": "Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityTransferBalanceFrom": { @@ -39018,7 +39018,7 @@ "description": "The amount deducted from the gift card for the transfer. This value is a positive integer." } }, - "description": "Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityTransferBalanceTo": { @@ -39037,7 +39037,7 @@ "description": "The amount added to the gift card balance for the transfer. This value is a positive integer." } }, - "description": "Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnblock": { @@ -39051,7 +39051,7 @@ "description": "The reason to unblock a gift card." } }, - "description": "Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "GiftCardActivityUnlinkedActivityRefund": { @@ -39074,7 +39074,7 @@ "x-read-only": true } }, - "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType).", + "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType).", "x-release-status": "PUBLIC" }, "InventoryAdjustment": { @@ -39092,26 +39092,26 @@ }, "from_state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-08-21/enums/InventoryState) of the related quantity\nof items before the adjustment." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-09-19/enums/InventoryState) of the related quantity\nof items before the adjustment." }, "to_state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-08-21/enums/InventoryState) of the related quantity\nof items after the adjustment." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-09-19/enums/InventoryState) of the related quantity\nof items after the adjustment." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the related\nquantity of items is being tracked." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "quantity": { "maxLength": 26, @@ -39142,23 +39142,23 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-08-21/objects/Employee) responsible for the\ninventory adjustment." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-09-19/objects/Employee) responsible for the\ninventory adjustment." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) responsible for the\ninventory adjustment." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) responsible for the\ninventory adjustment." }, "transaction_id": { "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2024-08-21/objects/Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", + "description": "The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2024-09-19/objects/Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", "x-read-only": true }, "refund_id": { "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2024-08-21/objects/Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", + "description": "The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2024-09-19/objects/Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", "x-read-only": true }, "purchase_order_id": { @@ -39219,7 +39219,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](https://developer.squareup.com/reference/square_2024-08-21/enums/InventoryChangeType) for all possible values." + "description": "Indicates how the inventory change is applied. See\n[InventoryChangeType](https://developer.squareup.com/reference/square_2024-09-19/enums/InventoryChangeType) for all possible values." }, "physical_count": { "$ref": "#/definitions/InventoryPhysicalCount", @@ -39231,20 +39231,20 @@ }, "transfer": { "$ref": "#/definitions/InventoryTransfer", - "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-change-inventory) endpoint when the seller has an active Retail Plus subscription." + "description": "Contains details about the inventory transfer when `type` is\n`TRANSFER`, and is unset for all other change types.\n\n_Note:_ An [InventoryTransfer](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryTransfer) object can only be set in the input to the\n[BatchChangeInventory](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-change-inventory) endpoint when the seller has an active Retail Plus subscription." }, "measurement_unit": { "$ref": "#/definitions/CatalogMeasurementUnit", - "description": "The [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "description": "The [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "x-read-only": true }, "measurement_unit_id": { "type": "string", - "description": "The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", + "description": "The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "x-read-only": true } }, - "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) instance.", + "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) instance.", "x-release-status": "PUBLIC" }, "InventoryCount": { @@ -39253,21 +39253,21 @@ "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "state": { "type": "string", - "description": "The current [inventory state](https://developer.squareup.com/reference/square_2024-08-21/enums/InventoryState) for the related\nquantity of items." + "description": "The current [inventory state](https://developer.squareup.com/reference/square_2024-09-19/enums/InventoryState) for the related\nquantity of items." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the related\nquantity of items is being tracked." }, "quantity": { "maxLength": 26, @@ -39282,7 +39282,7 @@ }, "is_estimated": { "type": "boolean", - "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-change-inventory),\n[BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-retrieve-inventory-changes),\n[BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/batch-retrieve-inventory-counts), and\n[RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-08-21/inventory-api/retrieve-inventory-changes).", + "description": "Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of\nany of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-change-inventory),\n[BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-retrieve-inventory-changes),\n[BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/batch-retrieve-inventory-counts), and\n[RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-09-19/inventory-api/retrieve-inventory-changes).", "x-release-status": "BETA", "x-is-beta": true, "x-read-only": true @@ -39297,31 +39297,31 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryPhysicalCount)." + "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryPhysicalCount)." }, "reference_id": { "maxLength": 255, "type": "string", - "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryPhysicalCount) to an external\nsystem." + "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryPhysicalCount) to an external\nsystem." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "state": { "type": "string", - "description": "The current [inventory state](https://developer.squareup.com/reference/square_2024-08-21/enums/InventoryState) for the related\nquantity of items." + "description": "The current [inventory state](https://developer.squareup.com/reference/square_2024-09-19/enums/InventoryState) for the related\nquantity of items." }, "location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the related\nquantity of items is being tracked." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the related\nquantity of items is being tracked." }, "quantity": { "maxLength": 26, @@ -39336,12 +39336,12 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-08-21/objects/Employee) responsible for the\nphysical count." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-09-19/objects/Employee) responsible for the\nphysical count." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) responsible for the\nphysical count." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) responsible for the\nphysical count." }, "occurred_at": { "maxLength": 34, @@ -39373,27 +39373,27 @@ }, "state": { "type": "string", - "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-08-21/enums/InventoryState) for the quantity of\nitems being transferred." + "description": "The [inventory state](https://developer.squareup.com/reference/square_2024-09-19/enums/InventoryState) for the quantity of\nitems being transferred." }, "from_location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the related\nquantity of items was tracked before the transfer." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the related\nquantity of items was tracked before the transfer." }, "to_location_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the related\nquantity of items was tracked after the transfer." + "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the related\nquantity of items was tracked after the transfer." }, "catalog_object_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked." + "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked." }, "catalog_object_type": { "maxLength": 14, "type": "string", - "description": "The [type](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." + "description": "The [type](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value. \nIn addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app." }, "quantity": { "maxLength": 26, @@ -39419,12 +39419,12 @@ "employee_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-08-21/objects/Employee) responsible for the\ninventory transfer." + "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-09-19/objects/Employee) responsible for the\ninventory transfer." }, "team_member_id": { "maxLength": 100, "type": "string", - "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) responsible for the\ninventory transfer." + "description": "The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) responsible for the\ninventory transfer." } }, "description": "Represents the transfer of a quantity of product inventory at a\nparticular time from one location to another.", @@ -39452,7 +39452,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/retrieve-order) endpoint using the order ID." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/retrieve-order) endpoint using the order ID." }, "primary_recipient": { "$ref": "#/definitions/InvoiceRecipient", @@ -39534,7 +39534,7 @@ }, "subscription_id": { "type": "string", - "description": "The ID of the [subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", + "description": "The ID of the [subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", "x-read-only": true }, "sale_or_service_date": { @@ -39556,7 +39556,7 @@ "items": { "$ref": "#/definitions/InvoiceAttachment" }, - "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/create-invoice-attachment) and [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-08-21/invoices-api/delete-invoice-attachment) endpoints.", + "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/create-invoice-attachment) and [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-09-19/invoices-api/delete-invoice-attachment) endpoints.", "x-read-only": true } }, @@ -39584,10 +39584,10 @@ }, "cash_app_pay": { "type": "boolean", - "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) in the United States." + "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) in the United States." } }, - "description": "The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) on the Square-hosted invoice payment page.", + "description": "The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) on the Square-hosted invoice payment page.", "x-release-status": "PUBLIC" }, "InvoiceAttachment": { @@ -39629,7 +39629,7 @@ "x-read-only": true } }, - "description": "Represents a file attached to an [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice).", + "description": "Represents a file attached to an [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice).", "x-release-status": "PUBLIC" }, "InvoiceCustomField": { @@ -39718,7 +39718,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice)." + "description": "The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice)." }, "request_method": { "type": "string", @@ -39754,7 +39754,7 @@ "minLength": 1, "maxLength": 255, "type": "string", - "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](https://developer.squareup.com/reference/square_2024-08-21/cards-api/list-cards) and include the `customer_id` of the invoice recipient." + "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](https://developer.squareup.com/reference/square_2024-09-19/cards-api/list-cards) and include the `customer_id` of the invoice recipient." }, "reminders": { "type": "array", @@ -39779,7 +39779,7 @@ "x-read-only": true } }, - "description": "Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", + "description": "Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC" }, "InvoiceQuery": { @@ -40101,7 +40101,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/list-booking-custom-attribute-definitions) request.", + "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/list-booking-custom-attribute-definitions) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -40131,7 +40131,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/list-booking-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/list-booking-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definitions": [ @@ -40179,10 +40179,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/list-booking-custom-attributes) request.", + "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/list-booking-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -40212,7 +40212,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/list-booking-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/list-booking-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "PUBLIC", "example": { "custom_attributes": [ @@ -40255,7 +40255,7 @@ "minLength": 0, "maxLength": 192, "type": "string", - "description": "The [customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved." + "description": "The [customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved." }, "team_member_id": { "minLength": 0, @@ -40461,7 +40461,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListCards](https://developer.squareup.com/reference/square_2024-08-21/cards-api/list-cards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListCards](https://developer.squareup.com/reference/square_2024-09-19/cards-api/list-cards) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "cards": [ @@ -40712,12 +40712,12 @@ }, "types": { "type": "string", - "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-08-21/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." + "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-09-19/enums/CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." }, "catalog_version": { "type": "integer", "format": "int64", - "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", + "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s\u0027 `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", "x-release-status": "BETA", "x-is-beta": true } @@ -40813,7 +40813,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?limit\u003d2" @@ -40841,7 +40841,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definitions": [ @@ -40888,10 +40888,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/list-customer-custom-attributes) request.", + "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/list-customer-custom-attributes) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR" @@ -40919,7 +40919,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/list-customer-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/list-customer-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "PUBLIC", "example": { "custom_attributes": [ @@ -40956,7 +40956,7 @@ "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/list-customer-groups) endpoint.", + "description": "Defines the query parameters that can be included in a request to the\n[ListCustomerGroups](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/list-customer-groups) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -40984,7 +40984,7 @@ "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint. This value is present only if the request\nsucceeded and additional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "groups": [ @@ -41781,10 +41781,10 @@ "items": { "$ref": "#/definitions/EventTypeMetadata" }, - "description": "Contains the metadata of an event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-08-21/objects/EventTypeMetadata)." + "description": "Contains the metadata of an event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-09-19/objects/EventTypeMetadata)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListEventTypes](https://developer.squareup.com/reference/square_2024-08-21/events-api/list-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListEventTypes](https://developer.squareup.com/reference/square_2024-09-19/events-api/list-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -41810,7 +41810,7 @@ }, "type": { "type": "string", - "description": "If a [type](https://developer.squareup.com/reference/square_2024-08-21/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." + "description": "If a [type](https://developer.squareup.com/reference/square_2024-09-19/objects/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." }, "location_id": { "type": "string", @@ -41919,11 +41919,11 @@ "properties": { "type": { "type": "string", - "description": "If a [type](https://developer.squareup.com/reference/square_2024-08-21/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." + "description": "If a [type](https://developer.squareup.com/reference/square_2024-09-19/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." }, "state": { "type": "string", - "description": "If a [state](https://developer.squareup.com/reference/square_2024-08-21/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." + "description": "If a [state](https://developer.squareup.com/reference/square_2024-09-19/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." }, "limit": { "maximum": 200, @@ -42281,7 +42281,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/list-location-custom-attribute-definitions) request.", + "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/list-location-custom-attribute-definitions) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42310,7 +42310,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/list-location-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/list-location-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42362,10 +42362,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/list-location-custom-attributes) request.", + "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/list-location-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42394,7 +42394,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/list-location-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/list-location-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42421,7 +42421,7 @@ "ListLocationsRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in requests to the\n[ListLocations](https://developer.squareup.com/reference/square_2024-08-21/locations-api/list-locations) endpoint.", + "description": "Defines the fields that are included in requests to the\n[ListLocations](https://developer.squareup.com/reference/square_2024-09-19/locations-api/list-locations) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -42443,7 +42443,7 @@ "description": "The business locations." } }, - "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](https://developer.squareup.com/reference/square_2024-08-21/locations-api/list-locations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of a request\nto the [ListLocations](https://developer.squareup.com/reference/square_2024-09-19/locations-api/list-locations) endpoint.\n\nEither `errors` or `locations` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "locations": [ @@ -42607,7 +42607,7 @@ "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/list-loyalty-promotions) request.", + "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/list-loyalty-promotions) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd", @@ -42636,7 +42636,7 @@ "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/list-loyalty-promotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", + "description": "Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/list-loyalty-promotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.", "x-release-status": "PUBLIC", "example": { "loyalty_promotions": [ @@ -42727,7 +42727,7 @@ "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) request.", + "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42756,7 +42756,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", + "description": "Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) response.\nEither `custom_attribute_definitions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42808,10 +42808,10 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } }, - "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/list-merchant-custom-attributes) request.", + "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/list-merchant-custom-attributes) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42840,7 +42840,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/list-merchant-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", + "description": "Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/list-merchant-custom-attributes) response.\nEither `custom_attributes`, an empty object, or `errors` is present in the response. If additional\nresults are available, the `cursor` field is also present along with `custom_attributes`.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -42872,7 +42872,7 @@ "description": "The cursor generated by the previous response." } }, - "description": "Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2024-08-21/merchants-api/list-merchants) endpoint.", + "description": "Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2024-09-19/merchants-api/list-merchants) endpoint.", "x-release-status": "PUBLIC" }, "ListMerchantsResponse": { @@ -42897,7 +42897,7 @@ "description": "If the response is truncated, the cursor to use in next request to fetch next set of objects." } }, - "description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2024-08-21/merchants-api/list-merchants) endpoint.", + "description": "The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2024-09-19/merchants-api/list-merchants) endpoint.", "x-release-status": "PUBLIC", "example": { "merchant": [ @@ -43030,7 +43030,7 @@ }, "with_definitions": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." } }, "description": "Represents a list request for order custom attributes.", @@ -43170,7 +43170,7 @@ }, "status": { "type": "string", - "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-08-21/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." + "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-09-19/objects/PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." }, "source_type": { "type": "string", @@ -43181,7 +43181,7 @@ "description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100" } }, - "description": "Describes a request to list refunds using\n[ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/list-payment-refunds).\n\nThe maximum results per page is 100.", + "description": "Describes a request to list refunds using\n[ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/list-payment-refunds).\n\nThe maximum results per page is 100.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -43209,7 +43209,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/list-payment-refunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", + "description": "Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/list-payment-refunds).\n\nEither `errors` or `refunds` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "refunds": [ @@ -43295,7 +43295,7 @@ "description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time." } }, - "description": "Describes a request to list payments using \n[ListPayments](https://developer.squareup.com/reference/square_2024-08-21/payments-api/list-payments). \n\nThe maximum results per page is 100.", + "description": "Describes a request to list payments using \n[ListPayments](https://developer.squareup.com/reference/square_2024-09-19/payments-api/list-payments). \n\nThe maximum results per page is 100.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -43323,7 +43323,7 @@ "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2024-08-21/payments-api/list-payments).", + "description": "Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2024-09-19/payments-api/list-payments).", "x-release-status": "PUBLIC", "example": { "payments": [ @@ -43628,7 +43628,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/list-refunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-08-21/orders-api/search-orders)", + "description": "Defines the query parameters that can be included in\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/list-refunds) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-09-19/orders-api/search-orders)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -43665,7 +43665,7 @@ "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -43764,7 +43764,7 @@ "description": "The upper limit on the number of subscription events to return\nin a paged response." } }, - "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/list-subscription-events)\nendpoint.", + "description": "Defines input parameters in a request to the \n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/list-subscription-events)\nendpoint.", "x-release-status": "PUBLIC" }, "ListSubscriptionEventsResponse": { @@ -43789,7 +43789,7 @@ "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of events.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/list-subscription-events).", + "description": "Defines output parameters in a response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/list-subscription-events).", "x-release-status": "PUBLIC", "example": { "subscription_events": [ @@ -44031,7 +44031,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/list-transactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-08-21/orders-api/search-orders)", + "description": "Defines the query parameters that can be included in\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/list-transactions) endpoint.\n\nDeprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-09-19/orders-api/search-orders)", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -44068,7 +44068,7 @@ "description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/list-transactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/list-transactions) endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -44192,10 +44192,10 @@ "items": { "$ref": "#/definitions/EventTypeMetadata" }, - "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-08-21/objects/EventTypeMetadata)." + "description": "Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-09-19/objects/EventTypeMetadata)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/list-webhook-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/list-webhook-event-types) endpoint.\n\nNote: if there are errors processing the request, the event types field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "event_types": [ @@ -44220,11 +44220,11 @@ }, "include_disabled": { "type": "boolean", - "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)s are returned." + "description": "Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)s.\nBy default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)s are returned." }, "sort_order": { "type": "string", - "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." + "description": "Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." }, "limit": { "maximum": 100, @@ -44233,7 +44233,7 @@ "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100" } }, - "description": "Lists all [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)s owned by your application.", + "description": "Lists all [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)s owned by your application.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions" @@ -44254,14 +44254,14 @@ "items": { "$ref": "#/definitions/WebhookSubscription" }, - "description": "The requested list of [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)s." + "description": "The requested list of [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)s." }, "cursor": { "type": "string", "description": "The pagination cursor to be used in a subsequent request. If empty,\nthis is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/list-webhook-subscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/list-webhook-subscriptions) endpoint.\n\nNote: if there are errors processing the request, the subscriptions field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "subscriptions": [ @@ -44365,7 +44365,7 @@ "items": { "type": "string" }, - "description": "The Square features that are enabled for the location.\nSee [LocationCapability](https://developer.squareup.com/reference/square_2024-08-21/enums/LocationCapability) for possible values.", + "description": "The Square features that are enabled for the location.\nSee [LocationCapability](https://developer.squareup.com/reference/square_2024-09-19/enums/LocationCapability) for possible values.", "x-read-only": true }, "status": { @@ -44387,7 +44387,7 @@ }, "country": { "type": "string", - "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](https://developer.squareup.com/reference/square_2024-08-21/enums/Country) for possible values.", + "description": "The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.\n\nSee [Country](https://developer.squareup.com/reference/square_2024-09-19/enums/Country) for possible values.", "x-read-only": true }, "language_code": { @@ -44398,7 +44398,7 @@ }, "currency": { "type": "string", - "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](https://developer.squareup.com/reference/square_2024-08-21/enums/Currency) for possible values.", + "description": "The currency used for all transactions at this location,\nin ISO 4217 format. For example, the currency code for US dollars is `USD`.\nSee [Currency](https://developer.squareup.com/reference/square_2024-09-19/enums/Currency) for possible values.", "x-read-only": true }, "phone_number": { @@ -44496,7 +44496,7 @@ "properties": { "location_id": { "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location)." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location)." }, "booking_site_url": { "type": "string", @@ -44526,7 +44526,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram) to which the account belongs." + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram) to which the account belongs." }, "balance": { "type": "integer", @@ -44541,7 +44541,7 @@ }, "customer_id": { "type": "string", - "description": "The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) that is associated with the account." + "description": "The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) that is associated with the account." }, "enrolled_at": { "type": "string", @@ -44569,7 +44569,7 @@ "description": "The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. \n\nThe total number of points in this field equals the number of points in the `balance` field." } }, - "description": "Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", + "description": "Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", "x-release-status": "PUBLIC" }, "LoyaltyAccountExpiringPointDeadline": { @@ -44670,12 +44670,12 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount) associated with the event.", + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount) associated with the event.", "x-read-only": true }, "location_id": { "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the event occurred.", + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the event occurred.", "x-read-only": true }, "source": { @@ -44708,7 +44708,7 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": false }, "points": { @@ -44718,7 +44718,7 @@ }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) for which the buyer accumulated the points.\nThis field is returned only if the Orders API is used to process orders." } }, "description": "Provides metadata when the event `type` is `ACCUMULATE_POINTS`.", @@ -44734,14 +44734,14 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": true }, "loyalty_promotion_id": { "minLength": 1, "maxLength": 255, "type": "string", - "description": "The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion).", + "description": "The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion).", "x-read-only": true }, "points": { @@ -44752,7 +44752,7 @@ "order_id": { "minLength": 1, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) for which the buyer earned the promotion points.\nOnly applications that use the Orders API to process orders can trigger this event.", "x-read-only": true } }, @@ -44768,7 +44768,7 @@ "loyalty_program_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": false }, "points": { @@ -44794,13 +44794,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "points": { @@ -44838,13 +44838,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "points": { @@ -44868,7 +44868,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -44919,7 +44919,7 @@ "minLength": 1, "type": "string" }, - "description": "The [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." + "description": "The [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) IDs for loyalty events to query.\nIf multiple values are specified, the endpoint uses \na logical OR to combine them." } }, "description": "Filter events by location.", @@ -44934,7 +44934,7 @@ "loyalty_account_id": { "minLength": 1, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount) associated with loyalty events." + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount) associated with loyalty events." } }, "description": "Filter events by loyalty account.", @@ -44949,7 +44949,7 @@ "order_id": { "minLength": 1, "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) associated with the event." + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) associated with the event." } }, "description": "Filter events by the order associated with the event.", @@ -44966,7 +44966,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": true }, "points": { @@ -44998,18 +44998,18 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-read-only": true }, "reward_id": { "maxLength": 36, "type": "string", - "description": "The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", + "description": "The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyReward).\nThis field is returned only if the event source is `LOYALTY_API`.", "x-read-only": true }, "order_id": { "type": "string", - "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", + "description": "The ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) that redeemed the reward.\nThis field is returned only if the Orders API is used to process orders.", "x-read-only": true } }, @@ -45070,7 +45070,7 @@ "minLength": 1, "type": "string" }, - "description": "The [locations](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) at which the program is active." + "description": "The [locations](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) at which the program is active." }, "created_at": { "type": "string", @@ -45087,7 +45087,7 @@ "items": { "$ref": "#/definitions/LoyaltyProgramAccrualRule" }, - "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/list-loyalty-promotions)." + "description": "Defines how buyers can earn loyalty points from the base loyalty program.\nTo check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion) that enable\nbuyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/list-loyalty-promotions)." } }, "description": "Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. \nSquare sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. \nFor more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).", @@ -45125,7 +45125,7 @@ "description": "Additional data for rules with the `CATEGORY` accrual type." } }, - "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram).", + "description": "Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram).", "x-release-status": "PUBLIC" }, "LoyaltyProgramAccrualRuleCategoryData": { @@ -45137,7 +45137,7 @@ "category_id": { "minLength": 1, "type": "string", - "description": "The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) that buyers can purchase to earn\npoints." + "description": "The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) that buyers can purchase to earn\npoints." } }, "description": "Represents additional data for rules with the `CATEGORY` accrual type.", @@ -45152,7 +45152,7 @@ "item_variation_id": { "minLength": 1, "type": "string", - "description": "The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject) that buyers can purchase to earn\npoints." + "description": "The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject) that buyers can purchase to earn\npoints." } }, "description": "Represents additional data for rules with the `ITEM_VARIATION` accrual type.", @@ -45174,14 +45174,14 @@ "items": { "type": "string" }, - "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded categories." + "description": "The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded categories." }, "excluded_item_variation_ids": { "type": "array", "items": { "type": "string" }, - "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded item variations." + "description": "The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.\n\nYou can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/batch-retrieve-catalog-objects)\nendpoint to retrieve information about the excluded item variations." }, "tax_mode": { "type": "string", @@ -45306,7 +45306,7 @@ }, "pricing_rule_reference": { "$ref": "#/definitions/CatalogObjectReference", - "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/retrieve-catalog-object) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details)." + "description": "A reference to the specific version of a `PRICING_RULE` catalog object that contains information about the reward tier discount.\n\nUse `object_id` and `catalog_version` with the [RetrieveCatalogObject](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/retrieve-catalog-object) endpoint\nto get discount details. Make sure to set `include_related_objects` to true in the request to retrieve all catalog objects\nthat define the discount. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details)." } }, "description": "Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers.", @@ -45390,7 +45390,7 @@ }, "loyalty_program_id": { "type": "string", - "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram) associated with the promotion.", + "description": "The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram) associated with the promotion.", "x-read-only": true }, "minimum_spend_amount_money": { @@ -45403,7 +45403,7 @@ "minLength": 1, "type": "string" }, - "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both." + "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both." }, "qualifying_category_ids": { "type": "array", @@ -45411,10 +45411,10 @@ "minLength": 1, "type": "string" }, - "description": "The IDs of any qualifying `CATEGORY` [catalog objects](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both." + "description": "The IDs of any qualifying `CATEGORY` [catalog objects](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both." } }, - "description": "Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", + "description": "Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionAvailableTimeData": { @@ -45441,7 +45441,7 @@ "description": "A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)\n(`VEVENT`). Each event represents an available time period per day or days of the week. \nA day can have a maximum of one available time period.\n\nOnly `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and\ntimestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,\nan end date (using the `UNTIL` keyword), or both. For more information, see\n[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).\n\nNote that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request\nbut are always included in the response." } }, - "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion).", + "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentive": { @@ -45463,7 +45463,7 @@ "description": "Additional data for a `POINTS_ADDITION` incentive type." } }, - "description": "Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", + "description": "Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentivePointsAdditionData": { @@ -45478,7 +45478,7 @@ "description": "The number of additional points to earn each time the promotion is triggered. For example,\nsuppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also\nqualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer\nearns a total of 8 points (5 program points + 3 promotion points \u003d 8 points)." } }, - "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotionIncentive).", + "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionIncentivePointsMultiplierData": { @@ -45498,7 +45498,7 @@ "description": "The multiplier used to calculate the number of points earned each time the promotion is triggered,\nspecified as a string representation of a decimal. Square supports multipliers up to 10x, with three\npoint precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the\nbase loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a\n`multiplier` of \"1.5\", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier \u003d 6 points).\nFractional points are dropped.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) This `multiplier` field.\n- The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value." } }, - "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotionIncentive).", + "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC" }, "LoyaltyPromotionTriggerLimit": { @@ -45518,7 +45518,7 @@ "description": "The time period the limit applies to." } }, - "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", + "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", "x-release-status": "PUBLIC" }, "LoyaltyReward": { @@ -45543,13 +45543,13 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount) to which the reward belongs." + "description": "The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount) to which the reward belongs." }, "reward_tier_id": { "minLength": 1, "maxLength": 36, "type": "string", - "description": "The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgramRewardTier) used to create the reward." + "description": "The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgramRewardTier) used to create the reward." }, "points": { "minimum": 1, @@ -45559,7 +45559,7 @@ }, "order_id": { "type": "string", - "description": "The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) to which the reward is attached." + "description": "The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) to which the reward is attached." }, "created_at": { "type": "string", @@ -45577,7 +45577,7 @@ "x-read-only": true } }, - "description": "Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", + "description": "Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. \nFor more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).", "x-release-status": "PUBLIC" }, "MeasurementUnit": { @@ -45711,7 +45711,7 @@ }, "currency": { "type": "string", - "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2024-08-21/enums/Currency) for possible values." + "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2024-09-19/enums/Currency) for possible values." } }, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", @@ -45924,7 +45924,7 @@ "customer_id": { "maxLength": 191, "type": "string", - "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", + "description": "The ID of the [customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "x-release-status": "BETA", "x-is-beta": true }, @@ -46035,7 +46035,7 @@ }, "closed_at": { "type": "string", - "description": "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2024-08-21/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", + "description": "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2024-09-19/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").", "x-read-only": true }, "state": { @@ -46082,7 +46082,7 @@ }, "pricing_options": { "$ref": "#/definitions/OrderPricingOptions", - "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogPricingRule)." + "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on\npreconfigured [pricing rules](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogPricingRule)." }, "rewards": { "type": "array", @@ -46163,7 +46163,7 @@ "description": "The location ID the order belongs to." } }, - "description": "A lightweight description of an [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) that is returned when\n`returned_entries` is `true` on a [SearchOrdersRequest](https://developer.squareup.com/reference/square_2024-08-21/orders-api/search-orders).", + "description": "A lightweight description of an [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) that is returned when\n`returned_entries` is `true` on a [SearchOrdersRequest](https://developer.squareup.com/reference/square_2024-09-19/orders-api/search-orders).", "x-release-status": "PUBLIC" }, "OrderFulfillment": { @@ -46709,7 +46709,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) ID applied to this line item." + "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) ID applied to this line item." }, "catalog_version": { "type": "integer", @@ -46739,7 +46739,7 @@ "items": { "$ref": "#/definitions/OrderLineItemModifier" }, - "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier)s applied to this line item." + "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier)s applied to this line item." }, "applied_taxes": { "type": "array", @@ -46908,7 +46908,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogDiscount)." + "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogDiscount)." }, "catalog_version": { "type": "integer", @@ -46962,7 +46962,7 @@ }, "pricing_rule_id": { "type": "string", - "description": "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", + "description": "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "x-read-only": true } }, @@ -46982,7 +46982,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier)." + "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier)." }, "catalog_version": { "type": "integer", @@ -47000,7 +47000,7 @@ }, "base_price_money": { "$ref": "#/definitions/Money", - "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier) price." + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` will\noverride the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier) price." }, "total_price_money": { "$ref": "#/definitions/Money", @@ -47017,7 +47017,7 @@ "x-is-beta": true } }, - "description": "A [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier).", + "description": "A [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier).", "x-release-status": "PUBLIC" }, "OrderLineItemPricingBlocklists": { @@ -47101,7 +47101,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTax)." + "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTax)." }, "catalog_version": { "type": "integer", @@ -47192,7 +47192,7 @@ "x-is-beta": true } }, - "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogPricingRule).", + "description": "Pricing options for an order. The options affect how the order\u0027s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogPricingRule).", "x-release-status": "PUBLIC" }, "OrderQuantityUnit": { @@ -47200,7 +47200,7 @@ "properties": { "measurement_unit": { "$ref": "#/definitions/MeasurementUnit", - "description": "A [MeasurementUnit](https://developer.squareup.com/reference/square_2024-08-21/objects/MeasurementUnit) that represents the\nunit of measure for the quantity." + "description": "A [MeasurementUnit](https://developer.squareup.com/reference/square_2024-09-19/objects/MeasurementUnit) that represents the\nunit of measure for the quantity." }, "precision": { "type": "integer", @@ -47208,7 +47208,7 @@ }, "catalog_object_id": { "type": "string", - "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit." + "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit." }, "catalog_version": { "type": "integer", @@ -47297,7 +47297,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogDiscount)." + "description": "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogDiscount)." }, "catalog_version": { "type": "integer", @@ -47375,7 +47375,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) ID applied to this return line item." + "description": "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) ID applied to this return line item." }, "catalog_version": { "type": "integer", @@ -47396,7 +47396,7 @@ "items": { "$ref": "#/definitions/OrderReturnLineItemModifier" }, - "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier)s applied to this line item." + "description": "The [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier)s applied to this line item." }, "applied_taxes": { "type": "array", @@ -47474,7 +47474,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier)." + "description": "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier)." }, "catalog_version": { "type": "integer", @@ -47488,7 +47488,7 @@ }, "base_price_money": { "$ref": "#/definitions/Money", - "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogModifier) price." + "description": "The base price for the modifier.\n\n`base_price_money` is required for ad hoc modifiers.\nIf both `catalog_object_id` and `base_price_money` are set, `base_price_money` overrides the predefined [CatalogModifier](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogModifier) price." }, "total_price_money": { "$ref": "#/definitions/Money", @@ -47527,7 +47527,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2024-08-21/objects/OrderServiceCharge)." + "description": "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2024-09-19/objects/OrderServiceCharge)." }, "catalog_version": { "type": "integer", @@ -47608,7 +47608,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogTax)." + "description": "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogTax)." }, "catalog_version": { "type": "integer", @@ -47732,7 +47732,7 @@ "catalog_object_id": { "maxLength": 192, "type": "string", - "description": "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)." + "description": "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)." }, "catalog_version": { "type": "integer", @@ -47905,7 +47905,7 @@ "description": "The user-provided reason to pause the subscription." } }, - "description": "Defines input parameters in a request to the\n[PauseSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/pause-subscription) endpoint.", + "description": "Defines input parameters in a request to the\n[PauseSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/pause-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true }, @@ -47931,7 +47931,7 @@ "description": "The list of a `PAUSE` action and a possible `RESUME` action created by the request." } }, - "description": "Defines output parameters in a response from the\n[PauseSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/pause-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[PauseSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/pause-subscription) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -47988,10 +47988,10 @@ "items": { "type": "string" }, - "description": "The IDs of the [payments](https://developer.squareup.com/reference/square_2024-08-21/objects/Payment) to collect.\nThe payment total must match the order total." + "description": "The IDs of the [payments](https://developer.squareup.com/reference/square_2024-09-19/objects/Payment) to collect.\nThe payment total must match the order total." } }, - "description": "Defines the fields that are included in requests to the\n[PayOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/pay-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[PayOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/pay-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -48016,10 +48016,10 @@ }, "order": { "$ref": "#/definitions/Order", - "description": "The paid, updated [order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order)." + "description": "The paid, updated [order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order)." } }, - "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/pay-order) endpoint.", + "description": "Defines the fields that are included in the response body of a request to the\n[PayOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/pay-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -48223,7 +48223,7 @@ }, "approved_money": { "$ref": "#/definitions/Money", - "description": "The amount of money approved for this payment. This value may change if Square chooses to\nobtain reauthorization as part of a call to [UpdatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/update-payment)." + "description": "The amount of money approved for this payment. This value may change if Square chooses to\nobtain reauthorization as part of a call to [UpdatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/update-payment)." }, "processing_fee": { "type": "array", @@ -48333,7 +48333,7 @@ "team_member_id": { "maxLength": 192, "type": "string", - "description": "An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) associated with taking the payment." + "description": "An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) associated with taking the payment." }, "refund_ids": { "type": "array", @@ -49214,7 +49214,7 @@ "properties": { "version": { "type": "integer", - "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." + "description": "The version of the [invoice](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) to publish.\nThis must match the current version of the invoice; otherwise, the request is rejected." }, "idempotency_key": { "maxLength": 128, @@ -49447,7 +49447,7 @@ "location_id": { "minLength": 1, "type": "string", - "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) where the reward is redeemed." + "description": "The ID of the [location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) where the reward is redeemed." } }, "description": "A request to redeem a loyalty reward.", @@ -49600,7 +49600,7 @@ }, "customer_id": { "type": "string", - "description": "The [Customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Cards\nAPI. Only allowed when `unlinked\u003dtrue`." + "description": "The [Customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Cards\nAPI. Only allowed when `unlinked\u003dtrue`." }, "reason": { "maxLength": 192, @@ -49616,10 +49616,10 @@ "team_member_id": { "maxLength": 192, "type": "string", - "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) ID to associate with this refund." + "description": "An optional [TeamMember](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) ID to associate with this refund." } }, - "description": "Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment).", + "description": "Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -49652,7 +49652,7 @@ "description": "The successfully created `PaymentRefund`." } }, - "description": "Defines the response returned by\n[RefundPayment](https://developer.squareup.com/reference/square_2024-08-21/refunds-api/refund-payment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", + "description": "Defines the response returned by\n[RefundPayment](https://developer.squareup.com/reference/square_2024-09-19/refunds-api/refund-payment).\n\nIf there are errors processing the request, the `refund` field might not be\npresent, or it might be present with a status of `FAILED`.", "x-release-status": "PUBLIC", "example": { "refund": { @@ -49688,7 +49688,7 @@ "description": "A domain name as described in RFC-1034 that will be registered with ApplePay." } }, - "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-08-21/apple-pay-api/register-domain) endpoint.", + "description": "Defines the parameters that can be included in the body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-09-19/apple-pay-api/register-domain) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -49716,10 +49716,10 @@ }, "status": { "type": "string", - "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2024-08-21/enums/RegisterDomainResponseStatus) for possible values." + "description": "The status of the domain registration.\n\nSee [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2024-09-19/enums/RegisterDomainResponseStatus) for possible values." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-08-21/apple-pay-api/register-domain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-09-19/apple-pay-api/register-domain) endpoint.\n\nEither `errors` or `status` are present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "status": "VERIFIED" @@ -49736,7 +49736,7 @@ "RemoveGroupFromCustomerRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-08-21/customers-api/remove-group-from-customer) endpoint.", + "description": "Defines the fields that are included in the request body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-09-19/customers-api/remove-group-from-customer) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -49753,7 +49753,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-08-21/customers-api/remove-group-from-customer)\nendpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-09-19/customers-api/remove-group-from-customer)\nendpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -49773,7 +49773,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the\n[ResumeSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/resume-subscription) endpoint.", + "description": "Defines input parameters in a request to the\n[ResumeSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/resume-subscription) endpoint.", "x-release-status": "PUBLIC" }, "ResumeSubscriptionResponse": { @@ -49800,7 +49800,7 @@ "x-is-beta": true } }, - "description": "Defines output parameters in a response from the \n[ResumeSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/resume-subscription) endpoint.", + "description": "Defines output parameters in a response from the \n[ResumeSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/resume-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -49843,7 +49843,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) request.", + "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -49866,7 +49866,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -49889,14 +49889,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/retrieve-booking-custom-attribute) request.", + "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/retrieve-booking-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -49920,7 +49920,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/retrieve-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/retrieve-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -50055,7 +50055,7 @@ "description": "The retrieved card." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](https://developer.squareup.com/reference/square_2024-08-21/cards-api/retrieve-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCard](https://developer.squareup.com/reference/square_2024-09-19/cards-api/retrieve-card) endpoint.\n\nNote: if there are errors processing the request, the card field will not be\npresent.", "x-release-status": "PUBLIC", "example": { "card": { @@ -50175,7 +50175,7 @@ "catalog_version": { "type": "integer", "format": "int64", - "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", + "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "x-release-status": "BETA", "x-is-beta": true }, @@ -50310,7 +50310,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) request.", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie" @@ -50331,7 +50331,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -50353,14 +50353,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.", + "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie" @@ -50381,7 +50381,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/retrieve-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/retrieve-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -50397,7 +50397,7 @@ "RetrieveCustomerGroupRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/retrieve-customer-group) endpoint.", + "description": "Defines the fields that can be included in a request to the\n[RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/retrieve-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": {} @@ -50418,7 +50418,7 @@ "description": "The retrieved customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/retrieve-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/retrieve-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -50824,7 +50824,7 @@ }, "adjustment": { "$ref": "#/definitions/InventoryAdjustment", - "description": "The requested [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryAdjustment)." + "description": "The requested [InventoryAdjustment](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryAdjustment)." } }, "description": "", @@ -50860,7 +50860,7 @@ "properties": { "location_ids": { "type": "string", - "description": "The [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." + "description": "The [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, "cursor": { "type": "string", @@ -50942,7 +50942,7 @@ "properties": { "location_ids": { "type": "string", - "description": "The [Location](https://developer.squareup.com/reference/square_2024-08-21/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." + "description": "The [Location](https://developer.squareup.com/reference/square_2024-09-19/objects/Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, "cursor": { "type": "string", @@ -51028,7 +51028,7 @@ }, "count": { "$ref": "#/definitions/InventoryPhysicalCount", - "description": "The requested [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryPhysicalCount)." + "description": "The requested [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryPhysicalCount)." } }, "description": "", @@ -51082,7 +51082,7 @@ }, "transfer": { "$ref": "#/definitions/InventoryTransfer", - "description": "The requested [InventoryTransfer](https://developer.squareup.com/reference/square_2024-08-21/objects/InventoryTransfer)." + "description": "The requested [InventoryTransfer](https://developer.squareup.com/reference/square_2024-09-19/objects/InventoryTransfer)." } }, "description": "", @@ -51150,7 +51150,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) request.", + "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51172,7 +51172,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51195,14 +51195,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/retrieve-location-custom-attribute) request.", + "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/retrieve-location-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51224,7 +51224,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/retrieve-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/retrieve-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51241,7 +51241,7 @@ "RetrieveLocationRequest": { "type": "object", "properties": {}, - "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](https://developer.squareup.com/reference/square_2024-08-21/locations-api/retrieve-location) endpoint.", + "description": "Defines the fields that are included in the request body for the\n[RetrieveLocation](https://developer.squareup.com/reference/square_2024-09-19/locations-api/retrieve-location) endpoint.", "x-release-status": "PUBLIC", "example": {} }, @@ -51260,7 +51260,7 @@ "description": "The requested location." } }, - "description": "Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2024-08-21/locations-api/retrieve-location)\nendpoint returns in a response.", + "description": "Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2024-09-19/locations-api/retrieve-location)\nendpoint returns in a response.", "x-release-status": "PUBLIC", "example": { "location": { @@ -51407,7 +51407,7 @@ "RetrieveLoyaltyProgramRequest": { "type": "object", "properties": {}, - "description": "A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", + "description": "A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dmain" @@ -51487,7 +51487,7 @@ "RetrieveLoyaltyPromotionRequest": { "type": "object", "properties": {}, - "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-promotion) request.", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-promotion) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?program_id\u003dd619f755-2d17-41f3-990d-c04ecedd64dd\u0026promotion_id\u003dloypromo_f0f9b849-725e-378d-b810-511237e07b67", @@ -51509,7 +51509,7 @@ "description": "The retrieved loyalty promotion." } }, - "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-08-21/loyalty-api/retrieve-loyalty-promotion) response.", + "description": "Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-09-19/loyalty-api/retrieve-loyalty-promotion) response.", "x-release-status": "PUBLIC", "example": { "loyalty_promotion": { @@ -51594,7 +51594,7 @@ "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) request.", + "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51616,7 +51616,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51639,14 +51639,14 @@ "properties": { "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, "version": { "type": "integer", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } }, - "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) request.", + "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51668,7 +51668,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -51685,7 +51685,7 @@ "RetrieveMerchantRequest": { "type": "object", "properties": {}, - "description": "Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-08-21/merchants-api/retrieve-merchant) endpoint.", + "description": "Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-09-19/merchants-api/retrieve-merchant) endpoint.", "x-release-status": "PUBLIC" }, "RetrieveMerchantResponse": { @@ -51703,7 +51703,7 @@ "description": "The requested `Merchant` object." } }, - "description": "The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-08-21/merchants-api/retrieve-merchant) endpoint.", + "description": "The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-09-19/merchants-api/retrieve-merchant) endpoint.", "x-release-status": "PUBLIC", "example": { "merchant": { @@ -51842,7 +51842,7 @@ }, "with_definition": { "type": "boolean", - "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-08-21/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." + "description": "Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-09-19/objects/CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." } }, "description": "Represents a get request for an order custom attribute.", @@ -52139,7 +52139,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/retrieve-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/retrieve-subscription) endpoint.", "x-release-status": "PUBLIC" }, "RetrieveSubscriptionResponse": { @@ -52157,7 +52157,7 @@ "description": "The subscription retrieved." } }, - "description": "Defines output parameters in a response from the\n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/retrieve-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/retrieve-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -52348,7 +52348,7 @@ "description": "The requested transaction." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/retrieve-transaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/retrieve-transaction) endpoint.\n\nOne of `errors` or `transaction` is present in a given response (never both).", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": { @@ -52408,7 +52408,7 @@ "RetrieveVendorRequest": { "type": "object", "properties": {}, - "description": "Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/retrieve-vendor).", + "description": "Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/retrieve-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": {} @@ -52425,10 +52425,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) object." + "description": "The successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) object." } }, - "description": "Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/retrieve-vendor).", + "description": "Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/retrieve-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -52515,7 +52515,7 @@ "RetrieveWebhookSubscriptionRequest": { "type": "object", "properties": {}, - "description": "Retrieves a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) using its id.", + "description": "Retrieves a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) using its id.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5" @@ -52533,10 +52533,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The requested [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)." + "description": "The requested [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint.\n\nNote: if there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) will not be\npresent.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -53045,14 +53045,14 @@ "items": { "$ref": "#/definitions/CustomAttributeFilter" }, - "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-items) endpoint." + "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-items) endpoint." }, "archived_state": { "type": "string", "description": "The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items." } }, - "description": "Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-items) endpoint.", + "description": "Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-items) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -53125,7 +53125,7 @@ "description": "Ids of returned item variations matching the specified query expression." } }, - "description": "Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-08-21/catalog-api/search-catalog-items) endpoint.", + "description": "Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-09-19/catalog-api/search-catalog-items) endpoint.", "x-release-status": "PUBLIC", "example": { "items": [ @@ -53648,7 +53648,7 @@ "description": "The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query." } }, - "description": "Searches [Event](https://developer.squareup.com/reference/square_2024-08-21/objects/Event)s for your application.", + "description": "Searches [Event](https://developer.squareup.com/reference/square_2024-09-19/objects/Event)s for your application.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -53670,21 +53670,21 @@ "items": { "$ref": "#/definitions/Event" }, - "description": "The list of [Event](https://developer.squareup.com/reference/square_2024-08-21/objects/Event)s returned by the search." + "description": "The list of [Event](https://developer.squareup.com/reference/square_2024-09-19/objects/Event)s returned by the search." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/EventMetadata" }, - "description": "Contains the metadata of an event. For more information, see [Event](https://developer.squareup.com/reference/square_2024-08-21/objects/Event)." + "description": "Contains the metadata of an event. For more information, see [Event](https://developer.squareup.com/reference/square_2024-09-19/objects/Event)." }, "cursor": { "type": "string", "description": "When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [SearchEvents](https://developer.squareup.com/reference/square_2024-08-21/events-api/search-events) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [SearchEvents](https://developer.squareup.com/reference/square_2024-09-19/events-api/search-events) endpoint.\n\nNote: if there are errors processing the request, the events field will not be\npresent.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -54190,7 +54190,7 @@ "loyalty_account_id": { "minLength": 1, "type": "string", - "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-08-21/objects/LoyaltyAccount) to which the loyalty reward belongs." + "description": "The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-09-19/objects/LoyaltyAccount) to which the loyalty reward belongs." }, "status": { "type": "string", @@ -54281,7 +54281,7 @@ "description": "A list of customer IDs to filter by.\n\nMax: 10 customer ids." } }, - "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](https://developer.squareup.com/reference/square_2024-08-21/objects/FulfillmentRecipient) `customer_id`.", + "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](https://developer.squareup.com/reference/square_2024-09-19/objects/FulfillmentRecipient) `customer_id`.", "x-release-status": "BETA", "x-is-beta": true }, @@ -54301,7 +54301,7 @@ "description": "The time range for filtering on the `closed_at` timestamp. If you use this\nvalue, you must set the `sort_field` in the `OrdersSearchSort` object to\n`CLOSED_AT`." } }, - "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2024-08-21/objects/SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", + "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2024-09-19/objects/SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", "x-release-status": "PUBLIC" }, "SearchOrdersFilter": { @@ -54309,7 +54309,7 @@ "properties": { "state_filter": { "$ref": "#/definitions/SearchOrdersStateFilter", - "description": "Filter by [OrderState](https://developer.squareup.com/reference/square_2024-08-21/enums/OrderState)." + "description": "Filter by [OrderState](https://developer.squareup.com/reference/square_2024-09-19/enums/OrderState)." }, "date_time_filter": { "$ref": "#/definitions/SearchOrdersDateTimeFilter", @@ -54341,17 +54341,17 @@ "items": { "type": "string" }, - "description": "A list of [fulfillment types](https://developer.squareup.com/reference/square_2024-08-21/enums/FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field." + "description": "A list of [fulfillment types](https://developer.squareup.com/reference/square_2024-09-19/enums/FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field." }, "fulfillment_states": { "type": "array", "items": { "type": "string" }, - "description": "A list of [fulfillment states](https://developer.squareup.com/reference/square_2024-08-21/enums/FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field." + "description": "A list of [fulfillment states](https://developer.squareup.com/reference/square_2024-09-19/enums/FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field." } }, - "description": "Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2024-08-21/objects/Fulfillment) information.", + "description": "Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2024-09-19/objects/Fulfillment) information.", "x-release-status": "PUBLIC" }, "SearchOrdersQuery": { @@ -54394,7 +54394,7 @@ }, "return_entries": { "type": "boolean", - "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2024-08-21/objects/OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." + "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2024-09-19/objects/OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`." } }, "description": "", @@ -54437,14 +54437,14 @@ "items": { "$ref": "#/definitions/OrderEntry" }, - "description": "A list of [OrderEntries](https://developer.squareup.com/reference/square_2024-08-21/objects/OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." + "description": "A list of [OrderEntries](https://developer.squareup.com/reference/square_2024-09-19/objects/OrderEntry) that fit the query\nconditions. The list is populated only if `return_entries` is set to `true` in the request." }, "orders": { "type": "array", "items": { "$ref": "#/definitions/Order" }, - "description": "A list of\n[Order](https://developer.squareup.com/reference/square_2024-08-21/objects/Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." + "description": "A list of\n[Order](https://developer.squareup.com/reference/square_2024-09-19/objects/Order) objects that match the query conditions. The list is populated only if\n`return_entries` is set to `false` in the request." }, "cursor": { "type": "string", @@ -54455,10 +54455,10 @@ "items": { "$ref": "#/definitions/Error" }, - "description": "[Errors](https://developer.squareup.com/reference/square_2024-08-21/objects/Error) encountered during the search." + "description": "[Errors](https://developer.squareup.com/reference/square_2024-09-19/objects/Error) encountered during the search." } }, - "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](https://developer.squareup.com/reference/square_2024-08-21/orders-api/search-orders).", + "description": "Either the `order_entries` or `orders` field is set, depending on whether\n`return_entries` is set on the [SearchOrdersRequest](https://developer.squareup.com/reference/square_2024-09-19/orders-api/search-orders).", "x-release-status": "PUBLIC", "example": { "order_entries": [ @@ -54487,7 +54487,7 @@ "properties": { "sort_field": { "type": "string", - "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2024-08-21/objects/SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`." + "description": "The field to sort by.\n\n__Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2024-09-19/objects/SearchOrdersFilter),\n`sort_field` must match the timestamp field that the `DateTimeFilter` uses to\nfilter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a\n`DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date.\nIf this field does not match the timestamp field in `DateTimeFilter`,\n`SearchOrders` returns an error.\n\nDefault: `CREATED_AT`." }, "sort_order": { "type": "string", @@ -54505,7 +54505,7 @@ "items": { "type": "string" }, - "description": "Filters by the [Source](https://developer.squareup.com/reference/square_2024-08-21/objects/OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names." + "description": "Filters by the [Source](https://developer.squareup.com/reference/square_2024-09-19/objects/OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names." } }, "description": "A filter based on order `source` information.", @@ -54705,7 +54705,7 @@ "x-is-beta": true } }, - "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/search-subscriptions) endpoint.", + "description": "Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by \nthe [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC" }, "SearchSubscriptionsQuery": { @@ -54745,7 +54745,7 @@ "x-is-beta": true } }, - "description": "Defines input parameters in a request to the \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/search-subscriptions) endpoint.", + "description": "Defines input parameters in a request to the \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -54787,7 +54787,7 @@ "description": "When the total number of resulting subscription exceeds the limit of a paged response, \nthe response includes a cursor for you to use in a subsequent request to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, - "description": "Defines output parameters in a response from the\n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/search-subscriptions) endpoint.", + "description": "Defines output parameters in a response from the\n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/search-subscriptions) endpoint.", "x-release-status": "PUBLIC", "example": { "subscriptions": [ @@ -55397,7 +55397,7 @@ "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } }, - "description": "Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/search-vendors).", + "description": "Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -55429,14 +55429,14 @@ "maxLength": 100, "type": "string" }, - "description": "The names of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects to retrieve." + "description": "The names of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects to retrieve." }, "status": { "type": "array", "items": { "type": "string" }, - "description": "The statuses of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects to retrieve." + "description": "The statuses of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects to retrieve." } }, "description": "Defines supported query expressions to search for vendors by.", @@ -55455,7 +55455,7 @@ "description": "Specifies the sort order for the returned vendors." } }, - "description": "Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/search-vendors).", + "description": "Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true }, @@ -55474,14 +55474,14 @@ "items": { "$ref": "#/definitions/Vendor" }, - "description": "The [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) objects matching the specified search filter." + "description": "The [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) objects matching the specified search filter." }, "cursor": { "type": "string", "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } }, - "description": "Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/search-vendors).", + "description": "Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/search-vendors).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -55526,7 +55526,7 @@ "minLength": 1, "maxLength": 36, "type": "string", - "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogItemVariation) object representing the service booked in this segment." + "description": "The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogItemVariation) object representing the service booked in this segment." }, "team_member_id_filter": { "$ref": "#/definitions/FilterValue", @@ -55962,11 +55962,11 @@ "properties": { "product": { "type": "string", - "description": "__Read only__ The [product](https://developer.squareup.com/reference/square_2024-08-21/enums/Product) type of the application." + "description": "__Read only__ The [product](https://developer.squareup.com/reference/square_2024-09-19/enums/Product) type of the application." }, "application_id": { "type": "string", - "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](https://developer.squareup.com/reference/square_2024-08-21/enums/Product) type is `EXTERNAL_API`." + "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](https://developer.squareup.com/reference/square_2024-09-19/enums/Product) type is `EXTERNAL_API`." }, "name": { "type": "string", @@ -56097,12 +56097,12 @@ }, "plan_variation_id": { "type": "string", - "description": "The ID of the subscribed-to [subscription plan variation](https://developer.squareup.com/reference/square_2024-08-21/objects/CatalogSubscriptionPlanVariation).", + "description": "The ID of the subscribed-to [subscription plan variation](https://developer.squareup.com/reference/square_2024-09-19/objects/CatalogSubscriptionPlanVariation).", "x-read-only": true }, "customer_id": { "type": "string", - "description": "The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) profile.", + "description": "The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) profile.", "x-read-only": true }, "start_date": { @@ -56133,7 +56133,7 @@ "items": { "type": "string" }, - "description": "The IDs of the [invoices](https://developer.squareup.com/reference/square_2024-08-21/objects/Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", + "description": "The IDs of the [invoices](https://developer.squareup.com/reference/square_2024-09-19/objects/Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", "x-read-only": true }, "price_override_money": { @@ -56152,7 +56152,7 @@ }, "card_id": { "type": "string", - "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2024-08-21/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-08-21/objects/Card)\nused to charge for the subscription." + "description": "The ID of the [subscriber\u0027s](https://developer.squareup.com/reference/square_2024-09-19/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-09-19/objects/Card)\nused to charge for the subscription." }, "timezone": { "type": "string", @@ -56170,7 +56170,7 @@ "items": { "$ref": "#/definitions/SubscriptionAction" }, - "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/retrieve-subscription) with the query parameter\nof `include\u003dactions` or from \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/search-subscriptions) with the input parameter \nof `include:[\"actions\"]`.", + "description": "The list of scheduled actions on this subscription. It is set only in the response from \n[RetrieveSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/retrieve-subscription) with the query parameter\nof `include\u003dactions` or from \n[SearchSubscriptions](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/search-subscriptions) with the input parameter \nof `include:[\"actions\"]`.", "x-release-status": "BETA", "x-is-beta": true }, @@ -56406,7 +56406,7 @@ "description": "A list of PhaseInputs, to pass phase-specific information used in the swap." } }, - "description": "Defines input parameters in a call to the\n[SwapPlan](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/swap-plan) endpoint.", + "description": "Defines input parameters in a call to the\n[SwapPlan](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -56443,7 +56443,7 @@ "description": "A list of a `SWAP_PLAN` action created by the request." } }, - "description": "Defines output parameters in a response of the \n[SwapPlan](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/swap-plan) endpoint.", + "description": "Defines output parameters in a response of the \n[SwapPlan](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/swap-plan) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -56601,7 +56601,7 @@ "minLength": 0, "maxLength": 32, "type": "string", - "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-08-21/objects/TeamMember) object for the team member associated with the booking profile.", + "description": "The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-09-19/objects/TeamMember) object for the team member associated with the booking profile.", "x-read-only": true }, "description": { @@ -56698,7 +56698,7 @@ }, "amount_money": { "$ref": "#/definitions/Money", - "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](https://developer.squareup.com/reference/square_2024-08-21/objects/Payment) will be equal to the\n`amount_money` of the tender." + "description": "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`,\nthe `total_money` of the corresponding [Payment](https://developer.squareup.com/reference/square_2024-09-19/objects/Payment) will be equal to the\n`amount_money` of the tender." }, "tip_money": { "$ref": "#/definitions/Money", @@ -56749,7 +56749,7 @@ "payment_id": { "maxLength": 192, "type": "string", - "description": "The ID of the [Payment](https://developer.squareup.com/reference/square_2024-08-21/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." + "description": "The ID of the [Payment](https://developer.squareup.com/reference/square_2024-09-19/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." } }, "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", @@ -56760,10 +56760,10 @@ "properties": { "status": { "type": "string", - "description": "The bank account payment\u0027s current state.\n\nSee [TenderBankAccountPaymentDetailsStatus](https://developer.squareup.com/reference/square_2024-08-21/enums/TenderBankAccountDetailsStatus) for possible values." + "description": "The bank account payment\u0027s current state.\n\nSee [TenderBankAccountPaymentDetailsStatus](https://developer.squareup.com/reference/square_2024-09-19/enums/TenderBankAccountDetailsStatus) for possible values." } }, - "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](https://developer.squareup.com/reference/square_2024-08-21/objects/BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", + "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](https://developer.squareup.com/reference/square_2024-09-19/objects/BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", "x-release-status": "PUBLIC" }, "TenderBuyNowPayLaterDetails": { @@ -56776,7 +56776,7 @@ }, "status": { "type": "string", - "description": "The buy now pay later payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](https://developer.squareup.com/reference/square_2024-08-21/enums/TenderBuyNowPayLaterDetailsStatus)\nfor possible values." + "description": "The buy now pay later payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](https://developer.squareup.com/reference/square_2024-09-19/enums/TenderBuyNowPayLaterDetailsStatus)\nfor possible values." } }, "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", @@ -56787,7 +56787,7 @@ "properties": { "status": { "type": "string", - "description": "The credit card payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2024-08-21/enums/TenderCardDetailsStatus)\nfor possible values." + "description": "The credit card payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2024-09-19/enums/TenderCardDetailsStatus)\nfor possible values." }, "card": { "$ref": "#/definitions/Card", @@ -56821,7 +56821,7 @@ "properties": { "status": { "type": "string", - "description": "The Square Account payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderSquareAccountDetailsStatus](https://developer.squareup.com/reference/square_2024-08-21/enums/TenderSquareAccountDetailsStatus)\nfor possible values." + "description": "The Square Account payment\u0027s current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderSquareAccountDetailsStatus](https://developer.squareup.com/reference/square_2024-09-19/enums/TenderSquareAccountDetailsStatus)\nfor possible values." } }, "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", @@ -57288,10 +57288,10 @@ "properties": { "event_type": { "type": "string", - "description": "The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)." + "description": "The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription). The event type must be\ncontained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)." } }, - "description": "Tests a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) by sending a test event to its notification URL.", + "description": "Tests a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) by sending a test event to its notification URL.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5/test", @@ -57312,10 +57312,10 @@ }, "subscription_test_result": { "$ref": "#/definitions/SubscriptionTestResult", - "description": "The [SubscriptionTestResult](https://developer.squareup.com/reference/square_2024-08-21/objects/SubscriptionTestResult)." + "description": "The [SubscriptionTestResult](https://developer.squareup.com/reference/square_2024-09-19/objects/SubscriptionTestResult)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/test-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](https://developer.squareup.com/reference/square_2024-08-21/objects/SubscriptionTestResult) field is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/test-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [SubscriptionTestResult](https://developer.squareup.com/reference/square_2024-09-19/objects/SubscriptionTestResult) field is not\npresent.", "x-release-status": "PUBLIC", "example": { "subscription_test_result": { @@ -57407,7 +57407,7 @@ "reference_id": { "maxLength": 40, "type": "string", - "description": "If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set." + "description": "If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/charge)\nendpoint, this value is the same as the value provided for the `reference_id`\nparameter in the request to that endpoint. Otherwise, it is not set." }, "product": { "type": "string", @@ -57502,7 +57502,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/update-booking-custom-attribute-definition) request.", + "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/update-booking-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -57532,7 +57532,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/update-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/update-booking-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -57688,7 +57688,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?key\u003dfavoritemovie", @@ -57715,7 +57715,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/update-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/update-customer-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute_definition": { @@ -57743,7 +57743,7 @@ "description": "The `CustomerGroup` object including all the updates you want to make." } }, - "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/update-customer-group) endpoint.", + "description": "Defines the body parameters that can be included in a request to the\n[UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/update-customer-group) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -57768,7 +57768,7 @@ "description": "The successfully updated customer group." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-08-21/customer-groups-api/update-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-09-19/customer-groups-api/update-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "group": { @@ -57866,7 +57866,7 @@ "description": "The updated customer." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomer](https://developer.squareup.com/reference/square_2024-08-21/customers-api/update-customer) or\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-08-21/customers-api/bulk-update-customers) endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateCustomer](https://developer.squareup.com/reference/square_2024-09-19/customers-api/update-customer) or\n[BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-09-19/customers-api/bulk-update-customers) endpoint.\n\nEither `errors` or `customer` is present in a given response (never both).", "x-release-status": "PUBLIC", "example": { "customer": { @@ -58210,7 +58210,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/update-location-custom-attribute-definition) request.", + "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/update-location-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58238,7 +58238,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/update-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/update-location-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58264,7 +58264,7 @@ "description": "The `Location` object with only the fields to update." } }, - "description": "The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2024-08-21/locations-api/update-location) endpoint.", + "description": "The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2024-09-19/locations-api/update-location) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -58308,7 +58308,7 @@ "description": "The updated `Location` object." } }, - "description": "The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2024-08-21/locations-api/update-location) endpoint.", + "description": "The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2024-09-19/locations-api/update-location) endpoint.", "x-release-status": "PUBLIC", "example": { "location": { @@ -58483,7 +58483,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) request.", + "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58511,7 +58511,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58697,7 +58697,7 @@ "description": "A value you specify that uniquely identifies this update request.\n\nIf you are unsure whether a particular update was applied to an order successfully,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate updates to the order.\nThe latest order version is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Defines the fields that are included in requests to the\n[UpdateOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/update-order) endpoint.", + "description": "Defines the fields that are included in requests to the\n[UpdateOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/update-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58738,7 +58738,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](https://developer.squareup.com/reference/square_2024-08-21/orders-api/update-order) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateOrder](https://developer.squareup.com/reference/square_2024-09-19/orders-api/update-order) endpoint.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -58931,7 +58931,7 @@ "description": "A unique string that identifies this `UpdatePayment` request. Keys can be any valid string\nbut must be unique for every `UpdatePayment` request.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Describes a request to update a payment using\n[UpdatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/update-payment).", + "description": "Describes a request to update a payment using\n[UpdatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/update-payment).", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -58965,7 +58965,7 @@ "description": "The updated payment." } }, - "description": "Defines the response returned by\n[UpdatePayment](https://developer.squareup.com/reference/square_2024-08-21/payments-api/update-payment).", + "description": "Defines the response returned by\n[UpdatePayment](https://developer.squareup.com/reference/square_2024-09-19/payments-api/update-payment).", "x-release-status": "PUBLIC", "example": { "payment": { @@ -59150,7 +59150,7 @@ "description": "The subscription object containing the current version, and fields to update.\nUnset fields will be left at their current server values, and JSON `null` values will\nbe treated as a request to clear the relevant data." } }, - "description": "Defines input parameters in a request to the \n[UpdateSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/update-subscription) endpoint.", + "description": "Defines input parameters in a request to the \n[UpdateSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/update-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "request_body": { @@ -59176,7 +59176,7 @@ "description": "The updated subscription." } }, - "description": "Defines output parameters in a response from the\n[UpdateSubscription](https://developer.squareup.com/reference/square_2024-08-21/subscriptions-api/update-subscription) endpoint.", + "description": "Defines output parameters in a response from the\n[UpdateSubscription](https://developer.squareup.com/reference/square_2024-09-19/subscriptions-api/update-subscription) endpoint.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -59283,10 +59283,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The specified [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) to be updated." + "description": "The specified [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) to be updated." } }, - "description": "Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/update-vendor).", + "description": "Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/update-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59313,10 +59313,10 @@ }, "vendor": { "$ref": "#/definitions/Vendor", - "description": "The [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) that has been updated." + "description": "The [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) that has been updated." } }, - "description": "Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-08-21/vendors-api/update-vendor).", + "description": "Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-09-19/vendors-api/update-vendor).", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59444,10 +59444,10 @@ "properties": { "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) to update." + "description": "The [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) to update." } }, - "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription).", + "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription).", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5", @@ -59471,10 +59471,10 @@ }, "subscription": { "$ref": "#/definitions/WebhookSubscription", - "description": "The updated [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription)." + "description": "The updated [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription)." } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/update-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/update-webhook-subscription) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) is not\npresent.", "x-release-status": "PUBLIC", "example": { "subscription": { @@ -59498,10 +59498,10 @@ "idempotency_key": { "maxLength": 45, "type": "string", - "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request." + "description": "A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request." } }, - "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) by replacing the existing signature key with a new one.", + "description": "Updates a [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) by replacing the existing signature key with a new one.", "x-release-status": "PUBLIC", "example": { "request_url": "/v2/webhooks/subscriptions/wbhk_b35f6b3145074cf9ad513610786c19d5/signature-key", @@ -59526,7 +59526,7 @@ "x-read-only": true } }, - "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-08-21/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-08-21/objects/WebhookSubscription) is not\npresent.", + "description": "Defines the fields that are included in the response body of\na request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-09-19/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint.\n\nNote: If there are errors processing the request, the [Subscription](https://developer.squareup.com/reference/square_2024-09-19/objects/WebhookSubscription) is not\npresent.", "x-release-status": "PUBLIC", "example": { "signature_key": "1k9bIJKCeTmSQwyagtNRLg" @@ -59599,7 +59599,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/upsert-booking-custom-attribute) request.", + "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/upsert-booking-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "pathParameters": { @@ -59628,7 +59628,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/booking-custom-attributes-api/upsert-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/booking-custom-attributes-api/upsert-booking-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -59825,7 +59825,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/upsert-customer-custom-attribute) request.", + "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/upsert-customer-custom-attribute) request.", "x-release-status": "PUBLIC", "example": { "request_params": "?customer_id\u003dZ57QXKM2FGXEQDV42W8RBZY7BR\u0026key\u003dfavoritemovie", @@ -59851,7 +59851,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/customer-custom-attributes-api/upsert-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/customer-custom-attributes-api/upsert-customer-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "PUBLIC", "example": { "custom_attribute": { @@ -59880,7 +59880,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/upsert-location-custom-attribute) request.", + "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/upsert-location-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59907,7 +59907,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/location-custom-attributes-api/upsert-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/location-custom-attributes-api/upsert-location-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59937,7 +59937,7 @@ "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." } }, - "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/upsert-merchant-custom-attribute) request.", + "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/upsert-merchant-custom-attribute) request.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -59964,7 +59964,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-08-21/merchant-custom-attributes-api/upsert-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", + "description": "Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-09-19/merchant-custom-attributes-api/upsert-merchant-custom-attribute) response.\nEither `custom_attribute_definition` or `errors` is present in the response.", "x-release-status": "BETA", "x-is-beta": true, "example": { @@ -60424,49 +60424,49 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor).\nThis field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor).\nThis field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "created_at": { "maxLength": 34, "type": "string", - "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) was created.", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) was created.", "x-read-only": true }, "updated_at": { "maxLength": 34, "type": "string", - "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor) was last updated.", + "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor) was last updated.", "x-read-only": true }, "name": { "maxLength": 100, "type": "string", - "description": "The name of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor).\nThis field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "The name of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor).\nThis field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "address": { "$ref": "#/definitions/Address", - "description": "The address of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "The address of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/VendorContact" }, - "description": "The contacts of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "The contacts of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "account_number": { "maxLength": 100, "type": "string", - "description": "The account number of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "The account number of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "note": { "maxLength": 4096, "type": "string", - "description": "A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "version": { "type": "integer", - "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "The version of the [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "status": { "$ref": "#/definitions/VendorStatus", @@ -60486,33 +60486,33 @@ "id": { "maxLength": 100, "type": "string", - "description": "A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact).\nThis field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact)." + "description": "A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact).\nThis field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact)." }, "name": { "maxLength": 255, "type": "string", - "description": "The name of the [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact).\nThis field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor)." + "description": "The name of the [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact).\nThis field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor)." }, "email_address": { "maxLength": 255, "type": "string", - "description": "The email address of the [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact)." + "description": "The email address of the [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact)." }, "phone_number": { "maxLength": 255, "type": "string", - "description": "The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact)." + "description": "The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact)." }, "removed": { "type": "boolean", - "description": "The state of the [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact)." + "description": "The state of the [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact)." }, "ordinal": { "type": "integer", - "description": "The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2024-08-21/objects/VendorContact)." + "description": "The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2024-09-19/objects/VendorContact)." } }, - "description": "Represents a contact of a [Vendor](https://developer.squareup.com/reference/square_2024-08-21/objects/Vendor).", + "description": "Represents a contact of a [Vendor](https://developer.squareup.com/reference/square_2024-09-19/objects/Vendor).", "x-release-status": "BETA", "x-is-beta": true }, @@ -60543,7 +60543,7 @@ "description": "Any errors that occurred during the request." } }, - "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](https://developer.squareup.com/reference/square_2024-08-21/transactions-api/void-transaction) endpoint.", + "description": "Defines the fields that are included in the response body of\na request to the [VoidTransaction](https://developer.squareup.com/reference/square_2024-09-19/transactions-api/void-transaction) endpoint.", "x-release-status": "DEPRECATED", "x-is-deprecated": true, "example": {}, From c59001cccc3897e8f143f0955843f2737447df5b Mon Sep 17 00:00:00 2001 From: Jon Lund Date: Wed, 23 Oct 2024 13:44:18 -0600 Subject: [PATCH 19/19] syntax correction --- api.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api.json b/api.json index 5a138fc..04e3fbf 100644 --- a/api.json +++ b/api.json @@ -36164,11 +36164,11 @@ "description": "Details about a card refund. Only populated if the destination_type is `CARD`." }, "cash_details": { - "$ref": "#/definitions/CashRefundDetails", + "$ref": "#/definitions/DestinationDetailsCashRefundDetails", "description": "Details about a cash refund. Only populated if the destination_type is `CASH`." }, "external_details": { - "$ref": "#/definitions/ExternalRefundDetails", + "$ref": "#/definitions/DestinationDetailsExternalRefundDetails", "description": "Details about an external refund. Only populated if the destination_type is `EXTERNAL`." } },