square_connect 2.20190508.0.304 → 2.20190612.0.309

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85d184fb9366b2252308d8dc627cb0b8e233bf2d10c10787bb5b17bf323a3bfa
-  data.tar.gz: 01e70bc43a761089a79e9d0137b3f70c801ed22ad5ef90a246934de0dfc84b28
+  metadata.gz: 5b12b9f96f75b74a6946254103385d855efbb76edd22aba480548f29e25b2685
+  data.tar.gz: be7a06e80022b951e43f40380f92f20647e7e55fff8313b85702dd006507cf69
 SHA512:
-  metadata.gz: 178a78fe16e6c3a9f18fa0fb6a2a8c82ab22d02ce159354b3cbf610acaa2a825e31246940622aef6b957cb40d30d8311cc68567430bcb1b3d3cfbb20b2fc75fa
-  data.tar.gz: c1726f1fd4c56fee51df0732b8c119f868431c19f662ae9746a1c251921249fd16d03c1d67a5654dcd3728ae3e1678ba54dd296c90ca9e376d44c9b3c4fe8611
+  metadata.gz: cc9b61cf7acecebf72da72826c543a3482025f147b60691ed7d5df02236e56f97e3e7553bc2f4f70c60ae0907d47ce1d72a33d1c16e6ce758a931558236d5f30
+  data.tar.gz: de4e71af13f5b63a0d557a3d70e0a301ed7e504cd9e40ca28c038cc7c8d87a7959350cd5ade04ff6fb78ef6cf58fa5d69612e4f749cd397aed62df049bb77eff

data/CHANGES.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## Version 2.20190612.0 (2019-06-12)
+
+* **BETA releases**:
+  * Orders API: supports service charges with a new field and datatype.
+  * Catalog API: supports measurement unites for item variation quantities with a new field and datatype.
+* **New functionality**: `Order` entities — now include a `source` field that contains details on where the order originated.
+* **Improved functionality**: ListLocations — Expanded business information available through the Locations API, including business hours, contact email, social media handles, and longitude/latitude for physical locations.
+
 ## Version 2.20190508.0 (2019-05-08)
 
 ## Details
@@ -62,15 +70,15 @@
 ## New API: Labor API
 
 The Labor API now includes functionality
-that gives a Square account the ability to track and retrieve employee labor hours 
-including multiple hourly wage rates per employee, work shift break tracking, and 
+that gives a Square account the ability to track and retrieve employee labor hours
+including multiple hourly wage rates per employee, work shift break tracking, and
 standardized break templates.
 
 See the Connect v2 Technical Reference.
 
 ## New API: Employees API
 
-The Employees API includes the ability to list employees for a Square 
+The Employees API includes the ability to list employees for a Square
 account and retrieve a single employee by ID.
 
 See the Connect v2 Technical Reference.
@@ -312,7 +320,7 @@ represent the value of returned goods in an exchange, rather than actual money m
 ### New features: Orders API
 
 * For Catalog-backed line items, setting `CreateOrderRequestLineItem.base_price_money` will now override
-  the catalog item variation's price.  
+  the catalog item variation's price.
 * `CreateOrderRequestModifier`s may now be created ad hoc using the new `name` and `base_price_money` fields.
 
 ## Version 2.5.2 (2018-01-06)

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.20190508.0
+- Package version: 2.20190612.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -211,6 +211,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect::AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
  - [SquareConnect::AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
  - [SquareConnect::Address](docs/Address.md)
+ - [SquareConnect::AggregationStrategy](docs/AggregationStrategy.md)
  - [SquareConnect::BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md)
  - [SquareConnect::BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md)
  - [SquareConnect::BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
@@ -244,6 +245,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogItemModifierListInfo](docs/CatalogItemModifierListInfo.md)
  - [SquareConnect::CatalogItemProductType](docs/CatalogItemProductType.md)
  - [SquareConnect::CatalogItemVariation](docs/CatalogItemVariation.md)
+ - [SquareConnect::CatalogMeasurementUnit](docs/CatalogMeasurementUnit.md)
  - [SquareConnect::CatalogModifier](docs/CatalogModifier.md)
  - [SquareConnect::CatalogModifierList](docs/CatalogModifierList.md)
  - [SquareConnect::CatalogModifierListSelectionType](docs/CatalogModifierListSelectionType.md)
@@ -251,7 +253,9 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogObject](docs/CatalogObject.md)
  - [SquareConnect::CatalogObjectBatch](docs/CatalogObjectBatch.md)
  - [SquareConnect::CatalogObjectType](docs/CatalogObjectType.md)
