square_connect 2.8.0.215 → 2.9.0.220
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +20 -0
- data/README.md +11 -1
- data/docs/Customer.md +1 -0
- data/docs/CustomerCreationSource.md +30 -0
- data/docs/CustomerCreationSourceFilter.md +13 -0
- data/docs/CustomerFilter.md +14 -0
- data/docs/CustomerInclusionExclusion.md +13 -0
- data/docs/CustomerQuery.md +13 -0
- data/docs/CustomerSort.md +13 -0
- data/docs/CustomersApi.md +57 -4
- data/docs/ErrorCode.md +2 -0
- data/docs/ListCustomersRequest.md +2 -2
- data/docs/OrderLineItem.md +1 -1
- data/docs/OrderLineItemDiscountScope.md +1 -1
- data/docs/SearchCustomersRequest.md +14 -0
- data/docs/SearchCustomersResponse.md +14 -0
- data/docs/TimeRange.md +13 -0
- data/docs/V1AdjustInventoryRequest.md +1 -1
- data/docs/V1Payment.md +1 -1
- data/docs/VoidTransactionResponse.md +1 -1
- data/lib/square_connect.rb +9 -0
- data/lib/square_connect/api/customers_api.rb +57 -4
- data/lib/square_connect/api_client.rb +1 -1
- data/lib/square_connect/models/customer.rb +47 -4
- data/lib/square_connect/models/customer_creation_source.rb +36 -0
- data/lib/square_connect/models/customer_creation_source_filter.rb +231 -0
- data/lib/square_connect/models/customer_filter.rb +206 -0
- data/lib/square_connect/models/customer_inclusion_exclusion.rb +19 -0
- data/lib/square_connect/models/customer_query.rb +196 -0
- data/lib/square_connect/models/customer_sort.rb +241 -0
- data/lib/square_connect/models/error.rb +2 -2
- data/lib/square_connect/models/error_code.rb +2 -0
- data/lib/square_connect/models/list_customers_request.rb +2 -2
- data/lib/square_connect/models/order_line_item.rb +1 -1
- data/lib/square_connect/models/search_customers_request.rb +206 -0
- data/lib/square_connect/models/search_customers_response.rb +210 -0
- data/lib/square_connect/models/time_range.rb +196 -0
- data/lib/square_connect/models/v1_adjust_inventory_request.rb +34 -1
- data/lib/square_connect/models/void_transaction_response.rb +1 -1
- data/lib/square_connect/version.rb +1 -1
- data/spec/models/customer_creation_source_filter_spec.rb +53 -0
- data/spec/models/customer_creation_source_spec.rb +33 -0
- data/spec/models/customer_filter_spec.rb +51 -0
- data/spec/models/customer_inclusion_exclusion_spec.rb +33 -0
- data/spec/models/customer_query_spec.rb +45 -0
- data/spec/models/customer_sort_spec.rb +53 -0
- data/spec/models/search_customers_request_spec.rb +51 -0
- data/spec/models/search_customers_response_spec.rb +51 -0
- data/spec/models/time_range_spec.rb +45 -0
- metadata +39 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 04e3219ad0e1aef68b541ca42af2664fac301fee36b81deae8051ae1510ab301
|
4
|
+
data.tar.gz: a5fb3e4eabbe0e4da0b881589ad59be4013614370e308a7fb69dfc3d0bd877e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0d14a0751b4165ac83279ffc9a5805f712042aafd7e55ea6d38d7d9bac3c990b5f8a05551d1609abf25a20e50953e4cd73141df3715cdc9ed0e1fa6f86b1d298
|
7
|
+
data.tar.gz: c2b9ed079ac339731ad78c1855a90f4df67712befcaa092b61c7aaf14133f90f5d2aec43395cacafa73a941ff5c27ba56865e34981a0638820099bc387c3b2f4
|
data/CHANGES.md
CHANGED
@@ -1,5 +1,25 @@
|
|
1
1
|
# Change Log
|
2
2
|
|
3
|
+
## Version 2.9.0 (2018-06-28)
|
4
|
+
|
5
|
+
We have added search functionality to the Connect v2 Customer API.
|
6
|
+
|
7
|
+
### New features and Improvements: Customer API (Connect v2)
|
8
|
+
|
9
|
+
* `SearchCustomers` endpoint — retrieves groups of customer profiles
|
10
|
+
based on a related characteristic. For example, retrieving all customers
|
11
|
+
created in the past 24 hours.
|
12
|
+
* `creation_source` field is now available on `Customer` entities. The creation
|
13
|
+
source exposes the process that created a customer profile. For example, if
|
14
|
+
a customer is created using the API, the creation source will be
|
15
|
+
`THIRD_PARTY`.
|
16
|
+
* **Instant Profiles** are now exposed in the following endpoints:
|
17
|
+
`RetrieveCustomer`, `SearchCustomers`, `UpdateCustomer`, `DeleteCustomer`.
|
18
|
+
|
19
|
+
### Fixes: Inventory SDK (Connect v1)
|
20
|
+
|
21
|
+
* Fix SDK request property `adjustment_type` in V1 Adjust Inventory.
|
22
|
+
|
3
23
|
## Version 2.8.0 (2018-05-24)
|
4
24
|
|
5
25
|
We have added sorting functionality to the Connect v2 Customer API, updated
|
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.9.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)
|
@@ -92,6 +92,7 @@ Class | Method | HTTP request | Description
|
|
92
92
|
*SquareConnect::CustomersApi* | [**delete_customer_card**](docs/CustomersApi.md#delete_customer_card) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard
|
93
93
|
*SquareConnect::CustomersApi* | [**list_customers**](docs/CustomersApi.md#list_customers) | **GET** /v2/customers | ListCustomers
|
94
94
|
*SquareConnect::CustomersApi* | [**retrieve_customer**](docs/CustomersApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
|
95
|
+
*SquareConnect::CustomersApi* | [**search_customers**](docs/CustomersApi.md#search_customers) | **POST** /v2/customers/search | SearchCustomers
|
95
96
|
*SquareConnect::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
|
96
97
|
*SquareConnect::LocationsApi* | [**list_locations**](docs/LocationsApi.md#list_locations) | **GET** /v2/locations | ListLocations
|
97
98
|
*SquareConnect::OrdersApi* | [**batch_retrieve_orders**](docs/OrdersApi.md#batch_retrieve_orders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders
|
@@ -244,8 +245,14 @@ Class | Method | HTTP request | Description
|
|
244
245
|
- [SquareConnect::CreateRefundResponse](docs/CreateRefundResponse.md)
|
245
246
|
- [SquareConnect::Currency](docs/Currency.md)
|
246
247
|
- [SquareConnect::Customer](docs/Customer.md)
|
248
|
+
- [SquareConnect::CustomerCreationSource](docs/CustomerCreationSource.md)
|
249
|
+
- [SquareConnect::CustomerCreationSourceFilter](docs/CustomerCreationSourceFilter.md)
|
250
|
+
- [SquareConnect::CustomerFilter](docs/CustomerFilter.md)
|
247
251
|
- [SquareConnect::CustomerGroupInfo](docs/CustomerGroupInfo.md)
|
252
|
+
- [SquareConnect::CustomerInclusionExclusion](docs/CustomerInclusionExclusion.md)
|
248
253
|
- [SquareConnect::CustomerPreferences](docs/CustomerPreferences.md)
|
254
|
+
- [SquareConnect::CustomerQuery](docs/CustomerQuery.md)
|
255
|
+
- [SquareConnect::CustomerSort](docs/CustomerSort.md)
|
249
256
|
- [SquareConnect::CustomerSortField](docs/CustomerSortField.md)
|
250
257
|
- [SquareConnect::DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md)
|
251
258
|
- [SquareConnect::DeleteCatalogObjectResponse](docs/DeleteCatalogObjectResponse.md)
|
@@ -299,6 +306,8 @@ Class | Method | HTTP request | Description
|
|
299
306
|
- [SquareConnect::RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
|
300
307
|
- [SquareConnect::SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md)
|
301
308
|
- [SquareConnect::SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md)
|
309
|
+
- [SquareConnect::SearchCustomersRequest](docs/SearchCustomersRequest.md)
|
310
|
+
- [SquareConnect::SearchCustomersResponse](docs/SearchCustomersResponse.md)
|
302
311
|
- [SquareConnect::SortOrder](docs/SortOrder.md)
|
303
312
|
- [SquareConnect::TaxCalculationPhase](docs/TaxCalculationPhase.md)
|
304
313
|
- [SquareConnect::TaxInclusionType](docs/TaxInclusionType.md)
|
@@ -308,6 +317,7 @@ Class | Method | HTTP request | Description
|
|
308
317
|
- [SquareConnect::TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md)
|
309
318
|
- [SquareConnect::TenderCashDetails](docs/TenderCashDetails.md)
|
310
319
|
- [SquareConnect::TenderType](docs/TenderType.md)
|
320
|
+
- [SquareConnect::TimeRange](docs/TimeRange.md)
|
311
321
|
- [SquareConnect::Transaction](docs/Transaction.md)
|
312
322
|
- [SquareConnect::TransactionProduct](docs/TransactionProduct.md)
|
313
323
|
- [SquareConnect::UpdateCustomerRequest](docs/UpdateCustomerRequest.md)
|
data/docs/Customer.md
CHANGED
@@ -22,5 +22,6 @@ Name | Type | Description | Notes
|
|
22
22
|
**note** | **String** | A note to associate with the customer. | [optional]
|
23
23
|
**preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional]
|
24
24
|
**groups** | [**Array<CustomerGroupInfo>**](CustomerGroupInfo.md) | The groups the customer belongs to. | [optional]
|
25
|
+
**creation_source** | **String** | A creation source represents the method used to create the customer profile. | [optional]
|
25
26
|
|
26
27
|
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# SquareConnect::CustomerCreationSource
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Indicates the method used to create the customer profile.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**OTHER** | string
|
11
|
+
**APPOINTMENTS** | string
|
12
|
+
**COUPON** | string
|
13
|
+
**DELETION_RECOVERY** | string
|
14
|
+
**DIRECTORY** | string
|
15
|
+
**EGIFTING** | string
|
16
|
+
**EMAIL_COLLECTION** | string
|
17
|
+
**FEEDBACK** | string
|
18
|
+
**IMPORT** | string
|
19
|
+
**INVOICES** | string
|
20
|
+
**LOYALTY** | string
|
21
|
+
**MARKETING** | string
|
22
|
+
**MERGE** | string
|
23
|
+
**ONLINE_STORE** | string
|
24
|
+
**INSTANT_PROFILE** | string
|
25
|
+
**TERMINAL** | string
|
26
|
+
**THIRD_PARTY** | string
|
27
|
+
**THIRD_PARTY_IMPORT** | string
|
28
|
+
**UNMERGE_RECOVERY** | string
|
29
|
+
|
30
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::CustomerCreationSourceFilter
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**values** | **Array<String>** | The list of creation sources used as filtering criteria. | [optional]
|
11
|
+
**rule** | **String** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values. | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SquareConnect::CustomerFilter
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Represents a set of [`CustomerQuery`](#type-customerquery) filters used to limit the set of Customers returned by [`SearchCustomers`](#endpoint-seachcustomers).
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**creation_source** | [**CustomerCreationSourceFilter**](CustomerCreationSourceFilter.md) | A filter to select customers based on their creation source. | [optional]
|
11
|
+
**created_at** | [**TimeRange**](TimeRange.md) | A filter to select customers based on when they were created. | [optional]
|
12
|
+
**updated_at** | [**TimeRange**](TimeRange.md) | A filter to select customers based on when they were updated. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::CustomerInclusionExclusion
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Indicates whether customers should be included in, or excluded from, the result set when they match the filtering criteria.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**INCLUDE** | string
|
11
|
+
**EXCLUDE** | string
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::CustomerQuery
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Represents a query (filtering and sorting criteria) used to search for customer profiles.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**filter** | [**CustomerFilter**](CustomerFilter.md) | A list of filter criteria. | [optional]
|
11
|
+
**sort** | [**CustomerSort**](CustomerSort.md) | Sort criteria for query results. The default sort behavior is to order customers alphabetically by `given_name` and `last_name`. | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::CustomerSort
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Indicates the field to use for sorting customer profiles. For example, by total money spent with the merchant or the date of their first purchase.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**field** | **String** | The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc). Default value: `DEFAULT`. | [optional]
|
11
|
+
**order** | **String** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. | [optional]
|
12
|
+
|
13
|
+
|
data/docs/CustomersApi.md
CHANGED
@@ -10,6 +10,7 @@ Method | HTTP request | Description
|
|
10
10
|
[**delete_customer_card**](CustomersApi.md#delete_customer_card) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard
|
11
11
|
[**list_customers**](CustomersApi.md#list_customers) | **GET** /v2/customers | ListCustomers
|
12
12
|
[**retrieve_customer**](CustomersApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
|
13
|
+
[**search_customers**](CustomersApi.md#search_customers) | **POST** /v2/customers/search | SearchCustomers
|
13
14
|
[**update_customer**](CustomersApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
|
14
15
|
|
15
16
|
|
@@ -248,8 +249,8 @@ api_instance = SquareConnect::CustomersApi.new
|
|
248
249
|
|
249
250
|
opts = {
|
250
251
|
cursor: "cursor_example", # String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.
|
251
|
-
sort_field: "sort_field_example", # String | Indicates how Customers should be sorted. Default: `DEFAULT`.
|
252
|
-
sort_order: "sort_order_example" # String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`.
|
252
|
+
sort_field: "sort_field_example", # String | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values.
|
253
|
+
sort_order: "sort_order_example" # String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values.
|
253
254
|
}
|
254
255
|
|
255
256
|
begin
|
@@ -266,8 +267,8 @@ end
|
|
266
267
|
Name | Type | Description | Notes
|
267
268
|
------------- | ------------- | ------------- | -------------
|
268
269
|
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional]
|
269
|
-
**sort_field** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional]
|
270
|
-
**sort_order** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional]
|
270
|
+
**sort_field** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. | [optional]
|
271
|
+
**sort_order** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. | [optional]
|
271
272
|
|
272
273
|
### Return type
|
273
274
|
|
@@ -336,6 +337,58 @@ Name | Type | Description | Notes
|
|
336
337
|
|
337
338
|
|
338
339
|
|
340
|
+
# **search_customers**
|
341
|
+
> SearchCustomersResponse search_customers(body)
|
342
|
+
|
343
|
+
SearchCustomers
|
344
|
+
|
345
|
+
Searches a business's customers.
|
346
|
+
|
347
|
+
### Example
|
348
|
+
```ruby
|
349
|
+
# load the gem
|
350
|
+
require 'square_connect'
|
351
|
+
# setup authorization
|
352
|
+
SquareConnect.configure do |config|
|
353
|
+
# Configure OAuth2 access token for authorization: oauth2
|
354
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
355
|
+
end
|
356
|
+
|
357
|
+
api_instance = SquareConnect::CustomersApi.new
|
358
|
+
|
359
|
+
body = SquareConnect::SearchCustomersRequest.new # SearchCustomersRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
360
|
+
|
361
|
+
|
362
|
+
begin
|
363
|
+
#SearchCustomers
|
364
|
+
result = api_instance.search_customers(body)
|
365
|
+
p result
|
366
|
+
rescue SquareConnect::ApiError => e
|
367
|
+
puts "Exception when calling CustomersApi->search_customers: #{e}"
|
368
|
+
end
|
369
|
+
```
|
370
|
+
|
371
|
+
### Parameters
|
372
|
+
|
373
|
+
Name | Type | Description | Notes
|
374
|
+
------------- | ------------- | ------------- | -------------
|
375
|
+
**body** | [**SearchCustomersRequest**](SearchCustomersRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
376
|
+
|
377
|
+
### Return type
|
378
|
+
|
379
|
+
[**SearchCustomersResponse**](SearchCustomersResponse.md)
|
380
|
+
|
381
|
+
### Authorization
|
382
|
+
|
383
|
+
[oauth2](../README.md#oauth2)
|
384
|
+
|
385
|
+
### HTTP request headers
|
386
|
+
|
387
|
+
- **Content-Type**: application/json
|
388
|
+
- **Accept**: application/json
|
389
|
+
|
390
|
+
|
391
|
+
|
339
392
|
# **update_customer**
|
340
393
|
> UpdateCustomerResponse update_customer(customer_id, body)
|
341
394
|
|
data/docs/ErrorCode.md
CHANGED
@@ -50,6 +50,7 @@ Name | Type
|
|
50
50
|
**INVALID_FORM_VALUE** | string
|
51
51
|
**ONE_INSTRUMENT_EXPECTED** | string
|
52
52
|
**NO_FIELDS_SET** | string
|
53
|
+
**DEPRECATED_FIELD_SET** | string
|
53
54
|
**CARD_EXPIRED** | string
|
54
55
|
**INVALID_EXPIRATION** | string
|
55
56
|
**INVALID_EXPIRATION_YEAR** | string
|
@@ -81,6 +82,7 @@ Name | Type
|
|
81
82
|
**VERIFY_AVS_FAILURE** | string
|
82
83
|
**CARD_DECLINED_CALL_ISSUER** | string
|
83
84
|
**NOT_FOUND** | string
|
85
|
+
**METHOD_NOT_ALLOWED** | string
|
84
86
|
**REQUEST_TIMEOUT** | string
|
85
87
|
**CONFLICT** | string
|
86
88
|
**REQUEST_ENTITY_TOO_LARGE** | string
|
@@ -8,7 +8,7 @@ Defines the query parameters that can be provided in a request to the [ListCusto
|
|
8
8
|
Name | Type | Description | Notes
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
10
|
**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional]
|
11
|
-
**sort_field** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional]
|
12
|
-
**sort_order** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional]
|
11
|
+
**sort_field** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. | [optional]
|
12
|
+
**sort_order** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. | [optional]
|
13
13
|
|
14
14
|
|
data/docs/OrderLineItem.md
CHANGED
@@ -8,7 +8,7 @@ Represents a line item in an order. Each line item describes a different product
|
|
8
8
|
Name | Type | Description | Notes
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
10
|
**name** | **String** | The name of the line item. | [optional]
|
11
|
-
**quantity** | **String** | The quantity purchased, as a string representation of a number. |
|
11
|
+
**quantity** | **String** | The quantity purchased, as a string representation of a number. This string must have a positive integer value. |
|
12
12
|
**note** | **String** | The note of the line item. | [optional]
|
13
13
|
**catalog_object_id** | **String** | The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item. | [optional]
|
14
14
|
**variation_name** | **String** | The name of the variation applied to this line item. | [optional]
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SquareConnect::SearchCustomersRequest
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Defines the fields included in the request body for the [SearchCustomers](#endpoint-searchcustomer) endpoint.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Paginating results](#paginatingresults) for more information. | [optional]
|
11
|
+
**limit** | **Integer** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional]
|
12
|
+
**query** | [**CustomerQuery**](CustomerQuery.md) | Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on `given_name` and `family_name`. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SquareConnect::SearchCustomersResponse
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Defines the fields that are included in the response body of a request to the [SearchCustomers](#endpoint-searchcustomers) endpoint. One of `errors` or `customers` is present in a given response (never both).
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
|
11
|
+
**customers** | [**Array<Customer>**](Customer.md) | An array of `Customer` objects that match a query. | [optional]
|
12
|
+
**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Paginating results](#paginatingresults) for more information. | [optional]
|
13
|
+
|
14
|
+
|
data/docs/TimeRange.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::TimeRange
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Represents a generic time range. The start and end values are represented in RFC-3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevent endpoint-specific documentation to determine how time ranges are handled.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**start_at** | **String** | A datetime value in RFC-3339 format indicating when the time range starts. | [optional]
|
11
|
+
**end_at** | **String** | A datetime value in RFC-3339 format indicating when the time range ends. | [optional]
|
12
|
+
|
13
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
Name | Type | Description | Notes
|
7
7
|
------------ | ------------- | ------------- | -------------
|
8
8
|
**quantity_delta** | **Float** | The number to adjust the variation's quantity by. | [optional]
|
9
|
-
**adjustment_type** | **
|
9
|
+
**adjustment_type** | **String** | The reason for the inventory adjustment. | [optional]
|
10
10
|
**memo** | **String** | A note about the inventory adjustment. | [optional]
|
11
11
|
|
12
12
|
|
data/docs/V1Payment.md
CHANGED
@@ -30,6 +30,6 @@ Name | Type | Description | Notes
|
|
30
30
|
**refunds** | [**Array<V1Refund>**](V1Refund.md) | All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange. | [optional]
|
31
31
|
**itemizations** | [**Array<V1PaymentItemization>**](V1PaymentItemization.md) | The items purchased in the payment. | [optional]
|
32
32
|
**surcharge_money** | [**V1Money**](V1Money.md) | The total of all surcharges applied to the payment. | [optional]
|
33
|
-
**surcharges** | [**Array<V1PaymentSurcharge>**](V1PaymentSurcharge.md) | A list of all surcharges associated with the payment. | [optional]
|
33
|
+
**surcharges** | [**Array<V1PaymentSurcharge>**](V1PaymentSurcharge.md) | A list of all surcharges associated with the payment. | [optional]
|
34
34
|
|
35
35
|
|
@@ -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 [VoidTransaction](#endpoint-voidtransaction) endpoint.
|
6
6
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
data/lib/square_connect.rb
CHANGED
@@ -80,8 +80,14 @@ require 'square_connect/models/create_refund_request'
|
|
80
80
|
require 'square_connect/models/create_refund_response'
|
81
81
|
require 'square_connect/models/currency'
|
82
82
|
require 'square_connect/models/customer'
|
83
|
+
require 'square_connect/models/customer_creation_source'
|
84
|
+
require 'square_connect/models/customer_creation_source_filter'
|
85
|
+
require 'square_connect/models/customer_filter'
|
83
86
|
require 'square_connect/models/customer_group_info'
|
87
|
+
require 'square_connect/models/customer_inclusion_exclusion'
|
84
88
|
require 'square_connect/models/customer_preferences'
|
89
|
+
require 'square_connect/models/customer_query'
|
90
|
+
require 'square_connect/models/customer_sort'
|
85
91
|
require 'square_connect/models/customer_sort_field'
|
86
92
|
require 'square_connect/models/delete_catalog_object_request'
|
87
93
|
require 'square_connect/models/delete_catalog_object_response'
|
@@ -135,6 +141,8 @@ require 'square_connect/models/retrieve_transaction_request'
|
|
135
141
|
require 'square_connect/models/retrieve_transaction_response'
|
136
142
|
require 'square_connect/models/search_catalog_objects_request'
|
137
143
|
require 'square_connect/models/search_catalog_objects_response'
|
144
|
+
require 'square_connect/models/search_customers_request'
|
145
|
+
require 'square_connect/models/search_customers_response'
|
138
146
|
require 'square_connect/models/sort_order'
|
139
147
|
require 'square_connect/models/tax_calculation_phase'
|
140
148
|
require 'square_connect/models/tax_inclusion_type'
|
@@ -144,6 +152,7 @@ require 'square_connect/models/tender_card_details_entry_method'
|
|
144
152
|
require 'square_connect/models/tender_card_details_status'
|
145
153
|
require 'square_connect/models/tender_cash_details'
|
146
154
|
require 'square_connect/models/tender_type'
|
155
|
+
require 'square_connect/models/time_range'
|
147
156
|
require 'square_connect/models/transaction'
|
148
157
|
require 'square_connect/models/transaction_product'
|
149
158
|
require 'square_connect/models/update_customer_request'
|