Release 2.20190410.0 (#93)

Author: ssung88

CHANGES.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## Version 2.20190410.0 (2019-04-10)
+
+## New features: Orders API beta
+
+* The Connect v2 Orders object now includes an OrderSource field (`source`)
+  that encapsulates the origination details of an order.
+
+## Improvement: Connect v2 Catalog IDs in Connect v1 objects
+
+* The following Connect v1 data types now include a `v2_id` field that makes it
+  easier to link information from Connect v1 endpoints to related Connect v2
+  Catalog objects:
+  * V1Discount
+  * V1Fee
+  * V1Item
+  * V1ModifierList
+  * V1ModifierOption
+  * V1Variation
+
 ## Version 2.20190327.1 (2019-03-29)
 
 ## Bug Fix: Catalog API

README.md

@@ -370,6 +370,7 @@ Class | Method | HTTP request
  - [OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
  - [OrderLineItemModifier](docs/OrderLineItemModifier.md)
  - [OrderLineItemTax](docs/OrderLineItemTax.md)
+ - [OrderSource](docs/OrderSource.md)
  - [Refund](docs/Refund.md)
  - [RegisterDomainRequest](docs/RegisterDomainRequest.md)
  - [RegisterDomainResponse](docs/RegisterDomainResponse.md)
@@ -644,25 +645,27 @@ Class | Method | HTTP request
 - **Flow**: accessCode
 - **Authorization URL**: `https://connect.squareup.com/oauth2/authorize`
 - **Scopes**: 
- - **MERCHANT_PROFILE_READ**: GET endpoints related to a merchant's business and location entities. Almost all Connect API applications need this permission in order to obtain a merchant's location IDs
- - **PAYMENTS_READ**: GET endpoints related to transactions and refunds
- - **PAYMENTS_WRITE**: POST, PUT, and DELETE endpoints related to transactions and refunds. E-commerce applications must request this permission
- - **CUSTOMERS_READ**:  GET endpoints related to customer management
- - **CUSTOMERS_WRITE**: POST, PUT, and DELETE endpoints related to customer management
- - **SETTLEMENTS_READ**: GET endpoints related to settlements (deposits)
- - **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 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
- - **TIMECARDS_WRITE**: POST, PUT, and DELETE endpoints related to employee timecards
- - **PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS**: Allow third party applications to deduct a portion of each transaction amount.
- - **PAYMENTS_WRITE_IN_PERSON**: POST, PUT, and DELETE endpoints. Grants write access to transaction and refunds information.
- - **INVENTORY_READ**: GET endpoints related to a merchant's inventory
- - **INVENTORY_WRITE**: POST, PUT, and DELETE endpoints related to a merchant's inventory
+ - **BANK_ACCOUNTS_READ**: __HTTP Method__: `GET`  Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint.
+ - **CUSTOMERS_READ**: __HTTP Method__: `GET`  Grants read access to customer information. For example, to call the ListCustomers endpoint.
+ - **CUSTOMERS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to customer information. For example, to create and update customer profiles.
+ - **EMPLOYEES_READ**: __HTTP Method__: `GET`  Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
+ - **EMPLOYEES_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to employee profile information. For example, to create and modify employee profiles.
+ - **INVENTORY_READ**: __HTTP Method__: `GET`  Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
+ - **INVENTORY_WRITE**: __HTTP Method__:  `POST`, `PUT`, `DELETE`  Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
+ - **ITEMS_READ**: __HTTP Method__: `GET`  Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
+ - **ITEMS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to product catalog information. For example, to modify or add to a product catalog.
+ - **MERCHANT_PROFILE_READ**: __HTTP Method__: `GET`  Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
+ - **ORDERS_READ**: __HTTP Method__: `GET`  Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
+ - **ORDERS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to order information. For example, to call the CreateCheckout endpoint.
+ - **PAYMENTS_READ**: __HTTP Method__: `GET`  Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
+ - **PAYMENTS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to transaction and refunds information. For example, to process payments with the Transactions or Checkout API.
+ - **PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Transactions API.
+ - **PAYMENTS_WRITE_IN_PERSON**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to transaction and refunds information. For example, to process in-person payments.
+ - **SETTLEMENTS_READ**: __HTTP Method__: `GET`  Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
+ - **TIMECARDS_READ**: __HTTP Method__: `GET`  Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint.
+ - **TIMECARDS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to employee timecard information. For example, to create and modify timecards.
+ - **TIMECARDS_SETTINGS_READ**: __HTTP Method__: `GET`  Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
+ - **TIMECARDS_SETTINGS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE`  Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
 
 ## oauth2ClientSecret
 

docs/BatchRetrieveOrdersRequest.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-
+Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.
 
 ## Properties
 Name | Type | Description | Notes

docs/BatchRetrieveOrdersResponse.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-Defines the fields that are included in the response body of a request to the [BatchRetrieveOrders](#endpoint-batchretrieveorders) endpoint.
+Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint.
 
 ## Properties
 Name | Type | Description | Notes

docs/CaptureTransactionRequest.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-
+Defines the query parameters for calls to the CaptureTransaction endpoint.
 
 ## Properties
 Name | Type | Description | Notes

docs/CaptureTransactionResponse.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
+Defines the fields that are included in the response body of a request to the CaptureTransaction endpoint.
 
 ## Properties
 Name | Type | Description | Notes

docs/ChargeRequest.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint.
+Defines the parameters that can be included in the body of a request to the Charge endpoint.
 
 ## Properties
 Name | Type | Description | Notes

docs/ChargeResponse.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-Defines the fields that are included in the response body of a request to the [Charge](#endpoint-charge) endpoint.  One of `errors` or `transaction` is present in a given response (never both).
+Defines the fields that are included in the response body of a request to the Charge endpoint.  One of `errors` or `transaction` is present in a given response (never both).
 
 ## Properties
 Name | Type | Description | Notes

docs/CreateCheckoutRequest.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
+Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint.
 
 ## Properties
 Name | Type | Description | Notes

docs/CreateCheckoutResponse.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
+Defines the fields that are included in the response body of a request to the CreateCheckout endpoint.
 
 ## Properties
 Name | Type | Description | Notes