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

Commit fa3c6a6

Browse files
mikekonossung88
authored andcommitted
release sdk version 2.20180918.0 (#78)
* Release 2.20180918.0
1 parent f30baab commit fa3c6a6

File tree

104 files changed

+7197
-65
lines changed

Some content is hidden

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

104 files changed

+7197
-65
lines changed

CHANGES.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Change Log
2-
## Version 2.20180712.3 (2018-08-24)
2+
3+
## Version 2.20180918.0 (2018-09-18)
4+
5+
We have added Connect v2 Inventory API and birthdays in `Customer` entities.
6+
7+
### New API: Inventory API (Connect V2)
8+
9+
The Connect v2 Inventory API replaces the Connect v1 Inventory API
10+
and introduces new functionality:
11+
12+
* Moving item variations quantities through predefined states
13+
(e.g., from `IN_STOCK` to `WASTE`).
14+
* Viewing the inventory adjustment history for an item variation.
15+
* Batch inventory adjustments and information retrieval.
16+
17+
### New feature: Customer Birthdays (Connect V2)
18+
19+
* Customer profiles now include a `birthday` field.
20+
Dates are recorded in RFC-3339 format and can be
21+
set through the `CreateCustomer` and `UpdateCustomer` endpoints.
322

423
Remove singleton constraint for configuration class. This is a minor breaking change to ```ApiClient```
524
and ```RESTClientObject``` initialization.

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,13 @@ Class | Method | HTTP request
118118
*CustomersApi* | [**retrieve_customer**](docs/CustomersApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id}
119119
*CustomersApi* | [**search_customers**](docs/CustomersApi.md#search_customers) | **POST** /v2/customers/search
120120
*CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PUT** /v2/customers/{customer_id}
121+
*InventoryApi* | [**batch_change_inventory**](docs/InventoryApi.md#batch_change_inventory) | **POST** /v2/inventory/batch-change
122+
*InventoryApi* | [**batch_retrieve_inventory_changes**](docs/InventoryApi.md#batch_retrieve_inventory_changes) | **POST** /v2/inventory/batch-retrieve-changes
123+
*InventoryApi* | [**batch_retrieve_inventory_counts**](docs/InventoryApi.md#batch_retrieve_inventory_counts) | **POST** /v2/inventory/batch-retrieve-counts
124+
*InventoryApi* | [**retrieve_inventory_adjustment**](docs/InventoryApi.md#retrieve_inventory_adjustment) | **GET** /v2/inventory/adjustment/{adjustment_id}
125+
*InventoryApi* | [**retrieve_inventory_changes**](docs/InventoryApi.md#retrieve_inventory_changes) | **GET** /v2/inventory/{catalog_object_id}/changes
126+
*InventoryApi* | [**retrieve_inventory_count**](docs/InventoryApi.md#retrieve_inventory_count) | **GET** /v2/inventory/{catalog_object_id}
127+
*InventoryApi* | [**retrieve_inventory_physical_count**](docs/InventoryApi.md#retrieve_inventory_physical_count) | **GET** /v2/inventory/physical-count/{physical_count_id}
121128
*LocationsApi* | [**list_locations**](docs/LocationsApi.md#list_locations) | **GET** /v2/locations
122129
*MobileAuthorizationApi* | [**create_mobile_authorization_code**](docs/MobileAuthorizationApi.md#create_mobile_authorization_code) | **POST** /mobile/authorization-code
123130
*OAuthApi* | [**obtain_token**](docs/OAuthApi.md#obtain_token) | **POST** /oauth2/token
@@ -211,10 +218,16 @@ Class | Method | HTTP request
211218
- [AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
212219
- [AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
213220
- [Address](docs/Address.md)
221+
- [BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md)
222+
- [BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md)
214223
- [BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
215224
- [BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md)
216225
- [BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md)
217226
- [BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md)
227+
- [BatchRetrieveInventoryChangesRequest](docs/BatchRetrieveInventoryChangesRequest.md)
228+
- [BatchRetrieveInventoryChangesResponse](docs/BatchRetrieveInventoryChangesResponse.md)
229+
- [BatchRetrieveInventoryCountsRequest](docs/BatchRetrieveInventoryCountsRequest.md)
230+
- [BatchRetrieveInventoryCountsResponse](docs/BatchRetrieveInventoryCountsResponse.md)
218231
- [BatchRetrieveOrdersRequest](docs/BatchRetrieveOrdersRequest.md)
219232
- [BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md)
220233
- [BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
@@ -281,6 +294,11 @@ Class | Method | HTTP request
281294
- [DeleteCustomerResponse](docs/DeleteCustomerResponse.md)
282295
- [Device](docs/Device.md)
283296
- [Error](docs/Error.md)
297+
- [InventoryAdjustment](docs/InventoryAdjustment.md)
298+
- [InventoryChange](docs/InventoryChange.md)
299+
- [InventoryCount](docs/InventoryCount.md)
300+
- [InventoryPhysicalCount](docs/InventoryPhysicalCount.md)
301+
- [InventoryTransfer](docs/InventoryTransfer.md)
284302
- [ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
285303
- [ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md)
286304
- [ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md)
@@ -314,6 +332,14 @@ Class | Method | HTTP request
314332
- [RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md)
315333
- [RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md)
316334
- [RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md)
335+
- [RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md)
336+
- [RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md)
337+
- [RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md)
338+
- [RetrieveInventoryChangesResponse](docs/RetrieveInventoryChangesResponse.md)
339+
- [RetrieveInventoryCountRequest](docs/RetrieveInventoryCountRequest.md)
340+
- [RetrieveInventoryCountResponse](docs/RetrieveInventoryCountResponse.md)
341+
- [RetrieveInventoryPhysicalCountRequest](docs/RetrieveInventoryPhysicalCountRequest.md)
342+
- [RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md)
317343
- [RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
318344
- [RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
319345
- [RevokeTokenRequest](docs/RevokeTokenRequest.md)
@@ -322,6 +348,7 @@ Class | Method | HTTP request
322348
- [SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md)
323349
- [SearchCustomersRequest](docs/SearchCustomersRequest.md)
324350
- [SearchCustomersResponse](docs/SearchCustomersResponse.md)
351+
- [SourceApplication](docs/SourceApplication.md)
325352
- [Tender](docs/Tender.md)
326353
- [TenderCardDetails](docs/TenderCardDetails.md)
327354
- [TenderCashDetails](docs/TenderCashDetails.md)
@@ -394,12 +421,15 @@ Class | Method | HTTP request
394421
- [ErrorCategory](docs/ErrorCategory.md)
395422
- [ErrorCode](docs/ErrorCode.md)
396423
- [InventoryAlertType](docs/InventoryAlertType.md)
424+
- [InventoryChangeType](docs/InventoryChangeType.md)
425+
- [InventoryState](docs/InventoryState.md)
397426
- [LocationCapability](docs/LocationCapability.md)
398427
- [LocationStatus](docs/LocationStatus.md)
399428
- [LocationType](docs/LocationType.md)
400429
- [OrderLineItemDiscountScope](docs/OrderLineItemDiscountScope.md)
401430
- [OrderLineItemDiscountType](docs/OrderLineItemDiscountType.md)
402431
- [OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
432+
- [Product](docs/Product.md)
403433
- [RefundStatus](docs/RefundStatus.md)
404434
- [RegisterDomainResponseStatus](docs/RegisterDomainResponseStatus.md)
405435
- [SortOrder](docs/SortOrder.md)
@@ -437,6 +467,8 @@ Class | Method | HTTP request
437467
- **TIMECARDS_WRITE**: POST, PUT, and DELETE endpoints related to employee timecards
438468
- **PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS**: Allow third party applications to deduct a portion of each transaction amount.
439469
- **PAYMENTS_WRITE_IN_PERSON**: POST, PUT, and DELETE endpoints. Grants write access to transaction and refunds information.
470+
- **INVENTORY_READ**: GET endpoints related to a merchant's inventory
471+
- **INVENTORY_WRITE**: POST, PUT, and DELETE endpoints related to a merchant's inventory
440472

441473
## oauth2ClientSecret
442474

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# BatchChangeInventoryRequest
2+
> squareconnect.models.batch_change_inventory_request
3+
4+
### Description
5+
6+
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**idempotency_key** | **str** | A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. | [optional]
12+
**changes** | [**list[InventoryChange]**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes. | [optional]
13+
**ignore_unchanged_counts** | **bool** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# BatchChangeInventoryResponse
2+
> squareconnect.models.batch_change_inventory_response
3+
4+
### Description
5+
6+
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional]
12+
**counts** | [**list[InventoryCount]**](InventoryCount.md) | The current counts for all objects referenced in the request. | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# BatchRetrieveInventoryChangesRequest
2+
> squareconnect.models.batch_retrieve_inventory_changes_request
3+
4+
### Description
5+
6+
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**catalog_object_ids** | **list[str]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
12+
**location_ids** | **list[str]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
13+
**types** | **list[str]** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional]
14+
**states** | **list[str]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional]
15+
**updated_after** | **str** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional]
16+
**updated_before** | **str** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional]
17+
**cursor** | **str** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Paginating results](#paginatingresults) for more information. | [optional]
18+
19+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
20+
21+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# BatchRetrieveInventoryChangesResponse
2+
> squareconnect.models.batch_retrieve_inventory_changes_response
3+
4+
### Description
5+
6+
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional]
12+
**changes** | [**list[InventoryChange]**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional]
13+
**cursor** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# BatchRetrieveInventoryCountsRequest
2+
> squareconnect.models.batch_retrieve_inventory_counts_request
3+
4+
### Description
5+
6+
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**catalog_object_ids** | **list[str]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
12+
**location_ids** | **list[str]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
13+
**updated_after** | **str** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional]
14+
**cursor** | **str** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Paginating results](#paginatingresults) for more information. | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+
18+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# BatchRetrieveInventoryCountsResponse
2+
> squareconnect.models.batch_retrieve_inventory_counts_response
3+
4+
### Description
5+
6+
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional]
12+
**counts** | [**list[InventoryCount]**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional]
13+
**cursor** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+

docs/Card.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
1515
**exp_year** | **int** | The four-digit year of the card's expiration date. | [optional]
1616
**cardholder_name** | **str** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional]
1717
**billing_address** | [**Address**](Address.md) | The card's billing address. This value is present only if this object represents a customer's card on file. | [optional]
18-
**fingerprint** | **str** | The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional]
18+
**fingerprint** | **str** | The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional]
1919

2020
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2121

docs/CreateCustomerRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**phone_number** | **str** | The customer's phone number. | [optional]
1818
**reference_id** | **str** | An optional second ID you can set to associate the customer with an entity in another system. | [optional]
1919
**note** | **str** | An optional note to associate with the customer. | [optional]
20+
**birthday** | **str** | The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional]
2021

2122
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2223

0 commit comments

Comments
 (0)