Release 2.20190612.0 (#54)

square · Jun 12, 2019 · 9fd342e · 9fd342e
1 parent 5c69a30
commit 9fd342e
Show file tree

Hide file tree

Showing 116 changed files with 2,581 additions and 235 deletions.
diff --git a/CHANGES.md b/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 &mdash; now include a `source` field that contains details on where the order originated.
+* **Improved functionality**: ListLocations &mdash; 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.5 (2018-01-06)

diff --git a/README.md b/README.md
@@ -182,6 +182,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)
@@ -215,14 +216,17 @@ 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)
  - [SquareConnect.CatalogModifierOverride](docs/CatalogModifierOverride.md)
  - [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)
@@ -232,11 +236,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)
@@ -332,6 +338,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)
@@ -361,8 +368,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)
@@ -420,6 +430,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)

diff --git a/docs/AggregationStrategy.md b/docs/AggregationStrategy.md
@@ -0,0 +1,14 @@
+# SquareConnect.AggregationStrategy
+
+## Enum
+
+
+* `UNKNOWN` (value: `"UNKNOWN"`)
+
+* `BASE` (value: `"BASE"`)
+
+* `STACKABLE` (value: `"STACKABLE"`)
+
+* `EXCLUSIVE` (value: `"EXCLUSIVE"`)
+
+
diff --git a/docs/ApplePayApi.md b/docs/ApplePayApi.md
@@ -13,7 +13,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
 ```javascript

diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md
@@ -8,6 +8,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **object_ids** | **[String]** | The IDs of the [CatalogObject](#type-catalogobject)s to be retrieved. | 
-**include_related_objects** | **Boolean** | If &#x60;true&#x60;, the response will include additional objects that are related to the requested objects, as follows:  If the &#x60;objects&#x60; 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 &#x60;related_objects&#x60; field of the response. If the &#x60;objects&#x60; field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the &#x60;related_objects&#x60; field of the response. | [optional] 
+**include_related_objects** | **Boolean** | If &#x60;true&#x60;, the response will include additional objects that are related to the requested objects, as follows:  If the &#x60;objects&#x60; 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 &#x60;related_objects&#x60; field of the response. If the &#x60;objects&#x60; field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the &#x60;related_objects&#x60; field of the response. | [optional] 
 
 
diff --git a/docs/Card.md b/docs/Card.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **exp_year** | **Number** | The four-digit year of the card&#39;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] 
 
 
 <a name="CardBrandEnum"></a>

diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md
@@ -257,7 +257,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: &#x60;ITEM&#x60;, &#x60;ITEM_VARIATION&#x60;, &#x60;MODIFIER&#x60;, &#x60;MODIFIER_LIST&#x60;, &#x60;CATEGORY&#x60;, &#x60;DISCOUNT&#x60;, &#x60;TAX&#x60;.
+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 &#x60;types&#x60; parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: &#x60;ITEM&#x60;, &#x60;ITEM_VARIATION&#x60;, &#x60;MODIFIER&#x60;, &#x60;MODIFIER_LIST&#x60;, &#x60;CATEGORY&#x60;, &#x60;DISCOUNT&#x60;, &#x60;TAX&#x60;.  __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set &#x60;include_deleted_objects&#x60; to &#x60;true&#x60;.
 
 ### Example
 ```javascript
@@ -324,7 +324,7 @@ var apiInstance = new SquareConnect.CatalogApi();
 var objectId = "objectId_example"; // String | The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved.
 
 var opts = { 
-  'includeRelatedObjects': 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`
+  'includeRelatedObjects': 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`
 };
 apiInstance.retrieveCatalogObject(objectId, opts).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
@@ -339,7 +339,7 @@ apiInstance.retrieveCatalogObject(objectId, opts).then(function(data) {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **objectId** | **String**| The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved. | 
- **includeRelatedObjects** | **Boolean**| If &#x60;true&#x60;, the response will include additional objects that are related to the requested object, as follows:  If the &#x60;object&#x60; 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 &#x60;related_objects&#x60; field of the response. If the &#x60;object&#x60; field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the &#x60;related_objects&#x60; field of the response.  Default value: &#x60;false&#x60; | [optional] 
+ **includeRelatedObjects** | **Boolean**| If &#x60;true&#x60;, the response will include additional objects that are related to the requested object, as follows:  If the &#x60;object&#x60; 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 &#x60;related_objects&#x60; field of the response. If the &#x60;object&#x60; field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the &#x60;related_objects&#x60; field of  the response.  Default value: &#x60;false&#x60; | [optional] 
 
 ### Return type
 

diff --git a/docs/CatalogInfoResponse.md b/docs/CatalogInfoResponse.md
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**[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] 
 
 
diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **tax_ids** | **[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 &#x60;UpdateItemTaxes&#x60;. | [optional] 
 **modifier_list_info** | [**[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 &#x60;UpdateItemModifierLists&#x60;. | [optional] 
 **image_url** | **String** | __Deprecated__. The URL of an image representing this item. Deprecated in favor of &#x60;image_id&#x60; in [&#x60;CatalogObject&#x60;](#type-catalogobject). | [optional] 
-**variations** | [**[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. | [optional] 
+**variations** | [**[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 &#x60;REGULAR&#x60; 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 &#x60;false&#x60;, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)&#39;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 &#x60;true&#x60;, 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&#39;s details.  Third-party clients are encouraged to implement similar behaviors. | [optional] 
 

diff --git a/docs/CatalogItemVariation.md b/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,6 +20,8 @@ Name | Type | Description | Notes
 **inventory_alert_threshold** | **Number** | If the inventory quantity for the variation is less than or equal to this value and &#x60;inventory_alert_type&#x60; is &#x60;LOW_QUANTITY&#x60;, 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** | **Number** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type &#x60;APPOINTMENTS_SERVICE&#x60;, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value &#x60;1800000&#x60;, 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] 
 
 
 <a name="PricingTypeEnum"></a>