square_connect 2.20190327.1.292 → 2.20190410.0.296
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +19 -0
- data/README.md +23 -20
- data/docs/BatchRetrieveOrdersRequest.md +1 -1
- data/docs/BatchRetrieveOrdersResponse.md +1 -1
- data/docs/CaptureTransactionRequest.md +1 -1
- data/docs/CaptureTransactionResponse.md +1 -1
- data/docs/ChargeRequest.md +1 -1
- data/docs/ChargeResponse.md +1 -1
- data/docs/CreateCheckoutRequest.md +1 -1
- data/docs/CreateCheckoutResponse.md +1 -1
- data/docs/CreateCustomerCardRequest.md +1 -1
- data/docs/CreateCustomerCardResponse.md +1 -1
- data/docs/CreateCustomerRequest.md +1 -1
- data/docs/CreateCustomerResponse.md +1 -1
- data/docs/CreateMobileAuthorizationCodeRequest.md +1 -1
- data/docs/CreateMobileAuthorizationCodeResponse.md +1 -1
- data/docs/CreateOrderResponse.md +1 -1
- data/docs/CreateRefundRequest.md +1 -1
- data/docs/CreateRefundResponse.md +1 -1
- data/docs/CustomerFilter.md +1 -1
- data/docs/CustomersApi.md +1 -1
- data/docs/DeleteCustomerCardRequest.md +1 -1
- data/docs/DeleteCustomerCardResponse.md +1 -1
- data/docs/DeleteCustomerRequest.md +1 -1
- data/docs/DeleteCustomerResponse.md +1 -1
- data/docs/ListAdditionalRecipientReceivableRefundsRequest.md +1 -1
- data/docs/ListAdditionalRecipientReceivableRefundsResponse.md +1 -1
- data/docs/ListAdditionalRecipientReceivablesRequest.md +1 -1
- data/docs/ListAdditionalRecipientReceivablesResponse.md +1 -1
- data/docs/ListCustomersRequest.md +1 -1
- data/docs/ListCustomersResponse.md +1 -1
- data/docs/ListEmployeesResponse.md +1 -1
- data/docs/ListLocationsRequest.md +1 -1
- data/docs/ListLocationsResponse.md +1 -1
- data/docs/ListRefundsRequest.md +1 -1
- data/docs/ListRefundsResponse.md +1 -1
- data/docs/ListTransactionsRequest.md +1 -1
- data/docs/ListTransactionsResponse.md +1 -1
- data/docs/Order.md +2 -1
- data/docs/OrderSource.md +12 -0
- data/docs/OrdersApi.md +1 -1
- data/docs/RegisterDomainRequest.md +1 -1
- data/docs/RegisterDomainResponse.md +1 -1
- data/docs/RetrieveCustomerRequest.md +1 -1
- data/docs/RetrieveCustomerResponse.md +1 -1
- data/docs/RetrieveEmployeeResponse.md +1 -1
- data/docs/RetrieveTransactionRequest.md +1 -1
- data/docs/RetrieveTransactionResponse.md +1 -1
- data/docs/SearchCustomersRequest.md +1 -1
- data/docs/SearchCustomersResponse.md +1 -1
- data/docs/Transaction.md +1 -1
- data/docs/TransactionsApi.md +3 -3
- data/docs/UpdateCustomerRequest.md +1 -1
- data/docs/UpdateCustomerResponse.md +1 -1
- data/docs/V1Category.md +1 -0
- data/docs/V1Discount.md +1 -0
- data/docs/V1Fee.md +1 -0
- data/docs/V1Item.md +1 -0
- data/docs/V1ModifierList.md +1 -0
- data/docs/V1ModifierOption.md +1 -0
- data/docs/V1Variation.md +1 -0
- data/docs/VoidTransactionRequest.md +1 -1
- data/docs/VoidTransactionResponse.md +1 -1
- data/lib/square_connect/api/apple_pay_api.rb +1 -1
- data/lib/square_connect/api/catalog_api.rb +11 -11
- data/lib/square_connect/api/checkout_api.rb +1 -1
- data/lib/square_connect/api/customers_api.rb +10 -10
- data/lib/square_connect/api/employees_api.rb +2 -2
- data/lib/square_connect/api/inventory_api.rb +7 -7
- data/lib/square_connect/api/labor_api.rb +14 -14
- data/lib/square_connect/api/locations_api.rb +1 -1
- data/lib/square_connect/api/mobile_authorization_api.rb +1 -1
- data/lib/square_connect/api/o_auth_api.rb +3 -3
- data/lib/square_connect/api/orders_api.rb +4 -4
- data/lib/square_connect/api/reporting_api.rb +2 -2
- data/lib/square_connect/api/transactions_api.rb +13 -13
- data/lib/square_connect/api/v1_employees_api.rb +16 -16
- data/lib/square_connect/api/v1_items_api.rb +40 -40
- data/lib/square_connect/api/v1_locations_api.rb +2 -2
- data/lib/square_connect/api/v1_transactions_api.rb +11 -11
- data/lib/square_connect/api_client.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_orders_request.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_orders_response.rb +1 -1
- data/lib/square_connect/models/capture_transaction_request.rb +1 -1
- data/lib/square_connect/models/capture_transaction_response.rb +1 -1
- data/lib/square_connect/models/charge_request.rb +1 -1
- data/lib/square_connect/models/charge_response.rb +1 -1
- data/lib/square_connect/models/create_checkout_request.rb +1 -1
- data/lib/square_connect/models/create_checkout_response.rb +1 -1
- data/lib/square_connect/models/create_customer_card_request.rb +1 -1
- data/lib/square_connect/models/create_customer_card_response.rb +1 -1
- data/lib/square_connect/models/create_customer_request.rb +1 -1
- data/lib/square_connect/models/create_customer_response.rb +1 -1
- data/lib/square_connect/models/create_mobile_authorization_code_request.rb +1 -1
- data/lib/square_connect/models/create_mobile_authorization_code_response.rb +1 -1
- data/lib/square_connect/models/create_order_response.rb +1 -1
- data/lib/square_connect/models/create_refund_request.rb +1 -1
- data/lib/square_connect/models/create_refund_response.rb +1 -1
- data/lib/square_connect/models/customer_filter.rb +1 -1
- data/lib/square_connect/models/delete_customer_card_request.rb +1 -1
- data/lib/square_connect/models/delete_customer_card_response.rb +1 -1
- data/lib/square_connect/models/delete_customer_request.rb +1 -1
- data/lib/square_connect/models/delete_customer_response.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivable_refunds_request.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivable_refunds_response.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivables_request.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivables_response.rb +1 -1
- data/lib/square_connect/models/list_customers_request.rb +1 -1
- data/lib/square_connect/models/list_customers_response.rb +1 -1
- data/lib/square_connect/models/list_employees_response.rb +1 -1
- data/lib/square_connect/models/list_locations_request.rb +1 -1
- data/lib/square_connect/models/list_locations_response.rb +1 -1
- data/lib/square_connect/models/list_refunds_request.rb +1 -1
- data/lib/square_connect/models/list_refunds_response.rb +1 -1
- data/lib/square_connect/models/list_transactions_request.rb +1 -1
- data/lib/square_connect/models/list_transactions_response.rb +1 -1
- data/lib/square_connect/models/order.rb +12 -2
- data/lib/square_connect/models/order_source.rb +186 -0
- data/lib/square_connect/models/register_domain_request.rb +1 -1
- data/lib/square_connect/models/register_domain_response.rb +1 -1
- data/lib/square_connect/models/retrieve_customer_request.rb +1 -1
- data/lib/square_connect/models/retrieve_customer_response.rb +1 -1
- data/lib/square_connect/models/retrieve_employee_response.rb +1 -1
- data/lib/square_connect/models/retrieve_transaction_request.rb +1 -1
- data/lib/square_connect/models/retrieve_transaction_response.rb +1 -1
- data/lib/square_connect/models/search_customers_request.rb +1 -1
- data/lib/square_connect/models/search_customers_response.rb +1 -1
- data/lib/square_connect/models/transaction.rb +1 -1
- data/lib/square_connect/models/update_customer_request.rb +1 -1
- data/lib/square_connect/models/update_customer_response.rb +1 -1
- data/lib/square_connect/models/v1_category.rb +14 -4
- data/lib/square_connect/models/v1_discount.rb +14 -4
- data/lib/square_connect/models/v1_fee.rb +14 -4
- data/lib/square_connect/models/v1_item.rb +14 -4
- data/lib/square_connect/models/v1_modifier_list.rb +14 -4
- data/lib/square_connect/models/v1_modifier_option.rb +14 -4
- data/lib/square_connect/models/v1_variation.rb +14 -4
- data/lib/square_connect/models/void_transaction_request.rb +1 -1
- data/lib/square_connect/models/void_transaction_response.rb +1 -1
- data/lib/square_connect/version.rb +1 -1
- data/lib/square_connect.rb +1 -0
- data/spec/models/order_source_spec.rb +39 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b2450063f72e616ae4939283a138f183d1edd781fbd7c810fbc212101370422e
|
|
4
|
+
data.tar.gz: ecdc9aa1826d901a3a6862135024df8e2c85cbdf5e8ab9ab3b2a097cdf7d769c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7179b19c5f3fc30c7340c6cc74b9c4f9c6ede70b2219c2b8585f9b52bc0a565f9e35146f6a9b811433fddfdec9b7082bd3a194eb45b1e5667b89324639ae57aa
|
|
7
|
+
data.tar.gz: fd5f822624a0c63401a9831ce0daf360bcafe3496be19b8e0a393f11caac577f9fc496ca18a15366b2a9458be2b2fbef1b58feb5544df051a5a55be8d1589055
|
data/CHANGES.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
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
|
+
|
|
3
22
|
## Version 2.20190327.1 (2019-03-29)
|
|
4
23
|
|
|
5
24
|
## Bug Fix: Catalog API
|
data/README.md
CHANGED
|
@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
|
|
|
10
10
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
11
11
|
|
|
12
12
|
- API version: 2.0
|
|
13
|
-
- Package version: 2.
|
|
13
|
+
- Package version: 2.20190410.0
|
|
14
14
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
15
15
|
|
|
16
16
|
For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
|
|
@@ -373,6 +373,7 @@ Class | Method | HTTP request | Description
|
|
|
373
373
|
- [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
|
|
374
374
|
- [SquareConnect::OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md)
|
|
375
375
|
- [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
|
|
376
|
+
- [SquareConnect::OrderSource](docs/OrderSource.md)
|
|
376
377
|
- [SquareConnect::Product](docs/Product.md)
|
|
377
378
|
- [SquareConnect::Refund](docs/Refund.md)
|
|
378
379
|
- [SquareConnect::RefundStatus](docs/RefundStatus.md)
|
|
@@ -616,25 +617,27 @@ Class | Method | HTTP request | Description
|
|
|
616
617
|
- **Flow**: accessCode
|
|
617
618
|
- **Authorization URL**: `https://connect.squareup.com/oauth2/authorize`
|
|
618
619
|
- **Scopes**:
|
|
619
|
-
-
|
|
620
|
-
-
|
|
621
|
-
-
|
|
622
|
-
-
|
|
623
|
-
-
|
|
624
|
-
-
|
|
625
|
-
-
|
|
626
|
-
- ITEMS_READ: GET
|
|
627
|
-
- ITEMS_WRITE: POST
|
|
628
|
-
-
|
|
629
|
-
-
|
|
630
|
-
-
|
|
631
|
-
-
|
|
632
|
-
-
|
|
633
|
-
-
|
|
634
|
-
-
|
|
635
|
-
-
|
|
636
|
-
-
|
|
637
|
-
-
|
|
620
|
+
- 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.
|
|
621
|
+
- CUSTOMERS_READ: __HTTP Method__: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint.
|
|
622
|
+
- CUSTOMERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles.
|
|
623
|
+
- EMPLOYEES_READ: __HTTP Method__: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
|
|
624
|
+
- EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles.
|
|
625
|
+
- INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
|
|
626
|
+
- INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
|
|
627
|
+
- ITEMS_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
|
|
628
|
+
- ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog.
|
|
629
|
+
- MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
|
|
630
|
+
- ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
|
|
631
|
+
- ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint.
|
|
632
|
+
- PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
|
|
633
|
+
- 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.
|
|
634
|
+
- 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.
|
|
635
|
+
- PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process in-person payments.
|
|
636
|
+
- SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
|
|
637
|
+
- TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint.
|
|
638
|
+
- TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard information. For example, to create and modify timecards.
|
|
639
|
+
- TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
|
|
640
|
+
- TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
|
|
638
641
|
|
|
639
642
|
### oauth2ClientSecret
|
|
640
643
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the CaptureTransaction endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/ChargeRequest.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the parameters that can be included in the body of a request to the
|
|
5
|
+
Defines the parameters that can be included in the body of a request to the Charge endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/ChargeResponse.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the parameters that can be included in the body of a request to the
|
|
5
|
+
Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the CreateCheckout endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the request body of a request to the
|
|
5
|
+
Defines the fields that are included in the request body of a request to the CreateCustomerCard endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the body parameters that can be provided in a request to the
|
|
5
|
+
Defines the body parameters that can be provided in a request to the CreateCustomer endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the body parameters that can be provided in a request to the
|
|
5
|
+
Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/CreateOrderResponse.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/CreateRefundRequest.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the body parameters that can be included in a request to the
|
|
5
|
+
Defines the body parameters that can be included in a request to the CreateRefund endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/CustomerFilter.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/CustomersApi.md
CHANGED
|
@@ -394,7 +394,7 @@ Name | Type | Description | Notes
|
|
|
394
394
|
|
|
395
395
|
UpdateCustomer
|
|
396
396
|
|
|
397
|
-
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.
|
|
397
|
+
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.
|
|
398
398
|
|
|
399
399
|
### Example
|
|
400
400
|
```ruby
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the DeleteCustomerCard endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the DeleteCustomer endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the query parameters that can be included in a request to the
|
|
5
|
+
Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the query parameters that can be included in a request to the
|
|
5
|
+
Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the query parameters that can be provided in a request to the
|
|
5
|
+
Defines the query parameters that can be provided in a request to the ListCustomers endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/ListRefundsRequest.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the query parameters that can be included in a request to the
|
|
5
|
+
Defines the query parameters that can be included in a request to the ListRefunds endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/ListRefundsResponse.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
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).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the query parameters that can be included in a request to the
|
|
5
|
+
Defines the query parameters that can be included in a request to the ListTransactions endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the ListTransactions endpoint. One of `errors` or `transactions` is present in a given response (never both).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
data/docs/Order.md
CHANGED
|
@@ -7,9 +7,10 @@ Contains all information related to a single order to process with Square, inclu
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
9
9
|
------------ | ------------- | ------------- | -------------
|
|
10
|
-
**id** | **String** | The order's unique ID. This value is only present for Order objects created by the Orders API through the [CreateOrder](#endpoint-createorder) endpoint. | [optional]
|
|
10
|
+
**id** | **String** | The order's unique ID. This value is only present for Order objects created by the Orders API through the [CreateOrder](#endpoint-orders-createorder) endpoint. | [optional]
|
|
11
11
|
**location_id** | **String** | The ID of the merchant location this order is associated with. |
|
|
12
12
|
**reference_id** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional]
|
|
13
|
+
**source** | [**OrderSource**](OrderSource.md) | The origination details of the order. | [optional]
|
|
13
14
|
**line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. | [optional]
|
|
14
15
|
**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list. | [optional]
|
|
15
16
|
**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list. | [optional]
|
data/docs/OrderSource.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# SquareConnect::OrderSource
|
|
2
|
+
|
|
3
|
+
### Description
|
|
4
|
+
|
|
5
|
+
Represents the origination details of an order.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
Name | Type | Description | Notes
|
|
9
|
+
------------ | ------------- | ------------- | -------------
|
|
10
|
+
**name** | **String** | The name used to identify the place (physical or digital) that an order originates. If unset, the name defaults to the name of the application that created the order. | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/OrdersApi.md
CHANGED
|
@@ -68,7 +68,7 @@ Name | Type | Description | Notes
|
|
|
68
68
|
|
|
69
69
|
CreateOrder
|
|
70
70
|
|
|
71
|
-
Creates an [Order](#type-order) that can then be referenced as `order_id` in a request to the [Charge](#endpoint-charge) endpoint. Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase. To associate a created order with a request to the Charge endpoint, provide the order's `id` in the `order_id` field of your request. You cannot modify an order after you create it. If you need to modify an order, instead create a new order with modified details. To learn more about the Orders API, see the [Orders API Overview](/products/orders/overview).
|
|
71
|
+
Creates an [Order](#type-order) that can then be referenced as `order_id` in a request to the [Charge](#endpoint-transactions-charge) endpoint. Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase. To associate a created order with a request to the Charge endpoint, provide the order's `id` in the `order_id` field of your request. You cannot modify an order after you create it. If you need to modify an order, instead create a new order with modified details. To learn more about the Orders API, see the [Orders API Overview](/products/orders/overview).
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
```ruby
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the parameters that can be included in the body of a request to the
|
|
5
|
+
Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the RegisterDomain endpoint. Either `errors` or `status` will be present in a given response (never both).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the RetrieveCustomer endpoint. One of `errors` or `customer` is present in a given response (never both).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the RetrieveTransaction endpoint. One of `errors` or `transaction` is present in a given response (never both).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields included in the request body for the
|
|
5
|
+
Defines the fields included in the request body for the SearchCustomers endpoint.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Defines the fields that are included in the response body of a request to the
|
|
5
|
+
Defines the fields that are included in the response body of a request to the SearchCustomers endpoint. One of `errors` or `customers` is present in a given response (never both).
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|