Generated PR for Release: 30.0.0.20230816

Author: autobot

README.md

@@ -82,6 +82,7 @@ pytest
 
 ### Orders
 * [Orders]
+* [Order Custom Attributes]
 
 ### Subscriptions
 * [Subscriptions]
@@ -107,10 +108,13 @@ pytest
 
 ### Bookings
 * [Bookings]
+* [Booking Custom Attributes]
 
 ### Business
 * [Merchants]
+* [Merchant Custom Attributes]
 * [Locations]
+* [Location Custom Attributes]
 * [Devices]
 * [Cash Drawers]
 
@@ -162,9 +166,13 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [Labor]: doc/api/labor.md
 [Loyalty]: doc/api/loyalty.md
 [Bookings]: doc/api/bookings.md
+[Booking Custom Attributes]: doc/api/booking-custom-attributes.md
 [Locations]: doc/api/locations.md
+[Location Custom Attributes]: doc/api/location-custom-attributes.md
 [Merchants]: doc/api/merchants.md
+[Merchant Custom Attributes]: doc/api/merchant-custom-attributes.md
 [Orders]: doc/api/orders.md
+[Order Custom Attributes]: doc/api/order-custom-attributes.md
 [Invoices]: doc/api/invoices.md
 [Apple Pay]: doc/api/apple-pay.md
 [Refunds]: doc/api/refunds.md

doc/api/apple-pay.md

