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

Commit f578e3e

Browse files
mikekonossung88
authored andcommitted
Release 2.20180918.0 (#49)
1 parent 4e2601f commit f578e3e

File tree

103 files changed

+7589
-78
lines changed

Some content is hidden

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

103 files changed

+7589
-78
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
22

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
## Version 2.20180712.2 (2018-08-21)
423

524
The Connect SDK now includes functionality for the OAuth API. The Square OAuth API lets applications request and obtain permission from a Square account to make API calls on behalf of that account. Applications can request individual permissions so that users do not need to grant full access to their Square accounts.
@@ -157,7 +176,7 @@ represent the value of returned goods in an exchange, rather than actual money m
157176

158177
### New features: Orders API
159178

160-
* For Catalog-backed line items, setting `CreateOrderRequestLineItem.base_price_money` will now override
179+
* For Catalog-backed line items, setting `CreateOrderRequestLineItem.base_price_money` will now override
161180
the catalog item variation's price.
162181
* `CreateOrderRequestModifier`s may now be created ad hoc using the new `name` and `base_price_money` fields.
163182

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
1010
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1111

1212
- API version: 2.0
13-
- Package version: 2.20180712.2
13+
- Package version: 2.20180918.0
1414
- Build package: io.swagger.codegen.languages.RubyClientCodegen
1515

1616
For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -94,6 +94,13 @@ Class | Method | HTTP request | Description
9494
*SquareConnect::CustomersApi* | [**retrieve_customer**](docs/CustomersApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
9595
*SquareConnect::CustomersApi* | [**search_customers**](docs/CustomersApi.md#search_customers) | **POST** /v2/customers/search | SearchCustomers
9696
*SquareConnect::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
97+
*SquareConnect::InventoryApi* | [**batch_change_inventory**](docs/InventoryApi.md#batch_change_inventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory
98+
*SquareConnect::InventoryApi* | [**batch_retrieve_inventory_changes**](docs/InventoryApi.md#batch_retrieve_inventory_changes) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges
99+
*SquareConnect::InventoryApi* | [**batch_retrieve_inventory_counts**](docs/InventoryApi.md#batch_retrieve_inventory_counts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts
100+
*SquareConnect::InventoryApi* | [**retrieve_inventory_adjustment**](docs/InventoryApi.md#retrieve_inventory_adjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment
101+
*SquareConnect::InventoryApi* | [**retrieve_inventory_changes**](docs/InventoryApi.md#retrieve_inventory_changes) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges
102+
*SquareConnect::InventoryApi* | [**retrieve_inventory_count**](docs/InventoryApi.md#retrieve_inventory_count) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount
103+
*SquareConnect::InventoryApi* | [**retrieve_inventory_physical_count**](docs/InventoryApi.md#retrieve_inventory_physical_count) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount
97104
*SquareConnect::LocationsApi* | [**list_locations**](docs/LocationsApi.md#list_locations) | **GET** /v2/locations | ListLocations
98105
*SquareConnect::MobileAuthorizationApi* | [**create_mobile_authorization_code**](docs/MobileAuthorizationApi.md#create_mobile_authorization_code) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode
99106
*SquareConnect::OAuthApi* | [**obtain_token**](docs/OAuthApi.md#obtain_token) | **POST** /oauth2/token | ObtainToken
@@ -187,10 +194,16 @@ Class | Method | HTTP request | Description
187194
- [SquareConnect::AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
188195
- [SquareConnect::AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
189196
- [SquareConnect::Address](docs/Address.md)
197+
- [SquareConnect::BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md)
198+
- [SquareConnect::BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md)
190199
- [SquareConnect::BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
191200
- [SquareConnect::BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md)
192201
- [SquareConnect::BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md)
193202
- [SquareConnect::BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md)
203+
- [SquareConnect::BatchRetrieveInventoryChangesRequest](docs/BatchRetrieveInventoryChangesRequest.md)
204+
- [SquareConnect::BatchRetrieveInventoryChangesResponse](docs/BatchRetrieveInventoryChangesResponse.md)
205+
- [SquareConnect::BatchRetrieveInventoryCountsRequest](docs/BatchRetrieveInventoryCountsRequest.md)
206+
- [SquareConnect::BatchRetrieveInventoryCountsResponse](docs/BatchRetrieveInventoryCountsResponse.md)
194207
- [SquareConnect::BatchRetrieveOrdersRequest](docs/BatchRetrieveOrdersRequest.md)
195208
- [SquareConnect::BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md)
196209
- [SquareConnect::BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
@@ -270,7 +283,14 @@ Class | Method | HTTP request | Description
270283
- [SquareConnect::Error](docs/Error.md)
271284
- [SquareConnect::ErrorCategory](docs/ErrorCategory.md)
272285
- [SquareConnect::ErrorCode](docs/ErrorCode.md)
286+
- [SquareConnect::InventoryAdjustment](docs/InventoryAdjustment.md)
273287
- [SquareConnect::InventoryAlertType](docs/InventoryAlertType.md)
288+
- [SquareConnect::InventoryChange](docs/InventoryChange.md)
289+
- [SquareConnect::InventoryChangeType](docs/InventoryChangeType.md)
290+
- [SquareConnect::InventoryCount](docs/InventoryCount.md)
291+
- [SquareConnect::InventoryPhysicalCount](docs/InventoryPhysicalCount.md)
292+
- [SquareConnect::InventoryState](docs/InventoryState.md)
293+
- [SquareConnect::InventoryTransfer](docs/InventoryTransfer.md)
274294
- [SquareConnect::ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
275295
- [SquareConnect::ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md)
276296
- [SquareConnect::ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md)
@@ -301,6 +321,7 @@ Class | Method | HTTP request | Description
301321
- [SquareConnect::OrderLineItemModifier](docs/OrderLineItemModifier.md)
302322
- [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
303323
- [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
324+
- [SquareConnect::Product](docs/Product.md)
304325
- [SquareConnect::Refund](docs/Refund.md)
305326
- [SquareConnect::RefundStatus](docs/RefundStatus.md)
306327
- [SquareConnect::RegisterDomainRequest](docs/RegisterDomainRequest.md)
@@ -312,6 +333,14 @@ Class | Method | HTTP request | Description
312333
- [SquareConnect::RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md)
313334
- [SquareConnect::RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md)
314335
- [SquareConnect::RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md)
336+
- [SquareConnect::RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md)
337+
- [SquareConnect::RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md)
338+
- [SquareConnect::RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md)
339+
- [SquareConnect::RetrieveInventoryChangesResponse](docs/RetrieveInventoryChangesResponse.md)
340+
- [SquareConnect::RetrieveInventoryCountRequest](docs/RetrieveInventoryCountRequest.md)
341+
- [SquareConnect::RetrieveInventoryCountResponse](docs/RetrieveInventoryCountResponse.md)
342+
- [SquareConnect::RetrieveInventoryPhysicalCountRequest](docs/RetrieveInventoryPhysicalCountRequest.md)
343+
- [SquareConnect::RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md)
315344
- [SquareConnect::RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
316345
- [SquareConnect::RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
317346
- [SquareConnect::RevokeTokenRequest](docs/RevokeTokenRequest.md)
@@ -321,6 +350,7 @@ Class | Method | HTTP request | Description
321350
- [SquareConnect::SearchCustomersRequest](docs/SearchCustomersRequest.md)
322351
- [SquareConnect::SearchCustomersResponse](docs/SearchCustomersResponse.md)
323352
- [SquareConnect::SortOrder](docs/SortOrder.md)
353+
- [SquareConnect::SourceApplication](docs/SourceApplication.md)
324354
- [SquareConnect::TaxCalculationPhase](docs/TaxCalculationPhase.md)
325355
- [SquareConnect::TaxInclusionType](docs/TaxInclusionType.md)
326356
- [SquareConnect::Tender](docs/Tender.md)
@@ -409,6 +439,8 @@ Class | Method | HTTP request | Description
409439
- TIMECARDS_WRITE: POST, PUT, and DELETE endpoints related to employee timecards
410440
- PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: Allow third party applications to deduct a portion of each transaction amount.
411441
- PAYMENTS_WRITE_IN_PERSON: POST, PUT, and DELETE endpoints. Grants write access to transaction and refunds information.
442+
- INVENTORY_READ: GET endpoints related to a merchant's inventory
443+
- INVENTORY_WRITE: POST, PUT, and DELETE endpoints related to a merchant's inventory
412444

413445
### oauth2ClientSecret
414446

docs/BatchChangeInventoryRequest.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# SquareConnect::BatchChangeInventoryRequest
2+
3+
### Description
4+
5+
6+
7+
## Properties
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**idempotency_key** | **String** | 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]
11+
**changes** | [**Array<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]
12+
**ignore_unchanged_counts** | **BOOLEAN** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional]
13+
14+

docs/BatchChangeInventoryResponse.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# SquareConnect::BatchChangeInventoryResponse
2+
3+
### Description
4+
5+
6+
7+
## Properties
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
11+
**counts** | [**Array<InventoryCount>**](InventoryCount.md) | The current counts for all objects referenced in the request. | [optional]
12+
13+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# SquareConnect::BatchRetrieveInventoryChangesRequest
2+
3+
### Description
4+
5+
6+
7+
## Properties
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**catalog_object_ids** | **Array<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
11+
**location_ids** | **Array<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
12+
**types** | **Array<String>** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional]
13+
**states** | **Array<String>** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional]
14+
**updated_after** | **String** | 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]
15+
**updated_before** | **String** | 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]
16+
**cursor** | **String** | 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]
17+
18+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# SquareConnect::BatchRetrieveInventoryChangesResponse
2+
3+
### Description
4+
5+
6+
7+
## Properties
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
11+
**changes** | [**Array<InventoryChange>**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional]
12+
**cursor** | **String** | 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]
13+
14+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# SquareConnect::BatchRetrieveInventoryCountsRequest
2+
3+
### Description
4+
5+
6+
7+
## Properties
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**catalog_object_ids** | **Array<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
11+
**location_ids** | **Array<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
12+
**updated_after** | **String** | 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]
13+
**cursor** | **String** | 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]
14+
15+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# SquareConnect::BatchRetrieveInventoryCountsResponse
2+
3+
### Description
4+
5+
6+
7+
## Properties
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
11+
**counts** | [**Array<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional]
12+
**cursor** | **String** | 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]
13+
14+

docs/Card.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ Name | Type | Description | Notes
1414
**exp_year** | **Integer** | The four-digit year of the card's expiration date. | [optional]
1515
**cardholder_name** | **String** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional]
1616
**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]
17-
**fingerprint** | **String** | 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]
17+
**fingerprint** | **String** | 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]
1818

1919

docs/CreateCustomerRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
1616
**phone_number** | **String** | The customer's phone number. | [optional]
1717
**reference_id** | **String** | An optional second ID you can set to associate the customer with an entity in another system. | [optional]
1818
**note** | **String** | An optional note to associate with the customer. | [optional]
19+
**birthday** | **String** | 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]
1920

2021

0 commit comments

Comments
 (0)