Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Commit d8a6cc7

Browse files
authored
Release 2.17.0 (#113)
1 parent 2dbed68 commit d8a6cc7

File tree

143 files changed

+687
-313
lines changed

Some content is hidden

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

143 files changed

+687
-313
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ install:
1212

1313
script:
1414
- export frameworkVersion=netstandard2.0
15-
- export releaseVersion="2.16.1"
15+
- export releaseVersion="2.17.0"
1616
- /bin/sh ./mono_nunit_test.sh
1717

1818
after_success:

CHANGES.md

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

3+
## Version 2.17.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.16.1 (2019-03-29)
423

524
## Bug Fix: Catalog API

README.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,7 @@ Class | Method | HTTP request
372372
- [Model.OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
373373
- [Model.OrderLineItemModifier](docs/OrderLineItemModifier.md)
374374
- [Model.OrderLineItemTax](docs/OrderLineItemTax.md)
375+
- [Model.OrderSource](docs/OrderSource.md)
375376
- [Model.Refund](docs/Refund.md)
376377
- [Model.RegisterDomainRequest](docs/RegisterDomainRequest.md)
377378
- [Model.RegisterDomainResponse](docs/RegisterDomainResponse.md)
@@ -563,25 +564,27 @@ Class | Method | HTTP request
563564
- **Flow**: accessCode
564565
- **Authorization URL**: `https://connect.squareup.com/oauth2/authorize`
565566
- **Scopes**:
566-
- 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
567-
- PAYMENTS_READ: GET endpoints related to transactions and refunds
568-
- PAYMENTS_WRITE: POST, PUT, and DELETE endpoints related to transactions and refunds. E-commerce applications must request this permission
569-
- CUSTOMERS_READ: GET endpoints related to customer management
570-
- CUSTOMERS_WRITE: POST, PUT, and DELETE endpoints related to customer management
571-
- SETTLEMENTS_READ: GET endpoints related to settlements (deposits)
572-
- BANK_ACCOUNTS_READ: GET endpoints related to a merchant's bank accounts
573-
- ITEMS_READ: GET endpoints related to a merchant's item library
574-
- ITEMS_WRITE: POST, PUT, and DELETE endpoints related to a merchant's item library
575-
- ORDERS_READ: GET endpoints related to a merchant's orders
576-
- ORDERS_WRITE: POST, PUT, and DELETE endpoints related to a merchant's orders
577-
- EMPLOYEES_READ: GET endpoints related to employee management
578-
- EMPLOYEES_WRITE: POST, PUT, and DELETE endpoints related to employee management
579-
- TIMECARDS_READ: GET endpoints related to employee timecards
580-
- TIMECARDS_WRITE: POST, PUT, and DELETE endpoints related to employee timecards
581-
- PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: Allow third party applications to deduct a portion of each transaction amount.
582-
- PAYMENTS_WRITE_IN_PERSON: POST, PUT, and DELETE endpoints. Grants write access to transaction and refunds information.
583-
- INVENTORY_READ: GET endpoints related to a merchant's inventory
584-
- INVENTORY_WRITE: POST, PUT, and DELETE endpoints related to a merchant's inventory
567+
- 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.
568+
- CUSTOMERS_READ: __HTTP Method__: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint.
569+
- CUSTOMERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles.
570+
- EMPLOYEES_READ: __HTTP Method__: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
571+
- EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles.
572+
- INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
573+
- INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
574+
- ITEMS_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
575+
- ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog.
576+
- MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
577+
- ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
578+
- ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint.
579+
- PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
580+
- 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.
581+
- 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.
582+
- PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process in-person payments.
583+
- SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
584+
- TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint.
585+
- TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard information. For example, to create and modify timecards.
586+
- TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
587+
- TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
585588

586589
<a name="oauth2ClientSecret"></a>
587590
### oauth2ClientSecret

docs/BatchRetrieveOrdersRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
5+
Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.
66

77
## Properties
88

docs/BatchRetrieveOrdersResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CaptureTransactionRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
5+
Defines the query parameters for calls to the CaptureTransaction endpoint.
66

77
## Properties
88

docs/CaptureTransactionResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ChargeRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ChargeResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/CreateCheckoutRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateCheckoutResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateCustomerCardRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateCustomerCardResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/CreateCustomerRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateCustomerResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/CreateMobileAuthorizationCodeRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateMobileAuthorizationCodeResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateOrderResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/CreateRefundRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CreateRefundResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/CustomerFilter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/CustomersApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ Name | Type | Description | Notes
483483
484484
UpdateCustomer
485485

486-
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.
486+
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.
487487

488488
### Example
489489
```csharp

docs/DeleteCustomerCardRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
5+
Defines the fields that are included in requests to the DeleteCustomerCard endpoint.
66

77
## Properties
88

docs/DeleteCustomerCardResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/DeleteCustomerRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
5+
Defines the fields that are included in a request to the DeleteCustomer endpoint.
66

77
## Properties
88

docs/DeleteCustomerResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ListAdditionalRecipientReceivableRefundsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ListAdditionalRecipientReceivableRefundsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/ListAdditionalRecipientReceivablesRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ListAdditionalRecipientReceivablesResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/ListCustomersRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ListCustomersResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/ListEmployeesResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/ListLocationsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
5+
Defines the fields that are included in requests to the ListLocations endpoint.
66

77
## Properties
88

docs/ListLocationsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

docs/ListRefundsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

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

77
## Properties
88

docs/ListRefundsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Description
44

5-
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).
5+
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).
66

77
## Properties
88

0 commit comments

Comments
 (0)