square_connect 2.1.1.106 → 2.2.0.110

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bb1e68687abe1be0510709f4b331c13e53b9248
-  data.tar.gz: da99adcd07f8124ad0f31fcfb3b92a71ebc7acb4
+  metadata.gz: 140134240931adbda11d86b180088dac5ee6311b
+  data.tar.gz: 5e5b72bd452c1db6d42186491c6a7e3baae2a3ab
 SHA512:
-  metadata.gz: a92e8fc80a3154f1cedde275ede340b0c6cf4aa12e11b2fabd5f35d7c23b3f7bcace37a64779afd3a28e1c862c9e4cbd24a96d86f217343d07b366892d14e14e
-  data.tar.gz: c820dbff99c8bdfc25c1159aa7f102ebab0d406b744671bb365edffafddf2f8bf661231c57b49dd403361bdee24f39fe52dce7b268adee7c1e6759186277e83a
+  metadata.gz: fa5a49a639d4e459a1c41f5821f7eed72fba37e7f67d39a125a6e68d9da661480ead976bd10685354c0335890052a07adf24970d837be1145f34d7ff4fd53a6a
+  data.tar.gz: 44ac429748a38aa469937c9eb48800af4ac25202ceb2eeb8b784ff5abe1a03bef4f3d5a6b11ea9351478065a7ff330142c9990d379b22b390196961872bf546e

data/README.md

@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 2.1.1
+- Package version: 2.2.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -228,8 +228,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md)
  - [SquareConnect::CreateCustomerRequest](docs/CreateCustomerRequest.md)
  - [SquareConnect::CreateCustomerResponse](docs/CreateCustomerResponse.md)
+ - [SquareConnect::CreateOrderRequest](docs/CreateOrderRequest.md)
+ - [SquareConnect::CreateOrderRequestDiscount](docs/CreateOrderRequestDiscount.md)
  - [SquareConnect::CreateOrderRequestLineItem](docs/CreateOrderRequestLineItem.md)
- - [SquareConnect::CreateOrderRequestOrder](docs/CreateOrderRequestOrder.md)
+ - [SquareConnect::CreateOrderRequestTax](docs/CreateOrderRequestTax.md)
  - [SquareConnect::CreateRefundRequest](docs/CreateRefundRequest.md)
  - [SquareConnect::CreateRefundResponse](docs/CreateRefundResponse.md)
  - [SquareConnect::Currency](docs/Currency.md)
@@ -263,6 +265,11 @@ Class | Method | HTTP request | Description
  - [SquareConnect::Money](docs/Money.md)
  - [SquareConnect::Order](docs/Order.md)
  - [SquareConnect::OrderLineItem](docs/OrderLineItem.md)