+ - [SquareConnect::CatalogPricingRule](docs/CatalogPricingRule.md)
  - [SquareConnect::CatalogPricingType](docs/CatalogPricingType.md)
+ - [SquareConnect::CatalogProductSet](docs/CatalogProductSet.md)
  - [SquareConnect::CatalogQuery](docs/CatalogQuery.md)
  - [SquareConnect::CatalogQueryExact](docs/CatalogQueryExact.md)
  - [SquareConnect::CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md)
@@ -261,11 +265,13 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogQuerySortedAttribute](docs/CatalogQuerySortedAttribute.md)
  - [SquareConnect::CatalogQueryText](docs/CatalogQueryText.md)
  - [SquareConnect::CatalogTax](docs/CatalogTax.md)
+ - [SquareConnect::CatalogTimePeriod](docs/CatalogTimePeriod.md)
  - [SquareConnect::CatalogV1Id](docs/CatalogV1Id.md)
  - [SquareConnect::ChargeRequest](docs/ChargeRequest.md)
  - [SquareConnect::ChargeRequestAdditionalRecipient](docs/ChargeRequestAdditionalRecipient.md)
  - [SquareConnect::ChargeResponse](docs/ChargeResponse.md)
  - [SquareConnect::Checkout](docs/Checkout.md)
+ - [SquareConnect::Coordinates](docs/Coordinates.md)
  - [SquareConnect::Country](docs/Country.md)
  - [SquareConnect::CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md)
  - [SquareConnect::CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md)
@@ -361,6 +367,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect::MeasurementUnit](docs/MeasurementUnit.md)
  - [SquareConnect::MeasurementUnitArea](docs/MeasurementUnitArea.md)
  - [SquareConnect::MeasurementUnitCustom](docs/MeasurementUnitCustom.md)
+ - [SquareConnect::MeasurementUnitGeneric](docs/MeasurementUnitGeneric.md)
  - [SquareConnect::MeasurementUnitLength](docs/MeasurementUnitLength.md)
  - [SquareConnect::MeasurementUnitVolume](docs/MeasurementUnitVolume.md)
  - [SquareConnect::MeasurementUnitWeight](docs/MeasurementUnitWeight.md)
@@ -390,8 +397,11 @@ Class | Method | HTTP request | Description
  - [SquareConnect::OrderReturnDiscount](docs/OrderReturnDiscount.md)
  - [SquareConnect::OrderReturnLineItem](docs/OrderReturnLineItem.md)
  - [SquareConnect::OrderReturnLineItemModifier](docs/OrderReturnLineItemModifier.md)
+ - [SquareConnect::OrderReturnServiceCharge](docs/OrderReturnServiceCharge.md)
  - [SquareConnect::OrderReturnTax](docs/OrderReturnTax.md)
  - [SquareConnect::OrderRoundingAdjustment](docs/OrderRoundingAdjustment.md)
+ - [SquareConnect::OrderServiceCharge](docs/OrderServiceCharge.md)
+ - [SquareConnect::OrderServiceChargeCalculationPhase](docs/OrderServiceChargeCalculationPhase.md)
  - [SquareConnect::OrderSource](docs/OrderSource.md)
  - [SquareConnect::OrderState](docs/OrderState.md)
  - [SquareConnect::Product](docs/Product.md)
@@ -449,6 +459,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect::ShiftWorkdayMatcher](docs/ShiftWorkdayMatcher.md)
  - [SquareConnect::SortOrder](docs/SortOrder.md)
  - [SquareConnect::SourceApplication](docs/SourceApplication.md)
+ - [SquareConnect::StandardUnitDescription](docs/StandardUnitDescription.md)
+ - [SquareConnect::StandardUnitDescriptionGroup](docs/StandardUnitDescriptionGroup.md)
  - [SquareConnect::TaxCalculationPhase](docs/TaxCalculationPhase.md)
  - [SquareConnect::TaxInclusionType](docs/TaxInclusionType.md)
  - [SquareConnect::Tender](docs/Tender.md)

data/docs/AggregationStrategy.md

