Generated PR for Release: 21.0.0.20220720

Author: autobot

Diff for: doc/api/bookings.md

@@ -184,7 +184,7 @@ def list_team_member_booking_profiles(bookable_only: false,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `bookable_only` | `Boolean` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).<br>**Default**: `false` |
+| `bookable_only` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).<br>**Default**: `false` |
 | `limit` | `Integer` | Query, Optional | The maximum number of results to return in a paged response. |
 | `cursor` | `String` | Query, Optional | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. |
 | `location_id` | `String` | Query, Optional | Indicates whether to include only team members enabled at the given location in the returned result. |

Diff for: doc/api/cards.md

@@ -35,7 +35,7 @@ def list_cards(cursor: nil,
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for your original query.<br><br>See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. |
 | `customer_id` | `String` | Query, Optional | Limit results to cards associated with the customer supplied.<br>By default, all cards owned by the merchant are returned. |
-| `include_disabled` | `Boolean` | Query, Optional | Includes disabled cards.<br>By default, all enabled cards owned by the merchant are returned.<br>**Default**: `false` |
+| `include_disabled` | `TrueClass\|FalseClass` | Query, Optional | Includes disabled cards.<br>By default, all enabled cards owned by the merchant are returned.<br>**Default**: `false` |
 | `reference_id` | `String` | Query, Optional | Limit results to cards associated with the reference_id supplied. |
 | `sort_order` | [`String (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the card was created with the specified order.<br>This field defaults to ASC. |
 

Diff for: doc/api/catalog.md

@@ -153,7 +153,6 @@ body[:batches][0][:objects][0][:id] = '#Tea'
 body[:batches][0][:objects][0][:present_at_all_locations] = true
 body[:batches][0][:objects][0][:item_data] = {}
 body[:batches][0][:objects][0][:item_data][:name] = 'Tea'
-body[:batches][0][:objects][0][:item_data][:description] = 'Hot Leaf Juice'
 body[:batches][0][:objects][0][:item_data][:category_id] = '#Beverages'
 body[:batches][0][:objects][0][:item_data][:tax_ids] = ['#SalesTax']
 body[:batches][0][:objects][0][:item_data][:variations] = []
@@ -168,14 +167,14 @@ body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data]
 body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data][:name] = 'Mug'
 body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data][:pricing_type] = 'FIXED_PRICING'
 
+body[:batches][0][:objects][0][:item_data][:description_html] = '<p><strong>Hot</strong> Leaf Juice</p>'
 
 body[:batches][0][:objects][1] = {}
 body[:batches][0][:objects][1][:type] = 'ITEM'
 body[:batches][0][:objects][1][:id] = '#Coffee'
 body[:batches][0][:objects][1][:present_at_all_locations] = true
 body[:batches][0][:objects][1][:item_data] = {}
 body[:batches][0][:objects][1][:item_data][:name] = 'Coffee'
-body[:batches][0][:objects][1][:item_data][:description] = 'Hot Bean Juice'
 body[:batches][0][:objects][1][:item_data][:category_id] = '#Beverages'
 body[:batches][0][:objects][1][:item_data][:tax_ids] = ['#SalesTax']
 body[:batches][0][:objects][1][:item_data][:variations] = []
@@ -199,6 +198,7 @@ body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data]
 body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data][:name] = 'Large'
 body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data][:pricing_type] = 'FIXED_PRICING'
 
+body[:batches][0][:objects][1][:item_data][:description_html] = '<p>Hot <em>Bean Juice</em></p>'
 
 body[:batches][0][:objects][2] = {}
 body[:batches][0][:objects][2][:type] = 'CATEGORY'
@@ -249,7 +249,7 @@ def create_catalog_image(request: nil,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `request` | [`Create Catalog Image Request Hash`](../../doc/models/create-catalog-image-request.md) | Form, Optional | - |
+| `request` | [`Create Catalog Image Request Hash`](../../doc/models/create-catalog-image-request.md) | Form (JSON-Encoded), Optional | - |
 | `image_file` | `File \| UploadIO` | Form, Optional | - |
 
 ## Response Type
@@ -296,7 +296,7 @@ def update_catalog_image(image_id:,
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `image_id` | `String` | Template, Required | The ID of the `CatalogImage` object to update the encapsulated image file. |
-| `request` | [`Update Catalog Image Request Hash`](../../doc/models/update-catalog-image-request.md) | Form, Optional | - |
+| `request` | [`Update Catalog Image Request Hash`](../../doc/models/update-catalog-image-request.md) | Form (JSON-Encoded), Optional | - |
 | `image_file` | `File \| UploadIO` | Form, Optional | - |
 
 ## Response Type
@@ -369,7 +369,7 @@ def list_catalog(cursor: nil,
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | The pagination cursor returned in the previous response. Leave unset for an initial request.<br>The page size is currently set to be 100.<br>See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. |
 | `types` | `String` | Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve.<br><br>The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) enum, for example,<br>`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,<br>`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.<br><br>If this is unspecified, the operation returns objects of all the top level types at the version<br>of the Square API used to make the request. Object types that are nested onto other object types<br>are not included in the defaults.<br><br>At the current API version the default object types are:<br>ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,<br>PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,<br>SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. |
-| `catalog_version` | `Long` | Query, Optional | The specific version of the catalog objects to be included in the response.<br>This allows you to retrieve historical<br>versions of objects. The specified version value is matched against<br>the [CatalogObject](../../doc/models/catalog-object.md)s' `version` attribute.  If not included, results will<br>be from the current version of the catalog. |
+| `catalog_version` | `Integer` | Query, Optional | The specific version of the catalog objects to be included in the response.<br>This allows you to retrieve historical<br>versions of objects. The specified version value is matched against<br>the [CatalogObject](../../doc/models/catalog-object.md)s' `version` attribute.  If not included, results will<br>be from the current version of the catalog. |
 
 ## Response Type
 
@@ -416,7 +416,6 @@ body[:object][:type] = 'ITEM'
 body[:object][:id] = '#Cocoa'
 body[:object][:item_data] = {}
 body[:object][:item_data][:name] = 'Cocoa'
-body[:object][:item_data][:description] = 'Hot Chocolate'
 body[:object][:item_data][:abbreviation] = 'Ch'
 body[:object][:item_data][:variations] = []
 
@@ -440,6 +439,7 @@ body[:object][:item_data][:variations][1][:item_variation_data][:price_money] =
 body[:object][:item_data][:variations][1][:item_variation_data][:price_money][:amount] = 400
 body[:object][:item_data][:variations][1][:item_variation_data][:price_money][:currency] = 'USD'
 
+body[:object][:item_data][:description_html] = '<p><strong>Hot</strong> Chocolate</p>'
 
 result = catalog_api.upsert_catalog_object(body: body)
 
@@ -510,8 +510,8 @@ def retrieve_catalog_object(object_id:,
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `object_id` | `String` | Template, Required | The object ID of any type of catalog objects to be retrieved. |
-| `include_related_objects` | `Boolean` | Query, Optional | If `true`, the response will include additional objects that are related to the<br>requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field<br>of the response. These objects are put in the `related_objects` field. Setting this to `true` is<br>helpful when the objects are needed for immediate display to a user.<br>This process only goes one level deep. Objects referenced by the related objects will not be included. For example,<br><br>if the `objects` field of the response contains a CatalogItem, its associated<br>CatalogCategory objects, CatalogTax objects, CatalogImage objects and<br>CatalogModifierLists will be returned in the `related_objects` field of the<br>response. If the `objects` field of the response contains a CatalogItemVariation,<br>its parent CatalogItem will be returned in the `related_objects` field of<br>the response.<br><br>Default value: `false`<br>**Default**: `false` |
-| `catalog_version` | `Long` | Query, Optional | Requests objects as of a specific version of the catalog. This allows you to retrieve historical<br>versions of objects. The value to retrieve a specific version of an object can be found<br>in the version field of [CatalogObject](../../doc/models/catalog-object.md)s. If not included, results will<br>be from the current version of the catalog. |
+| `include_related_objects` | `TrueClass\|FalseClass` | Query, Optional | If `true`, the response will include additional objects that are related to the<br>requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field<br>of the response. These objects are put in the `related_objects` field. Setting this to `true` is<br>helpful when the objects are needed for immediate display to a user.<br>This process only goes one level deep. Objects referenced by the related objects will not be included. For example,<br><br>if the `objects` field of the response contains a CatalogItem, its associated<br>CatalogCategory objects, CatalogTax objects, CatalogImage objects and<br>CatalogModifierLists will be returned in the `related_objects` field of the<br>response. If the `objects` field of the response contains a CatalogItemVariation,<br>its parent CatalogItem will be returned in the `related_objects` field of<br>the response.<br><br>Default value: `false`<br>**Default**: `false` |
+| `catalog_version` | `Integer` | Query, Optional | Requests objects as of a specific version of the catalog. This allows you to retrieve historical<br>versions of objects. The value to retrieve a specific version of an object can be found<br>in the version field of [CatalogObject](../../doc/models/catalog-object.md)s. If not included, results will<br>be from the current version of the catalog. |
 
 ## Response Type
 

Diff for: doc/api/customer-custom-attributes.md

@@ -301,7 +301,7 @@ def list_customer_custom_attributes(customer_id:,
 | `customer_id` | `String` | Template, Required | The ID of the target [customer profile](../../doc/models/customer.md). |
 | `limit` | `Integer` | 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). |
-| `with_definitions` | `Boolean` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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` |
+| `with_definitions` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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
 
@@ -385,7 +385,7 @@ def retrieve_customer_custom_attribute(customer_id:,
 |  --- | --- | --- | --- |
 | `customer_id` | `String` | Template, Required | The ID of the target [customer profile](../../doc/models/customer.md). |
 | `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. |
-| `with_definition` | `Boolean` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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` |
+| `with_definition` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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` | `Integer` | 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

Diff for: doc/api/customers.md

@@ -155,8 +155,8 @@ body[:query][:filter][:creation_source] = {}
 body[:query][:filter][:creation_source][:values] = ['THIRD_PARTY']
 body[:query][:filter][:creation_source][:rule] = 'INCLUDE'
 body[:query][:filter][:created_at] = {}
-body[:query][:filter][:created_at][:start_at] = '2018-01-01T00:00:00-00:00'
-body[:query][:filter][:created_at][:end_at] = '2018-02-01T00:00:00-00:00'
+body[:query][:filter][:created_at][:start_at] = '2018-01-01T00:00:00+00:00'
+body[:query][:filter][:created_at][:end_at] = '2018-02-01T00:00:00+00:00'
 body[:query][:filter][:email_address] = {}
 body[:query][:filter][:email_address][:fuzzy] = 'example.com'
 body[:query][:filter][:group_ids] = {}
@@ -193,7 +193,7 @@ def delete_customer(customer_id:,
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `customer_id` | `String` | Template, Required | The ID of the customer to delete. |
-| `version` | `Long` | Query, Optional | The current version of the customer profile.<br><br>As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.  For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). |
+| `version` | `Integer` | Query, Optional | The current version of the customer profile.<br><br>As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.  For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). |
 
 ## Response Type
 

Diff for: doc/api/disputes.md

@@ -177,7 +177,7 @@ def create_dispute_evidence_file(dispute_id:,
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `dispute_id` | `String` | Template, Required | The ID of the dispute you want to upload evidence for. |
-| `request` | [`Create Dispute Evidence File Request Hash`](../../doc/models/create-dispute-evidence-file-request.md) | Form, Optional | Defines the parameters for a `CreateDisputeEvidenceFile` request. |
+| `request` | [`Create Dispute Evidence File Request Hash`](../../doc/models/create-dispute-evidence-file-request.md) | Form (JSON-Encoded), Optional | Defines the parameters for a `CreateDisputeEvidenceFile` request. |
 | `image_file` | `File \| UploadIO` | Form, Optional | - |
 
 ## Response Type

Diff for: doc/api/inventory.md

@@ -176,8 +176,8 @@ body[:catalog_object_ids] = ['W62UWFY35CWMYGVWK6TWJDNI']
 body[:location_ids] = ['C6W5YS5QM06F5']
 body[:types] = ['PHYSICAL_COUNT']
 body[:states] = ['IN_STOCK']
-body[:updated_after] = '2016-11-01T00:00:00.000Z'
-body[:updated_before] = '2016-12-01T00:00:00.000Z'
+body[:updated_after] = '2016-11-01T00:00:00Z'
+body[:updated_before] = '2016-12-01T00:00:00Z'
 
 result = inventory_api.deprecated_batch_retrieve_inventory_changes(body: body)
 
@@ -216,7 +216,7 @@ def deprecated_batch_retrieve_inventory_counts(body:)
 body = {}
 body[:catalog_object_ids] = ['W62UWFY35CWMYGVWK6TWJDNI']
 body[:location_ids] = ['59TNP9SA8VGDA']
-body[:updated_after] = '2016-11-16T00:00:00.000Z'
+body[:updated_after] = '2016-11-16T00:00:00Z'
 
 result = inventory_api.deprecated_batch_retrieve_inventory_counts(body: body)
 
@@ -314,8 +314,8 @@ body[:catalog_object_ids] = ['W62UWFY35CWMYGVWK6TWJDNI']
 body[:location_ids] = ['C6W5YS5QM06F5']
 body[:types] = ['PHYSICAL_COUNT']
 body[:states] = ['IN_STOCK']
-body[:updated_after] = '2016-11-01T00:00:00.000Z'
-body[:updated_before] = '2016-12-01T00:00:00.000Z'
+body[:updated_after] = '2016-11-01T00:00:00Z'
+body[:updated_before] = '2016-12-01T00:00:00Z'
 
 result = inventory_api.batch_retrieve_inventory_changes(body: body)
 
@@ -361,7 +361,7 @@ def batch_retrieve_inventory_counts(body:)
 body = {}
 body[:catalog_object_ids] = ['W62UWFY35CWMYGVWK6TWJDNI']
 body[:location_ids] = ['59TNP9SA8VGDA']
-body[:updated_after] = '2016-11-16T00:00:00.000Z'
+body[:updated_after] = '2016-11-16T00:00:00Z'
 
 result = inventory_api.batch_retrieve_inventory_counts(body: body)