Release 2.20180918.1 (#29)

* Release 2.20180918.1

CHANGES.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## Version 2.20180918.1 (2018-10-24)
+
+### New feature: Support for Partial Payments in Connect v1
+
+The Connect SDK now supports partial payment functionality for the Connect v1 Transactions API with the addition of a new `Payment` field:
+* `Payment.is_partial` — Indicates whether or not the payment is only partially paid for. If `true`, the payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.
+
+`Tender` also includes 2 new fields to help resolve timing around payments with multiple tenders. Invoices that involve partial payment (e.g., requiring a deposit) may include tenders settled well before the entire payment is completed:
+* `Tender.tendered_at` — The time when the tender was accepted by the merchant.
+* `Tender.settled_at` — The time when the tender was captured, in ISO 8601 format. Typically the same as (or within moments of) `tendered_at` unless the tender was part of a delay capture transaction.
+
+The change also makes some behavioral changes to the Connect v1 Payment endpoints:
+* **Create Refunds** rejects requests for invoices that have partial payments pending.
+* **List Payments** takes a new request field, `include_partial` to indicate whether partial payments should be included in the response.
+
 ## Version 2.20180918.0 (2018-09-18)
 
 We have added Connect v2 Inventory API and birthdays in `Customer` entities.

docs/AdditionalRecipient.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**locationId** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | 
+**location_id** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | 
 **description** | **String** | The description of the additional recipient. | 
-**amountMoney** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
-**receivableId** | **String** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. | [optional] 
+**amount_money** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
+**receivable_id** | **String** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. | [optional] 
 
 

docs/AdditionalRecipientReceivable.md

@@ -4,10 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The additional recipient receivable's unique ID, issued by Square payments servers. | 
-**transactionId** | **String** | The ID of the transaction that the additional recipient receivable was applied to. | 
-**transactionLocationId** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | 
-**amountMoney** | [**Money**](Money.md) | The amount of the receivable. This will always be non-negative. | 
-**createdAt** | **String** | The time when the additional recipient receivable was created, in RFC 3339 format. | [optional] 
+**transaction_id** | **String** | The ID of the transaction that the additional recipient receivable was applied to. | 
+**transaction_location_id** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | 
+**amount_money** | [**Money**](Money.md) | The amount of the receivable. This will always be non-negative. | 
+**created_at** | **String** | The time when the additional recipient receivable was created, in RFC 3339 format. | [optional] 
 **refunds** | [**[AdditionalRecipientReceivableRefund]**](AdditionalRecipientReceivableRefund.md) | Any refunds of the receivable that have been applied. | [optional] 
 
 

docs/AdditionalRecipientReceivableRefund.md

@@ -4,10 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The receivable refund's unique ID, issued by Square payments servers. | 
-**receivableId** | **String** | The ID of the receivable that the refund was applied to. | 
-**refundId** | **String** | The ID of the refund that is associated to this receivable refund. | 
-**transactionLocationId** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | 
-**amountMoney** | [**Money**](Money.md) | The amount of the refund. This will always be non-negative. | 
-**createdAt** | **String** | The time when the refund was created, in RFC 3339 format. | [optional] 
+**receivable_id** | **String** | The ID of the receivable that the refund was applied to. | 
+**refund_id** | **String** | The ID of the refund that is associated to this receivable refund. | 
+**transaction_location_id** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | 
+**amount_money** | [**Money**](Money.md) | The amount of the refund. This will always be non-negative. | 
+**created_at** | **String** | The time when the refund was created, in RFC 3339 format. | [optional] 
 
 

docs/Address.md

@@ -3,20 +3,20 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**addressLine1** | **String** | The first line of the address.  Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields). | [optional] 
-**addressLine2** | **String** | The second line of the address, if any. | [optional] 
-**addressLine3** | **String** | The third line of the address, if any. | [optional] 
+**address_line_1** | **String** | The first line of the address.  Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields). | [optional] 
+**address_line_2** | **String** | The second line of the address, if any. | [optional] 
+**address_line_3** | **String** | The third line of the address, if any. | [optional] 
 **locality** | **String** | The city or town of the address. | [optional] 
 **sublocality** | **String** | A civil region within the address's `locality`, if any. | [optional] 