@@ -36,7 +36,7 @@ def register_domain(self,
 
 ## Response Type
 
-[`Register Domain Response`](../../doc/models/register-domain-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Register Domain Response`](../../doc/models/register-domain-response.md).
 
 ## Example Usage
 

doc/api/bank-accounts.md

@@ -30,13 +30,13 @@ def list_bank_accounts(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `cursor` | `string` | Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set<br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
+| `cursor` | `str` | Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set<br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
 | `limit` | `int` | Query, Optional | Upper limit on the number of bank accounts to return in the response.<br>Currently, 1000 is the largest supported limit. You can specify a limit<br>of up to 1000 bank accounts. This is also the default limit. |
-| `location_id` | `string` | Query, Optional | Location ID. You can specify this optional filter<br>to retrieve only the linked bank accounts belonging to a specific location. |
+| `location_id` | `str` | Query, Optional | Location ID. You can specify this optional filter<br>to retrieve only the linked bank accounts belonging to a specific location. |
 
 ## Response Type
 
-[`List Bank Accounts Response`](../../doc/models/list-bank-accounts-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`List Bank Accounts Response`](../../doc/models/list-bank-accounts-response.md).
 
 ## Example Usage
 
@@ -64,11 +64,11 @@ def get_bank_account_by_v1_id(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `v1_bank_account_id` | `string` | Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see<br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
+| `v1_bank_account_id` | `str` | Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see<br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
 
 ## Response Type
 
-[`Get Bank Account by V1 Id Response`](../../doc/models/get-bank-account-by-v1-id-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Get Bank Account by V1 Id Response`](../../doc/models/get-bank-account-by-v1-id-response.md).
 
 ## Example Usage
 
@@ -99,11 +99,11 @@ def get_bank_account(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `bank_account_id` | `string` | Template, Required | Square-issued ID of the desired `BankAccount`. |
+| `bank_account_id` | `str` | Template, Required | Square-issued ID of the desired `BankAccount`. |
 
 ## Response Type
 
-[`Get Bank Account Response`](../../doc/models/get-bank-account-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Get Bank Account Response`](../../doc/models/get-bank-account-response.md).
 
 ## Example Usage
 

doc/api/booking-custom-attributes.md

@@ -41,11 +41,11 @@ def list_booking_custom_attribute_definitions(self,
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.<br>The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.<br>The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
-| `cursor` | `string` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.<br>Provide this cursor to retrieve the next page of results for your original request.<br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
+| `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.<br>Provide this cursor to retrieve the next page of results for your original request.<br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 
 ## Response Type
 
-[`List Booking Custom Attribute Definitions Response`](../../doc/models/list-booking-custom-attribute-definitions-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`List Booking Custom Attribute Definitions Response`](../../doc/models/list-booking-custom-attribute-definitions-response.md).
 
 ## Example Usage
 
@@ -83,7 +83,7 @@ def create_booking_custom_attribute_definition(self,
 
 ## Response Type
 
-[`Create Booking Custom Attribute Definition Response`](../../doc/models/create-booking-custom-attribute-definition-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Create Booking Custom Attribute Definition Response`](../../doc/models/create-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -121,11 +121,11 @@ def delete_booking_custom_attribute_definition(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `key` | `string` | Template, Required | The key of the custom attribute definition to delete. |
+| `key` | `str` | Template, Required | The key of the custom attribute definition to delete. |
 
 ## Response Type
 
-[`Delete Booking Custom Attribute Definition Response`](../../doc/models/delete-booking-custom-attribute-definition-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Delete Booking Custom Attribute Definition Response`](../../doc/models/delete-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -159,12 +159,12 @@ def retrieve_booking_custom_attribute_definition(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `key` | `string` | Template, Required | The key of the custom attribute definition to retrieve. If the requesting application<br>is not the definition owner, you must use the qualified key. |
+| `key` | `str` | Template, Required | The key of the custom attribute definition to retrieve. If the requesting application<br>is not the definition owner, you must use the qualified key. |
 | `version` | `int` | Query, Optional | The current version of the custom attribute definition, which is used for strongly consistent<br>reads to guarantee that you receive the most up-to-date data. When included in the request,<br>Square returns the specified version or a higher version if one exists. If the specified version<br>is higher than the current version, Square returns a `BAD_REQUEST` error. |
 
 ## Response Type
 
-[`Retrieve Booking Custom Attribute Definition Response`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Definition Response`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -201,12 +201,12 @@ def update_booking_custom_attribute_definition(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `key` | `string` | Template, Required | The key of the custom attribute definition to update. |
+| `key` | `str` | Template, Required | The key of the custom attribute definition to update. |
 | `body` | [`Update Booking Custom Attribute Definition Request`](../../doc/models/update-booking-custom-attribute-definition-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
 
 ## Response Type
 
-[`Update Booking Custom Attribute Definition Response`](../../doc/models/update-booking-custom-attribute-definition-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Update Booking Custom Attribute Definition Response`](../../doc/models/update-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -253,18 +253,18 @@ def bulk_delete_booking_custom_attributes(self,
 
 ## Response Type
 
-[`Bulk Delete Booking Custom Attributes Response`](../../doc/models/bulk-delete-booking-custom-attributes-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Bulk Delete Booking Custom Attributes Response`](../../doc/models/bulk-delete-booking-custom-attributes-response.md).
 
 ## Example Usage
 
 ```python
 body = {
     'values': {
-        "key0": {
+        'key0': {
             'booking_id': 'booking_id8',
             'key': 'key4'
         },
-        "key1": {
+        'key1': {
             'booking_id': 'booking_id9',
             'key': 'key5'
         }
@@ -304,18 +304,18 @@ def bulk_upsert_booking_custom_attributes(self,
 
 ## Response Type
 
-[`Bulk Upsert Booking Custom Attributes Response`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Bulk Upsert Booking Custom Attributes Response`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md).
 
 ## Example Usage
 
 ```python
 body = {
     'values': {
-        "key0": {
+        'key0': {
             'booking_id': 'booking_id8',
             'custom_attribute': {}
         },
-        "key1": {
+        'key1': {
             'booking_id': 'booking_id9',
             'custom_attribute': {}
         }
@@ -351,14 +351,14 @@ def list_booking_custom_attributes(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `string` | Template, Required | The ID of the target [booking](entity:Booking). |
+| `booking_id` | `str` | Template, Required | The ID of the target [booking](entity:Booking). |
 | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.<br>The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.<br>The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
-| `cursor` | `string` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.<br>Provide this cursor to retrieve the next page of results for your original request. For more<br>information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
+| `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.<br>Provide this cursor to retrieve the next page of results for your original request. For more<br>information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each<br>custom attribute. Set this parameter to `true` to get the name and description of each custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `False` |
 
 ## Response Type
 
-[`List Booking Custom Attributes Response`](../../doc/models/list-booking-custom-attributes-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`List Booking Custom Attributes Response`](../../doc/models/list-booking-custom-attributes-response.md).
 
 ## Example Usage
 
@@ -400,12 +400,12 @@ def delete_booking_custom_attribute(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `string` | Template, Required | The ID of the target [booking](entity:Booking). |
-| `key` | `string` | Template, Required | The key of the custom attribute to delete. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
+| `booking_id` | `str` | Template, Required | The ID of the target [booking](entity:Booking). |
+| `key` | `str` | Template, Required | The key of the custom attribute to delete. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
 
 ## Response Type
 
-[`Delete Booking Custom Attribute Response`](../../doc/models/delete-booking-custom-attribute-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Delete Booking Custom Attribute Response`](../../doc/models/delete-booking-custom-attribute-response.md).
 
 ## Example Usage
 
@@ -446,14 +446,14 @@ def retrieve_booking_custom_attribute(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `string` | Template, Required | The ID of the target [booking](entity:Booking). |
-| `key` | `string` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
+| `booking_id` | `str` | Template, Required | The ID of the target [booking](entity:Booking). |
+| `key` | `str` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
 | `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of<br>the custom attribute. Set this parameter to `true` to get the name and description of the custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `False` |
 | `version` | `int` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to<br>guarantee that you receive the most up-to-date data. When included in the request, Square<br>returns the specified version or a higher version if one exists. If the specified version is<br>higher than the current version, Square returns a `BAD_REQUEST` error. |
 
 ## Response Type
 
-[`Retrieve Booking Custom Attribute Response`](../../doc/models/retrieve-booking-custom-attribute-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Response`](../../doc/models/retrieve-booking-custom-attribute-response.md).
 
 ## Example Usage
 
@@ -499,13 +499,13 @@ def upsert_booking_custom_attribute(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `string` | Template, Required | The ID of the target [booking](entity:Booking). |
-| `key` | `string` | Template, Required | The key of the custom attribute to create or update. This key must match the `key` of a<br>custom attribute definition in the Square seller account. If the requesting application is not<br>the definition owner, you must use the qualified key. |
+| `booking_id` | `str` | Template, Required | The ID of the target [booking](entity:Booking). |
+| `key` | `str` | Template, Required | The key of the custom attribute to create or update. This key must match the `key` of a<br>custom attribute definition in the Square seller account. If the requesting application is not<br>the definition owner, you must use the qualified key. |
 | `body` | [`Upsert Booking Custom Attribute Request`](../../doc/models/upsert-booking-custom-attribute-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
 
 ## Response Type
 
-[`Upsert Booking Custom Attribute Response`](../../doc/models/upsert-booking-custom-attribute-response.md)
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Upsert Booking Custom Attribute Response`](../../doc/models/upsert-booking-custom-attribute-response.md).
 
 ## Example Usage