+ - [SquareConnect::OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
+ - [SquareConnect::OrderLineItemDiscountScope](docs/OrderLineItemDiscountScope.md)
+ - [SquareConnect::OrderLineItemDiscountType](docs/OrderLineItemDiscountType.md)
+ - [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
+ - [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
  - [SquareConnect::Refund](docs/Refund.md)
  - [SquareConnect::RefundStatus](docs/RefundStatus.md)
  - [SquareConnect::RetrieveCatalogObjectRequest](docs/RetrieveCatalogObjectRequest.md)
@@ -352,8 +359,8 @@ Class | Method | HTTP request | Description
   - BANK_ACCOUNTS_READ: GET endpoints related to a merchant's bank accounts
   - ITEMS_READ: GET endpoints related to a merchant's item library
   - ITEMS_WRITE: POST, PUT, and DELETE endpoints related to a merchant's item library
-  - ORDERS_READ: GET endpoints related to a merchant's Square online store.
-  - ORDERS_WRITE: POST, PUT, and DELETE endpoints related to a merchant's Square online store
+  - ORDERS_READ: GET endpoints related to a merchant's orders
+  - ORDERS_WRITE: POST, PUT, and DELETE endpoints related to a merchant's orders
   - EMPLOYEES_READ: GET endpoints related to employee management
   - EMPLOYEES_WRITE: POST, PUT, and DELETE endpoints related to employee management
   - TIMECARDS_READ: GET endpoints related to employee timecards

data/docs/Card.md

@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 **exp_year** | **Integer** | The four-digit year of the card's expiration date. | [optional] 
 **cardholder_name** | **String** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional] 
 **billing_address** | [**Address**](Address.md) | The card's billing address. This value is present only if this object represents a customer's card on file. | [optional] 
+**fingerprint** | **String** | The unique string fingerprint for the card.  The fingerprint is based on the credit card number and is unique to the merchant.  If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional] 
 
 

data/docs/CatalogApi.md

@@ -74,7 +74,7 @@ Name | Type | Description  | Notes
 
 BatchRetrieveCatalogObjects
 
-Returns a set of objects based on the provided ID. [CatalogItem](#type-catalogitem)s returned in the set include all of the child information including: all [CatalogItemVariation](#type-catalogitemvariation) objects, references to its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of any [CatalogTax](#type-catalogtax) objects that apply to it.
+Returns a set of objects based on the provided ID. Each [CatalogItem](#type-catalogitem) returned in the set includes all of its child information including: all of its [CatalogItemVariation](#type-catalogitemvariation) objects, references to its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of any [CatalogTax](#type-catalogtax) objects that apply to it.
 
 ### Example
 ```ruby
@@ -348,7 +348,7 @@ api_instance = SquareConnect::CatalogApi.new
 object_id = "object_id_example" # String | The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved.
 
 opts = { 
-  include_related_objects: true # BOOLEAN | If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.
+  include_related_objects: true # BOOLEAN | If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.  Default value: `false`
 }
 
 begin
@@ -365,7 +365,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **object_id** | **String**| The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved. | 
- **include_related_objects** | **BOOLEAN**| If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. | [optional] 
+ **include_related_objects** | **BOOLEAN**| If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.  Default value: `false` | [optional] 
 
 ### Return type
 
@@ -387,7 +387,7 @@ Name | Type | Description  | Notes
 
 SearchCatalogObjects
 
-Queries the targeted catalog using a variety of query types ([CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), ([CatalogQueryExact](#type-catalogqueryexact, ([CatalogQueryRange](#type-catalogqueryrange), ([CatalogQueryText](#type-catalogquerytext), ([CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), ([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).
+Queries the targeted catalog using a variety of query types ([CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), ([CatalogQueryExact](#type-catalogqueryexact), ([CatalogQueryRange](#type-catalogqueryrange), ([CatalogQueryText](#type-catalogquerytext), ([CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), ([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).
 
 ### Example
 ```ruby

data/docs/CatalogItem.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **name** | **String** | The item's name. Searchable. | 
 **description** | **String** | The item's description. Searchable. | [optional] 
 **abbreviation** | **String** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.  Searchable. | [optional] 
-**label_color** | **String** | The color of the item's display label in the Square Point of Sale app.  Searchable. | [optional] 
+**label_color** | **String** | The color of the item's display label in the Square Point of Sale app. | [optional] 
 **available_online** | **BOOLEAN** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional] 
 **available_for_pickup** | **BOOLEAN** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] 
 **available_electronically** | **BOOLEAN** | If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. | [optional] 

data/docs/CatalogItemProductType.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-The type of a [CatalogItem](#type-catalogitem).
+The type of a [CatalogItem](#type-catalogitem). Connect V2 only allows the creation of `REGULAR` items.
 
 ## Properties
 Name | Type

data/docs/CatalogItemVariation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **upc** | **String** | The item variation's UPC, if any. Searchable. | [optional] 
 **pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional] 
 **price_money** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. | [optional] 
-**location_overrides** | [**Array<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-location price and inventory overrides. | [optional] 
+**location_overrides** | [**Array<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-[location][#type-location] price and inventory overrides. | [optional] 
 **track_inventory** | **BOOLEAN** | If `true`, inventory tracking is active for the variation. | [optional] 
 **inventory_alert_type** | **String** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional] 
 **inventory_alert_threshold** | **Integer** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.  This value is always an integer. | [optional] 

data/docs/CatalogObject.md

@@ -8,11 +8,11 @@ The wrapper object for object types in the Catalog data model. The type of a par
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below.  See [CatalogObjectType](#type-catalogobjecttype) for all possible values. | 
-**id** | **String** | A unique Square-assigned identifier to reference this object in the catalog. | 
+**id** | **String** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object.  When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | 
 **updated_at** | **String** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] 
 **version** | **Integer** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] 
-**is_deleted** | **BOOLEAN** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] 
-**catalog_v1_ids** | [**Array<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] 
+**is_deleted** | **BOOLEAN** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] 
+**catalog_v1_ids** | [**Array<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location][#type-location] where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] 
 **present_at_all_locations** | **BOOLEAN** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. | [optional] 
 **present_at_location_ids** | **Array<String>** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] 
 **absent_at_location_ids** | **Array<String>** | A list of locations where the object is not present, even if `present_at_all_locations` is `true`. | [optional] 

data/docs/CatalogQuery.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest) request. Only one query field may be present.  Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), or [CatalogModifier](#type-catalogmodifier)).  For example, a query that should return Items may specify an attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.
+A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present.  Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)).  For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.
 
 ## Properties
 Name | Type | Description | Notes
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **exact_query** | [**CatalogQueryExact**](CatalogQueryExact.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value. | [optional] 
 **prefix_query** | [**CatalogQueryPrefix**](CatalogQueryPrefix.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. | [optional] 
 **range_query** | [**CatalogQueryRange**](CatalogQueryRange.md) | A query that returns only objects for which the given (integer-valued) attribute lies in the given range. | [optional] 
-**text_query** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Red\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sm\", \"re\"]}`. | [optional] 
+**text_query** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`. | [optional] 
 **items_for_tax_query** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax](#type-catalogtax)es enabled. | [optional] 
 **items_for_modifier_list_query** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled. | [optional] 
 

data/docs/CatalogTax.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **name** | **String** | The tax's name. Searchable. | 
 **calculation_phase** | **String** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values. | [optional] 
 **inclusion_type** | **String** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values. | [optional] 
-**percentage** | **String** | The percentage of the tax in decimal form, using a '.' as the decimal separator and without a '%' sign. A value of `7.5` corresponds to 7.5%. | [optional] 
+**percentage** | **String** | The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. | [optional] 
 **applies_to_custom_amounts** | **BOOLEAN** | If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem). | [optional] 
 **enabled** | **BOOLEAN** | If `true`, the tax will be shown as enabled in the Square Point of Sale app. | [optional] 
 

data/docs/CatalogV1Id.md

@@ -2,12 +2,12 @@
 
 ### Description
 
-An Items Connect V1 object ID along with its associated location ID.
+An Items Connect V1 object ID along with its associated [location][#type-location] ID.
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **catalog_v1_id** | **String** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional] 
-**location_id** | **String** | The ID of the location this Connect V1 ID is associated with. | [optional] 
+**location_id** | **String** | The ID of the [location][#type-location] this Connect V1 ID is associated with. | [optional] 
 
 

data/docs/CreateCheckoutRequest.md

@@ -8,7 +8,7 @@ Defines the parameters that can be included in the body of a request to the [Cre
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **idempotency_key** | **String** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID.  The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates.  We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys.  See [Idempotency keys](#idempotencykeys) for more information. | 
-**order** | [**CreateOrderRequestOrder**](CreateOrderRequestOrder.md) | The order including line items to be checked out. | 
+**order** | [**CreateOrderRequest**](CreateOrderRequest.md) | The order including line items to be checked out. | 
 **ask_for_shipping_address** | **BOOLEAN** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard.  Default: `false`. | [optional] 
 **merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant.  If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account.  Default: none; only exists if explicitly set. | [optional] 
 **pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field.  Default: none; only exists if explicitly set. | [optional] 

data/docs/{CreateOrderRequestOrder.md → CreateOrderRequest.md}

@@ -1,13 +1,15 @@
-# SquareConnect::CreateOrderRequestOrder
+# SquareConnect::CreateOrderRequest
 
 ### Description
 
-The object describes the order.
+Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference_id** | **String** | An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
 **line_items** | [**Array<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | The line items to associate with this order.  Each line item represents a different product (or a custom monetary amount) to include in a purchase. | 
+**taxes** | [**Array<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | The taxes include the custom taxes. | [optional] 
+**discounts** | [**Array<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | The discounts include the custom discounts . | [optional] 
 
 

data/docs/CreateOrderRequestDiscount.md

@@ -0,0 +1,14 @@
+# SquareConnect::CreateOrderRequestDiscount
+
+### Description
+
+Represents a discount that to either a single line item or an entire order.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The discount's name. | [optional] 
+**percentage** | **String** | The percentage of the discount, as a string representation of a decimal number.  A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0 | [optional] 
+**amount_money** | [**Money**](Money.md) | The monetary amount of the discount. | [optional] 
+
+

data/docs/CreateOrderRequestLineItem.md

@@ -7,8 +7,10 @@ Represents a line item to include in an order. Each line item describes a differ
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The name of the line item. This value cannot exceed 500 characters. | 
+**name** | **String** | The name of the line item. This value cannot exceed 500 characters. | [optional] 
 **quantity** | **String** | The quantity to purchase, as a string representation of a number. Currently, only integer values are supported. | 
-**base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item's associated variation. If a line item represents a Custom Amount instead of a particular product, this field indicates that amount. | 
+**base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item's associated variation. If a line item represents a Custom Amount instead of a particular product, this field indicates that amount. | [optional] 
+**taxes** | [**Array<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | The taxes include the custom taxes. | [optional] 
+**discounts** | [**Array<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | The discounts include the custom discounts. | [optional] 
 
 

data/docs/CreateOrderRequestTax.md

@@ -0,0 +1,14 @@
+# SquareConnect::CreateOrderRequestTax
+
+### Description
+
+Represents a tax that applies to either a single line item or an entire order.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The tax's name. | [optional] 
+**type** | **String** | Indicates the calculation method used to apply the line item tax.  Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. | [optional] 
+**percentage** | **String** | The percentage of the tax, as a string representation of a decimal number.  A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0 | [optional] 
+
+

data/docs/CustomersApi.md

@@ -70,7 +70,7 @@ Name | Type | Description  | Notes
 
 CreateCustomerCard
 
-Adds a card on file to an existing customer.
+Adds a card on file to an existing customer. In the United States Square takes care of automatically updating any cards on file that might have expired since you first attached them to a customer.
 
 ### Example
 ```ruby
@@ -337,7 +337,7 @@ Name | Type | Description  | Notes
 
 UpdateCustomer
 
-Updates the details of an existing customer.  You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
+Updates the details of an existing customer. The ID of the customer may change if the customer has been merged into another customer.  You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
 
 ### Example
 ```ruby

data/docs/ErrorCode.md

@@ -70,6 +70,7 @@ Name | Type
 **UNEXPECTED_VALUE** | string
 **SANDBOX_NOT_SUPPORTED** | string
 **INVALID_EMAIL_ADDRESS** | string
+**CHECKOUT_EXPIRED** | string
 **CARD_DECLINED** | string
 **VERIFY_CVV_FAILURE** | string
 **VERIFY_AVS_FAILURE** | string

data/docs/ItemVariationLocationOverrides.md

@@ -2,15 +2,15 @@
 
 ### Description
 
-Price and inventory overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific location.
+Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location][#type-location].
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**location_id** | **String** | The ID of the location. | [optional] 
-**price_money** | [**Money**](Money.md) | The price of the [CatalogItemVariation](#type-catalogitemvariation) at the given location, or blank for variable pricing. | [optional] 
-**pricing_type** | **String** | The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given location. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional] 
-**track_inventory** | **BOOLEAN** | If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this location. | [optional] 
+**location_id** | **String** | The ID of the [location][#type-location]. | [optional] 
+**price_money** | [**Money**](Money.md) | The price of the [CatalogItemVariation](#type-catalogitemvariation) at the given [location][#type-location], or blank for variable pricing. | [optional] 
+**pricing_type** | **String** | The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location][#type-location]. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional] 
+**track_inventory** | **BOOLEAN** | If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this [location][#type-location]. | [optional] 
 **inventory_alert_type** | **String** | Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional] 
 **inventory_alert_threshold** | **Integer** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.  This value is always an integer. | [optional] 
 

data/docs/Order.md

@@ -7,10 +7,11 @@ Contains all information related to a single order to process with Square, inclu
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The order's unique ID.  This value is not present if the order was not created with the [CreateOrder](#endpoint-createorder) endpoint. | [optional] 
 **location_id** | **String** | The ID of the merchant location this order is associated with. | [optional] 
 **reference_id** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional] 
 **line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. Every order has at least one line item. | [optional] 
 **total_money** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional] 
+**total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the order. | [optional] 
+**total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the order. | [optional] 
 
 

data/docs/OrderLineItem.md

@@ -7,10 +7,13 @@ Represents a line item in an order. Each line item describes a different product
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The line item's ID, unique only within this order. | [optional] 
 **name** | **String** | The name of the line item. | [optional] 
 **quantity** | **String** | The quantity of the product to purchase. Currently, this string must have an integer value. | [optional] 
-**base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item's associated variation.  If a line item represents a Custom Amount instead of a particular product, this field indicates that amount. | [optional] 
+**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | The taxes applied to this line item. | [optional] 
+**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | The discounts applied to this line item. | [optional] 
+**base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item. | [optional] 
+**total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the line item. | [optional] 
+**total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the line item. | [optional] 
 **total_money** | [**Money**](Money.md) | The total amount of money to collect for this line item. | [optional] 
 
 

data/docs/OrderLineItemDiscount.md

@@ -0,0 +1,17 @@
+# SquareConnect::OrderLineItemDiscount
+
+### Description
+
+Represents a discount that applies to one or more line items in an order.  Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The discount's name. | [optional] 
+**type** | **String** | The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.  VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified.  See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values. | [optional] 
+**percentage** | **String** | The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%.  The percentage won't be set for an amount-based discount. | [optional] 
+**amount_money** | [**Money**](Money.md) | The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount.  The amount_money won't be set for a percentage-based discount. | [optional] 
+**applied_money** | [**Money**](Money.md) | The amount of discount actually applied to this line item.  Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items. | [optional] 
+**scope** | **String** | Indicates the level at which the discount applies. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values. | [optional] 
+
+

data/docs/OrderLineItemDiscountScope.md

@@ -0,0 +1,13 @@
+# SquareConnect::OrderLineItemDiscountScope
+
+### Description
+
+Indicates whether this is a line item or order-level discount.
+
+## Properties
+Name | Type
+------------ | -------------
+**LINE_ITEM** | string
+**ORDER** | string
+
+

data/docs/OrderLineItemDiscountType.md

@@ -0,0 +1,16 @@
+# SquareConnect::OrderLineItemDiscountType
+
+### Description
+
+Indicates how the discount is applied to the associated line item or order.
+
+## Properties
+Name | Type
+------------ | -------------
+**UNKNOWN** | string
+**FIXED_PERCENTAGE** | string
+**FIXED_AMOUNT** | string
+**VARIABLE_PERCENTAGE** | string
+**VARIABLE_AMOUNT** | string
+
+

data/docs/OrderLineItemTax.md

@@ -0,0 +1,15 @@
+# SquareConnect::OrderLineItemTax
+
+### Description
+
+Represents a tax that applies to one or more line items in an order.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The tax's name. | [optional] 
+**type** | **String** | Indicates the calculation method used to apply the tax.  See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. | [optional] 
+**percentage** | **String** | The percentage of the tax, as a string representation of a decimal number.  A value of `7.25` corresponds to a percentage of 7.25%. | [optional] 
+**applied_money** | [**Money**](Money.md) | The amount of the money applied by the tax in an order. | [optional] 
+
+

data/docs/OrderLineItemTaxType.md

@@ -0,0 +1,14 @@
+# SquareConnect::OrderLineItemTaxType
+
+### Description
+
+Indicates how the tax is applied to the associated line item or order.
+
+## Properties
+Name | Type
+------------ | -------------
+**UNKNOWN** | string
+**ADDITIVE** | string
+**INCLUSIVE** | string
+
+

data/docs/RetrieveCatalogObjectRequest.md

@@ -7,6 +7,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**include_related_objects** | **BOOLEAN** | If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. | [optional] 
+**include_related_objects** | **BOOLEAN** | If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.  Default value: `false` | [optional] 
 
 

data/docs/SearchCatalogObjectsRequest.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **object_types** | **Array<String>** | The desired set of object types to apper in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] 
 **include_deleted_objects** | **BOOLEAN** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] 
 **include_related_objects** | **BOOLEAN** | If `true`, the response will include additional objects that are related to the requested object, as follows:  If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response.  If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response. | [optional] 
-**begin_time** | **String** | Return only objects that have been modified after this [timestamp](#workingwithdates) (in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\"). | [optional] 
+**begin_time** | **String** | Return only objects that have been modified after this [timestamp](#workingwithdates) (in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\"). The timestamp is exclusive - objects whose timestamp is equal to `begin_time` will not be included in the response. | [optional] 
 **query** | [**CatalogQuery**](CatalogQuery.md) | A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. | [optional] 
 **limit** | **Integer** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional] 
 

data/docs/Transaction.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-Represents a transaction processed with Square, either with the Connect API or with Square Register.  The `tenders` field of this object lists all methods of payment used to pay in the transaction.
+Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale.  The `tenders` field of this object lists all methods of payment used to pay in the transaction.
 
 ## Properties
 Name | Type | Description | Notes
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **refunds** | [**Array<Refund>**](Refund.md) | Refunds that have been applied to any tender in the transaction. | [optional] 
 **reference_id** | **String** | If the transaction was created with the [Charge](#endpoint-charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. | [optional] 
 **product** | **String** | The Square product that processed the transaction. | [optional] 
-**client_id** | **String** | If the transaction was created in the Square Register app, this value is the ID generated for the transaction by Square Register.  This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode).  It is not currently possible with the Connect API to perform a transaction lookup by this value. | [optional] 
+**client_id** | **String** | If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale.  This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode).  It is not currently possible with the Connect API to perform a transaction lookup by this value. | [optional] 
 **order** | [**Order**](Order.md) | The order associated with this transaction, if any. | [optional] 
 **shipping_address** | [**Address**](Address.md) | The shipping address provided in the request, if any. | [optional]