@@ -0,0 +1,15 @@
+# SquareConnect::AggregationStrategy
+
+### Description
+
+Indicates how a [CatalogPricingRule](#type-catalogpricingrule) can be combined with other rules.
+
+## Properties
+Name | Type
+------------ | -------------
+**UNKNOWN** | string
+**BASE** | string
+**STACKABLE** | string
+**EXCLUSIVE** | string
+
+

data/docs/ApplePayApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 RegisterDomain
 
-Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain.  This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.  To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payments/sqpaymentform/overview) guide.
+Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain.  This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.  To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide.
 
 ### Example
 ```ruby

data/docs/BatchRetrieveCatalogObjectsRequest.md

@@ -8,6 +8,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **object_ids** | **Array<String>** | The IDs of the [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 objects, as follows:  If the `objects` 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 `objects` 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 objects, as follows:  If the `objects` field of the response contains a [CatalogItem](#type-catalogitem),  its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `objects` 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] 
 
 

data/docs/Card.md

@@ -14,6 +14,6 @@ Name | Type | Description | Notes
 **exp_year** | **Integer** | The four-digit year of the card's expiration date. | [optional] 
 **cardholder_name** | **String** | The name of the cardholder. | [optional] 
 **billing_address** | [**Address**](Address.md) | The billing address for this card. | [optional] 
-**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] 
+**fingerprint** | **String** | A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account. | [optional] 
 
 

data/docs/CatalogApi.md

@@ -276,7 +276,7 @@ Name | Type | Description  | Notes
 
 ListCatalog
 
-Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The types parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`.
+Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`.  __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`.
 
 ### 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.  Default value: `false`
+  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, [CatalogImage](#type-catalogimage)s 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.  Default value: `false` | [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, [CatalogImage](#type-catalogimage)s 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
 

data/docs/CatalogInfoResponse.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
 **limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) |  | [optional] 
+**standard_unit_description_group** | [**StandardUnitDescriptionGroup**](StandardUnitDescriptionGroup.md) | Names and abbreviations for standard units. | [optional] 
 
 

data/docs/CatalogItem.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **tax_ids** | **Array<String>** | A set of IDs indicating the [CatalogTax](#type-catalogtax)es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. [CatalogTax](#type-catalogtax)es may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] 
 **modifier_list_info** | [**Array<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of [CatalogItemModifierListInfo](#type-catalogitemmodifierlistinfo) objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. [CatalogModifierList](#type-catalogmodifierlist)s may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] 
 **image_url** | **String** | __Deprecated__. The URL of an image representing this item. Deprecated in favor of `image_id` in [`CatalogObject`](#type-catalogobject). | [optional] 
-**variations** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. | [optional] 
+**variations** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item.  Maximum: 250 item variations | [optional] 
 **product_type** | **String** | The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] 
 **skip_modifier_screen** | **BOOLEAN** | If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-catalogmodifier)s before adding the item to the cart.  This is the default behavior.  If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.  Third-party clients are encouraged to implement similar behaviors. | [optional] 
 

data/docs/CatalogItemVariation.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-An item variation (i.e., product) in the Catalog object model.
+An item variation (i.e., product) in the Catalog object model. Each item may have a maximum of 250 item variations.
 
 ## Properties
 Name | Type | Description | Notes
@@ -20,5 +20,7 @@ Name | Type | Description | Notes
 **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] 
 **user_data** | **String** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] 
 **service_duration** | **Integer** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] 
+**catalog_measurement_unit_id** | **String** | Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities. | [optional] 
+**measurement_unit_id** | **String** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional] 
 
 

data/docs/CatalogMeasurementUnit.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogMeasurementUnit
+
+### Description
+
+Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**measurement_unit** | [**MeasurementUnit**](MeasurementUnit.md) | Indicates the unit used to measure the quantity of a catalog item variation. | [optional] 
+**precision** | **Integer** |  Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc.  Min: 0  Max: 5  Default: 3 | [optional] 
+
+

data/docs/CatalogObject.md

