Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 2.0
- Package version: 2.20190327.1
- Package version: 2.20190410.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen

For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
Expand Down Expand Up @@ -373,6 +373,7 @@ Class | Method | HTTP request | Description
- [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
- [SquareConnect::OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md)
- [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
- [SquareConnect::OrderSource](docs/OrderSource.md)
- [SquareConnect::Product](docs/Product.md)
- [SquareConnect::Refund](docs/Refund.md)
- [SquareConnect::RefundStatus](docs/RefundStatus.md)
Expand Down Expand Up @@ -616,25 +617,27 @@ Class | Method | HTTP request | Description
- **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

Expand Down
2 changes: 1 addition & 1 deletion docs/BatchRetrieveOrdersRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description


Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/BatchRetrieveOrdersResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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
Expand Down
2 changes: 1 addition & 1 deletion docs/CaptureTransactionRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description


Defines the query parameters for calls to the CaptureTransaction endpoint.

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CaptureTransactionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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
Expand Down
2 changes: 1 addition & 1 deletion docs/ChargeRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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
Expand Down
2 changes: 1 addition & 1 deletion docs/ChargeResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateCheckoutRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateCheckoutResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,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
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateCustomerCardRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateCustomerCardResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateCustomerRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateCustomerResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateMobileAuthorizationCodeRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateMobileAuthorizationCodeResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateOrderResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateRefundRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateRefundResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CustomerFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/CustomersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ Name | Type | Description | Notes

UpdateCustomer

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.
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.

### Example
```ruby
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteCustomerCardRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description


Defines the fields that are included in requests to the DeleteCustomerCard endpoint.

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteCustomerCardResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteCustomerRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description


Defines the fields that are included in a request to the DeleteCustomer endpoint.

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteCustomerResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListAdditionalRecipientReceivableRefundsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListAdditionalRecipientReceivableRefundsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListAdditionalRecipientReceivablesRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListAdditionalRecipientReceivablesResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListCustomersRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListCustomersResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListEmployeesResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListLocationsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description


Defines the fields that are included in requests to the ListLocations endpoint.

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListLocationsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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).
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).

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/ListRefundsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

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

## Properties
Name | Type | Description | Notes
Expand Down
Loading