-**sublocality2** | **String** | A civil region within the address's `sublocality`, if any. | [optional] 
-**sublocality3** | **String** | A civil region within the address's `sublocality_2`, if any. | [optional] 
-**administrativeDistrictLevel1** | **String** | A civil entity within the address's country. In the US, this is the state. | [optional] 
-**administrativeDistrictLevel2** | **String** | A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. | [optional] 
-**administrativeDistrictLevel3** | **String** | A civil entity within the address's `administrative_district_level_2`, if any. | [optional] 
-**postalCode** | **String** | The address's postal code. | [optional] 
+**sublocality_2** | **String** | A civil region within the address's `sublocality`, if any. | [optional] 
+**sublocality_3** | **String** | A civil region within the address's `sublocality_2`, if any. | [optional] 
+**administrative_district_level_1** | **String** | A civil entity within the address's country. In the US, this is the state. | [optional] 
+**administrative_district_level_2** | **String** | A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. | [optional] 
+**administrative_district_level_3** | **String** | A civil entity within the address's `administrative_district_level_2`, if any. | [optional] 
+**postal_code** | **String** | The address's postal code. | [optional] 
 **country** | **String** | The address's country, in ISO 3166-1-alpha-2 format. | [optional] 
-**firstName** | **String** | Optional first name when it's representing recipient. | [optional] 
-**lastName** | **String** | Optional last name when it's representing recipient. | [optional] 
+**first_name** | **String** | Optional first name when it's representing recipient. | [optional] 
+**last_name** | **String** | Optional last name when it's representing recipient. | [optional] 
 **organization** | **String** | Optional organization name when it's representing recipient. | [optional] 
 
 

docs/BatchChangeInventoryRequest.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**idempotencyKey** | **String** | A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. | [optional] 
+**idempotency_key** | **String** | A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. | [optional] 
 **changes** | [**[InventoryChange]**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes. | [optional] 
-**ignoreUnchangedCounts** | **Boolean** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional] 
+**ignore_unchanged_counts** | **Boolean** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional] 
 
 

docs/BatchDeleteCatalogObjectsRequest.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**objectIds** | **[String]** | The IDs of the [CatalogObject](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | [optional] 
+**object_ids** | **[String]** | The IDs of the [CatalogObject](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | [optional] 
 
 

docs/BatchDeleteCatalogObjectsResponse.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
-**deletedObjectIds** | **[String]** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] 
-**deletedAt** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
+**deleted_object_ids** | **[String]** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] 
+**deleted_at** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
 
 

docs/BatchRetrieveCatalogObjectsRequest.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**objectIds** | **[String]** | The IDs of the [CatalogObject](#type-catalogobject)s to be retrieved. | 
-**includeRelatedObjects** | **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] 
+**object_ids** | **[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] 
 
 

docs/BatchRetrieveCatalogObjectsResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
 **objects** | [**[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s returned. | [optional] 
-**relatedObjects** | [**[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. | [optional] 
+**related_objects** | [**[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. | [optional] 
 
 

docs/BatchRetrieveInventoryChangesRequest.md

@@ -3,12 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**catalogObjectIds** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
-**locationIds** | **[String]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
+**catalog_object_ids** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
+**location_ids** | **[String]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
 **types** | **[String]** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional] 
 **states** | **[String]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional] 
-**updatedAfter** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
-**updatedBefore** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
+**updated_after** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
+**updated_before** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
 
 

docs/BatchRetrieveInventoryCountsRequest.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**catalogObjectIds** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
-**locationIds** | **[String]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
-**updatedAfter** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
+**catalog_object_ids** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
+**location_ids** | **[String]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
+**updated_after** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
 
 

docs/BatchRetrieveOrdersRequest.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**orderIds** | **[String]** | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. | 
+**order_ids** | **[String]** | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. |