@@ -25,5 +25,6 @@ Name | Type | Description | Notes
 **modifier_list_data** | [**CatalogModifierList**](CatalogModifierList.md) | Structured data for a [CatalogModifierList](#type-catalogmodifierlist), set for CatalogObjects of type `MODIFIER_LIST`. | [optional] 
 **modifier_data** | [**CatalogModifier**](CatalogModifier.md) | Structured data for a [CatalogModifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`. | [optional] 
 **image_data** | [**CatalogImage**](CatalogImage.md) | Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`. | [optional] 
+**measurement_unit_data** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a [CatalogMeasurementUnit](#type-catalogmeasurementunit), set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] 
 
 

data/docs/CatalogObjectType.md

@@ -15,5 +15,8 @@ Name | Type
 **DISCOUNT** | string
 **MODIFIER_LIST** | string
 **MODIFIER** | string
+**PRICING_RULE** | string
+**PRODUCT_SET** | string
+**TIME_PERIOD** | string
 
 

data/docs/CatalogPricingRule.md

@@ -0,0 +1,24 @@
+# SquareConnect::CatalogPricingRule
+
+### Description
+
+Defines how prices are modified or set for items that match the pricing rule during the active time period.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | User-defined name for the pricing rule. For example, \"Buy one get one free\" or \"10% off\". | [optional] 
+**time_period_ids** | **Array<String>** | Unique ID for the [CatalogTimePeriod](#type-catalogtimeperiod)s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. | [optional] 
+**total_price_money** | [**Money**](Money.md) | The total amount of money to charge for all matched items.  Only one of `total_price_money`, `item_price`, or `discount` can be supplied. | [optional] 
+**item_price_money** | [**Money**](Money.md) | The amount of money to charge for each matched item.  Only one of `total_price_money`, `item_price`, or `discount` can be supplied. | [optional] 
+**discount_id** | **String** | Unique ID for the [CatalogDiscount](#type-catalogdiscount) to take off the price of all matched items.  Only one of `total_price_money`, `item_price`, or `discount` can be supplied. | [optional] 
+**match_products_id** | **String** | Unique ID for the [CatalogProductSet](#type-catalogproductset) that will be matched by this rule. A match rule matches within the entire cart. | [optional] 
+**apply_products_id** | **String** | The [CatalogProductSet](#type-catalogproductset) to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products. | [optional] 
+**stackable** | **String** | Describes how the pricing rule can be combined with other pricing rules. See [Stackable](#type-stackable) for all possible values. See [AggregationStrategy](#type-aggregationstrategy) for possible values | [optional] 
+**exclude_products_id** | **String** | Identifies the [CatalogProductSet](#type-catalogproductset) to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] 
+**valid_from_date** | **String** | Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] 
+**valid_from_local_time** | **String** | Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app.  Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] 
+**valid_until_date** | **String** | Represents the date the pricing rule will become inactive.  Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] 
+**valid_until_local_time** | **String** | Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app.  Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] 
+
+

data/docs/CatalogProductSet.md

@@ -0,0 +1,18 @@
+# SquareConnect::CatalogProductSet
+
+### Description
+
+Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". | [optional] 
+**product_ids_any** | **Array<String>** | Unique IDs for any [CatalogObjects](#type-catalogobject)s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply.  This can be used with `product_ids_all` in a parent [CatalogProductSet](#type-catalogproductset) to match groups of products for a bulk discount, such as a discount for an entree and side combo.  Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.  Max: 500 catalog object IDs. | [optional] 
+**product_ids_all** | **Array<String>** | Unique IDs for [CatalogObjects](#type-catalogobject) to include in this product set. All objects in this set must be included in an order for a pricing rule to apply.  Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.  Max: 500 catalog object IDs. | [optional] 
+**quantity_exact** | **Integer** | If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply.  Cannot be combined with either `quantity_min` or `quantity_max`. | [optional] 
+**quantity_min** | **Integer** | If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. | [optional] 
+**quantity_max** | **Integer** | If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`. | [optional] 
+**all_products** | **BOOLEAN** | If set to `true`, the product set will include every item in the catalog.  Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. | [optional] 
+
+

data/docs/CatalogTimePeriod.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogTimePeriod
+
+### Description
+
+Represents a time period - either a single period or a repeating period.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | An iCalendar (RFC5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which specifies the name, timing, duration and recurrence of this time period.  Example:  ``` DTSTART:20190707T180000 DURATION:P2H RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR ```  Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported. `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT` and `END:VEVENT` is not required in the request. The response will always include them. | [optional] 
+
+

data/docs/Coordinates.md

@@ -0,0 +1,13 @@
+# SquareConnect::Coordinates
+
+### Description
+
+Latitude and longitude coordinates.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**latitude** | **Float** | The coordinate's latitude expressed in degrees. | [optional] 
+**longitude** | **Float** | The coordinate's longitude expressed in degrees. | [optional] 
+
+

data/docs/CreateOrderRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order** | [**Order**](Order.md) | The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key. | [optional] 
 **idempotency_key** | **String** | A value you specify that uniquely identifies this order among orders you've created.  If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders.  See [Idempotency](/basics/api101/idempotency) for more information. | [optional] 
-**reference_id** | **String** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead.  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. -- Top-level fields necessary to support the connect v2 CreateOrderRequest shape. | [optional] 
+**reference_id** | **String** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead.  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) | __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead.  The line items to associate with this order.  Each line item represents a different product to include in a purchase. | [optional] 
 **taxes** | [**Array<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead.  The taxes to include on the order. | [optional] 
 **discounts** | [**Array<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead.  The discounts to include on the order. | [optional] 

data/docs/DayOfWeek.md

@@ -2,7 +2,7 @@
 
 ### Description
 
- Indicates the specific day  of the week.
+Indicates the specific day  of the week.
 
 ## Properties
 Name | Type

data/docs/ErrorCode.md

@@ -52,6 +52,7 @@ Name | Type
 **ONE_INSTRUMENT_EXPECTED** | string
 **NO_FIELDS_SET** | string
 **DEPRECATED_FIELD_SET** | string
+**RETIRED_FIELD_SET** | string
 **CARD_EXPIRED** | string
 **INVALID_EXPIRATION** | string
 **INVALID_EXPIRATION_YEAR** | string

data/docs/Location.md

@@ -23,5 +23,11 @@ Name | Type | Description | Notes
 **type** | **String** | The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values | [optional] 
 **website_url** | **String** | The location's website, as set by the account owner in the Square dashboard.  Default: none; only exists if explicitly set. | [optional] 
 **business_hours** | [**BusinessHours**](BusinessHours.md) |   The hours of operation for a business location.  Default: none; only exists if explicitly set. | [optional] 
+**business_email** | **String** | The email of the location. | [optional] 
+**description** | **String** | The business description of the location. | [optional] 
+**twitter_username** | **String** | The Twitter username of the location without the ' | [optional] 
+**instagram_username** | **String** | The Instagram username of the location without the ' | [optional] 
+**facebook_url** | **String** | The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. | [optional] 
+**coordinates** | [**Coordinates**](Coordinates.md) | The physical coordinates (latitude and longitude) of the location. | [optional] 
 
 

data/docs/MeasurementUnit.md

@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **length_unit** | **String** | Represents a standard length unit. See [MeasurementUnitLength](#type-measurementunitlength) for possible values | [optional] 
 **volume_unit** | **String** | Represents a standard volume unit. See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values | [optional] 
 **weight_unit** | **String** | Represents a standard unit of weight or mass. See [MeasurementUnitWeight](#type-measurementunitweight) for possible values | [optional] 
+**generic_unit** | **String** | Reserved for API integrations that lack the ability to specify a real measurement unit See [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values | [optional] 
 
 

data/docs/MeasurementUnitGeneric.md

@@ -0,0 +1,13 @@
+# SquareConnect::MeasurementUnitGeneric
+
+### Description
+
+A custom unit of measurement defined by the user.
+
+## Properties
+Name | Type
+------------ | -------------
+**INVALID_GENERIC_UNIT** | string
+**UNIT** | string
+
+

data/docs/OAuthApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 ObtainToken
 
-Returns an OAuth access token.   The endpoint supports distinct methods of obtaining OAuth access tokens.  Applications specify a method by adding the `grant_type` parameter  in the request and also provide relevant information.  For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).   __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and  a refresh token in the response.   By default, the OAuth API lets up to 500 Square accounts authorize your application. Please [contact support](https://squareup.com/help/us/en/contact?prefill=developer_api) if you are developing an application for a larger audience.  __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__.
+Returns an OAuth access token.   The endpoint supports distinct methods of obtaining OAuth access tokens.  Applications specify a method by adding the `grant_type` parameter  in the request and also provide relevant information.  For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).   __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and  a refresh token in the response.   __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__.
 
 ### Example
 ```ruby

data/docs/ObtainTokenResponse.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **token_type** | **String** | This value is always _bearer_. | [optional] 
 **expires_at** | **String** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] 
 **merchant_id** | **String** | The ID of the authorizing merchant's business. | [optional] 
-**subscription_id** | **String** | __Legacy field__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] 
-**plan_id** | **String** | The ID of the [subscription](https://docs.connect.squareup.com/api/connect/v1/#navsection-subscriptionmanagement) plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] 
+**subscription_id** | **String** | __LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] 
+**plan_id** | **String** | __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] 
 **id_token** | **String** | Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request. | [optional] 
 **refresh_token** | **String** | A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). | [optional] 
 

data/docs/Order.md

@@ -7,7 +7,7 @@ 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 only present for Order objects created by the Orders API through the [CreateOrder](#endpoint-orders-createorder) endpoint. | [optional] 
+**id** | **String** | The order's unique ID.  This field is read-only. | [optional] 
 **location_id** | **String** | The ID of the merchant location this order is associated with. | 
 **reference_id** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional] 
 **source** | [**OrderSource**](OrderSource.md) | The origination details of the order. | [optional] 
@@ -15,19 +15,21 @@ Name | Type | Description | Notes
 **line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. | [optional] 
 **taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list. | [optional] 
 **discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list. | [optional] 
+**service_charges** | [**Array<OrderServiceCharge>**](OrderServiceCharge.md) | A list of service charges applied to the order. | [optional] 
 **fulfillments** | [**Array<OrderFulfillment>**](OrderFulfillment.md) | Details on order fulfillment.  Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments. | [optional] 
-**returns** | [**Array<OrderReturn>**](OrderReturn.md) | Collection of items from sale Orders being returned in this one. Normally part of an Itemized Return or Exchange.  There will be exactly one `Return` object per sale Order being referenced. | [optional] 
-**return_amounts** | [**OrderMoneyAmounts**](OrderMoneyAmounts.md) | Rollup of returned money amounts. | [optional] 
-**net_amounts** | [**OrderMoneyAmounts**](OrderMoneyAmounts.md) | Net money amounts (sale money - return money). | [optional] 
-**rounding_adjustment** | [**OrderRoundingAdjustment**](OrderRoundingAdjustment.md) | A positive or negative rounding adjustment to the total of the order, commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. | [optional] 
+**returns** | [**Array<OrderReturn>**](OrderReturn.md) | Collection of items from sale Orders being returned in this one. Normally part of an Itemized Return or Exchange.  There will be exactly one `Return` object per sale Order being referenced.  This field is read-only. | [optional] 
+**return_amounts** | [**OrderMoneyAmounts**](OrderMoneyAmounts.md) | Rollup of returned money amounts.  This field is read-only. | [optional] 
+**net_amounts** | [**OrderMoneyAmounts**](OrderMoneyAmounts.md) | Net money amounts (sale money - return money).  This field is read-only. | [optional] 
+**rounding_adjustment** | [**OrderRoundingAdjustment**](OrderRoundingAdjustment.md) | A positive or negative rounding adjustment to the total of the order, commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency.  This field is read-only. | [optional] 
 **tenders** | [**Array<Tender>**](Tender.md) | The Tenders which were used to pay for the Order. This field is read-only. | [optional] 
 **refunds** | [**Array<Refund>**](Refund.md) | The Refunds that are part of this Order. This field is read-only. | [optional] 
-**created_at** | **String** | Timestamp for when the order was created. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
-**updated_at** | **String** | Timestamp for when the order was last updated. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
-**closed_at** | **String** | Timestamp for when the order was closed. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
+**created_at** | **String** | Timestamp for when the order was created. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".  This field is read-only. | [optional] 
+**updated_at** | **String** | Timestamp for when the order was last updated. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".  This field is read-only. | [optional] 
+**closed_at** | **String** | Timestamp for when the order was closed. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".  This field is read-only. | [optional] 
 **state** | **String** | The current state of the order. `OPEN`,`COMPLETED`,`CANCELED` See [OrderState](#type-orderstate) for possible values | [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] 
+**total_money** | [**Money**](Money.md) | The total amount of money to collect for the order.  This field is read-only. | [optional] 
+**total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the order.  This field is read-only. | [optional] 
+**total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the order.  This field is read-only. | [optional] 
+**total_service_charge_money** | [**Money**](Money.md) | The total amount of money collected in service charges for the order.  Note: `total_service_charge_money` is the sum of `applied_money` fields for each individual service charge. Therefore, `total_service_charge_money` will only include inclusive tax amounts, not additive tax amounts.  This field is read-only. | [optional]