Skip to content

Commit 6b507a2

Browse files
ssung88ssung88
authored
Release 2.20190410.0 (square#93)
1 parent 9f993bb commit 6b507a2

File tree

96 files changed

+660
-237
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+660
-237
lines changed

‎CHANGES.md

+19
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Change Log
22

3+
## Version 2.20190410.0 (2019-04-10)
4+
5+
## New features: Orders API beta
6+
7+
* The Connect v2 Orders object now includes an OrderSource field (`source`)
8+
that encapsulates the origination details of an order.
9+
10+
## Improvement: Connect v2 Catalog IDs in Connect v1 objects
11+
12+
* The following Connect v1 data types now include a `v2_id` field that makes it
13+
easier to link information from Connect v1 endpoints to related Connect v2
14+
Catalog objects:
15+
* V1Discount
16+
* V1Fee
17+
* V1Item
18+
* V1ModifierList
19+
* V1ModifierOption
20+
* V1Variation
21+
322
## Version 2.20190327.1 (2019-03-29)
423

524
## Bug Fix: Catalog API

‎README.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ Class | Method | HTTP request
370370
- [OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
371371
- [OrderLineItemModifier](docs/OrderLineItemModifier.md)
372372
- [OrderLineItemTax](docs/OrderLineItemTax.md)
373+
- [OrderSource](docs/OrderSource.md)
373374
- [Refund](docs/Refund.md)
374375
- [RegisterDomainRequest](docs/RegisterDomainRequest.md)
375376
- [RegisterDomainResponse](docs/RegisterDomainResponse.md)
@@ -644,25 +645,27 @@ Class | Method | HTTP request
644645
- **Flow**: accessCode
645646
- **Authorization URL**: `https://connect.squareup.com/oauth2/authorize`
646647
- **Scopes**:
647-
- **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
648-
- **PAYMENTS_READ**: GET endpoints related to transactions and refunds
649-
- **PAYMENTS_WRITE**: POST, PUT, and DELETE endpoints related to transactions and refunds. E-commerce applications must request this permission
650-
- **CUSTOMERS_READ**: GET endpoints related to customer management
651-
- **CUSTOMERS_WRITE**: POST, PUT, and DELETE endpoints related to customer management
652-
- **SETTLEMENTS_READ**: GET endpoints related to settlements (deposits)
653-
- **BANK_ACCOUNTS_READ**: GET endpoints related to a merchant's bank accounts
654-
- **ITEMS_READ**: GET endpoints related to a merchant's item library
655-
- **ITEMS_WRITE**: POST, PUT, and DELETE endpoints related to a merchant's item library
656-
- **ORDERS_READ**: GET endpoints related to a merchant's orders
657-
- **ORDERS_WRITE**: POST, PUT, and DELETE endpoints related to a merchant's orders
658-
- **EMPLOYEES_READ**: GET endpoints related to employee management
659-
- **EMPLOYEES_WRITE**: POST, PUT, and DELETE endpoints related to employee management
660-
- **TIMECARDS_READ**: GET endpoints related to employee timecards
661-
- **TIMECARDS_WRITE**: POST, PUT, and DELETE endpoints related to employee timecards
662-
- **PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS**: Allow third party applications to deduct a portion of each transaction amount.
663-
- **PAYMENTS_WRITE_IN_PERSON**: POST, PUT, and DELETE endpoints. Grants write access to transaction and refunds information.
664-
- **INVENTORY_READ**: GET endpoints related to a merchant's inventory
665-
- **INVENTORY_WRITE**: POST, PUT, and DELETE endpoints related to a merchant's inventory
648+
- **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.
649+
- **CUSTOMERS_READ**: __HTTP Method__: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint.
650+
- **CUSTOMERS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles.
651+
- **EMPLOYEES_READ**: __HTTP Method__: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
652+
- **EMPLOYEES_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles.
653+
- **INVENTORY_READ**: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
654+
- **INVENTORY_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
655+
- **ITEMS_READ**: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
656+
- **ITEMS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog.
657+
- **MERCHANT_PROFILE_READ**: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
658+
- **ORDERS_READ**: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
659+
- **ORDERS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint.
660+
- **PAYMENTS_READ**: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
661+
- **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.
662+
- **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.
663+
- **PAYMENTS_WRITE_IN_PERSON**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process in-person payments.
664+
- **SETTLEMENTS_READ**: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
665+
- **TIMECARDS_READ**: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint.
666+
- **TIMECARDS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard information. For example, to create and modify timecards.
667+
- **TIMECARDS_SETTINGS_READ**: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
668+
- **TIMECARDS_SETTINGS_WRITE**: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
666669

667670
## oauth2ClientSecret
668671

‎docs/BatchRetrieveOrdersRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
6+
Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/BatchRetrieveOrdersResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [BatchRetrieveOrders](#endpoint-batchretrieveorders) endpoint.
6+
Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CaptureTransactionRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
6+
Defines the query parameters for calls to the CaptureTransaction endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CaptureTransactionResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
6+
Defines the fields that are included in the response body of a request to the CaptureTransaction endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ChargeRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint.
6+
Defines the parameters that can be included in the body of a request to the Charge endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ChargeResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
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).
6+
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).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateCheckoutRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
6+
Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateCheckoutResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
6+
Defines the fields that are included in the response body of a request to the CreateCheckout endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateCustomerCardRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the request body of a request to the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
6+
Defines the fields that are included in the request body of a request to the CreateCustomerCard endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateCustomerCardResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. One of `errors` or `card` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the CreateCustomerCard endpoint. One of `errors` or `card` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateCustomerRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the body parameters that can be provided in a request to the [CreateCustomer](#endpoint-createcustomer) endpoint.
6+
Defines the body parameters that can be provided in a request to the CreateCustomer endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateCustomerResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CreateCustomer](#endpoint-createcustomer) endpoint. One of `errors` or `customer` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the CreateCustomer endpoint. One of `errors` or `customer` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateMobileAuthorizationCodeRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the body parameters that can be provided in a request to the [CreateMobileAuthorizationCode](#endpoint-createmobileauthorizationcode) endpoint.
6+
Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateMobileAuthorizationCodeResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CreateMobileAuthorizationCode](#endpoint-createmobileauthorizationcode) endpoint.
6+
Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateOrderResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CreateOrder](#endpoint-createorder) endpoint. One of `errors` or `order` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the CreateOrder endpoint. One of `errors` or `order` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateRefundRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the body parameters that can be included in a request to the [CreateRefund](#endpoint-createrefund) endpoint.
6+
Defines the body parameters that can be included in a request to the CreateRefund endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CreateRefundResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [CreateRefund](#endpoint-createrefund) endpoint. One of `errors` or `refund` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the CreateRefund endpoint. One of `errors` or `refund` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CustomerFilter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Represents a set of [`CustomerQuery`](#type-customerquery) filters used to limit the set of Customers returned by [`SearchCustomers`](#endpoint-seachcustomers).
6+
Represents a set of [`CustomerQuery`](#type-customerquery) filters used to limit the set of Customers returned by [`SearchCustomers`](#endpoint-customers-seachcustomers).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/CustomersApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
186186
187187
### Description
188188

189-
Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
189+
Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint.
190190

191191
### Parameters
192192

‎docs/DeleteCustomerCardRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
6+
Defines the fields that are included in requests to the DeleteCustomerCard endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/DeleteCustomerCardResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint.
6+
Defines the fields that are included in the response body of a request to the DeleteCustomerCard endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/DeleteCustomerRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
6+
Defines the fields that are included in a request to the DeleteCustomer endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/DeleteCustomerResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [DeleteCustomer](#endpoint-deletecustomer) endpoint.
6+
Defines the fields that are included in the response body of a request to the DeleteCustomer endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListAdditionalRecipientReceivableRefundsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint.
6+
Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListAdditionalRecipientReceivableRefundsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivableRefunds endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListAdditionalRecipientReceivablesRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint.
6+
Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListAdditionalRecipientReceivablesResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivables endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListCustomersRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the query parameters that can be provided in a request to the [ListCustomers](#endpoint-listcustomers) endpoint.
6+
Defines the query parameters that can be provided in a request to the ListCustomers endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListCustomersResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [ListCustomers](#endpoint-listcustomers) endpoint. One of `errors` or `customers` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the ListCustomers endpoint. One of `errors` or `customers` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListEmployeesResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [ListEmployees](#endpoint-listemployees) endpoint. One of `errors` or `employees` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListLocationsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
6+
Defines the fields that are included in requests to the ListLocations endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListLocationsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [ListLocations](#endpoint-listlocations) endpoint. One of `errors` or `locations` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the ListLocations endpoint. One of `errors` or `locations` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListRefundsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the query parameters that can be included in a request to the [ListRefunds](#endpoint-listrefunds) endpoint.
6+
Defines the query parameters that can be included in a request to the ListRefunds endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListRefundsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the fields that are included in the response body of a request to the [ListRefunds](#endpoint-listrefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both).
6+
Defines the fields that are included in the response body of a request to the ListRefunds endpoint. One of `errors` or `refunds` is present in a given response (never both).
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ListTransactionsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
Defines the query parameters that can be included in a request to the [ListTransactions](#endpoint-listtransactions) endpoint.
6+
Defines the query parameters that can be included in a request to the ListTransactions endpoint.
77

88
## Properties
99
Name | Type | Description | Notes

0 commit comments

Comments
 (0)