Merge pull request #109 from square/release/4.20200826.3

Release 4.20200826.3

CHANGES.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## Version 4.20200826.3 (2020-08-26T00:00)
+## Existing API updates
+* Orders API
+  * [Order](https://developer.squareup.com/reference/square_2020-08-26/objects/Order) object. The `total_tip_money` field is now GA.
+  * [CreateOrder](https://developer.squareup.com/reference/square_2020-08-26/orders-api/create-order), [UpdateOrder](https://developer.squareup.com/reference/square_2020-08-26/orders-api/update-order), and [BatchRetrieveOrders](https://developer.squareup.com/reference/square_2020-08-26/orders-api/batch-retrieve-orders). These APIs now support merchant-scoped endpoints (for example, the `CreateOrder` endpoint `POST /v2/orders`). The location-scoped variants of these endpoints (for example, the `CreateOrder` endpoint `POST /v2/locations/{location_id}/orders`) continue to work, but these endpoints are now deprecated. You should use the merchant-scoped endpoints (you provide the location information in the request body).
+* Labor API
+	* [Migrate from Employees to Team Members.](https://developer.squareup.com/docs/labor-api/migrate-to-teams) The Employees API is now deprecated in this release. Accordingly, update references to the  `Shift.employee_id` field to the `Shift.team_member_id` field of the Labor API.
+* v2 Employees API (deprecated)
+	* [Migrate from the Square Employees API.](https://developer.squareup.com/docs/team/migrate-from-v2-employees) The v2 Employees API is now deprecated. This topic provides information to migrate to the Team API.
+* v1 Employees API (deprecated)
+	* [Migrate from the v1 Employees API.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-employees) The v1 Employees API is now deprecated. This topic provides information to migrate to the Team API. 
+
+## Documentation updates
+* Point of Sale API
+	* [Build on iOS.](https://developer.squareup.com/docs/pos-api/build-on-ios) Corrected the Swift example code in step 7.
+* Team API
+	* [Team API Overview.](https://developer.squareup.com/docs/team/overview) Documented the limitation related to creating a team member in the Square Sandbox.
+
+
 ## Version 4.20200812.2 (2020-08-12T00:00)
 ## API releases
 * Subscriptions API (beta):

README.md

@@ -148,8 +148,10 @@ Class | Method | HTTP request | Description
 *SquareConnect.LaborApi* | [**getBreakType**](docs/LaborApi.md#getBreakType) | **GET** /v2/labor/break-types/{id} | GetBreakType
 *SquareConnect.LaborApi* | [**getEmployeeWage**](docs/LaborApi.md#getEmployeeWage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage
 *SquareConnect.LaborApi* | [**getShift**](docs/LaborApi.md#getShift) | **GET** /v2/labor/shifts/{id} | GetShift
+*SquareConnect.LaborApi* | [**getTeamMemberWage**](docs/LaborApi.md#getTeamMemberWage) | **GET** /v2/labor/team-member-wages/{id} | GetTeamMemberWage
 *SquareConnect.LaborApi* | [**listBreakTypes**](docs/LaborApi.md#listBreakTypes) | **GET** /v2/labor/break-types | ListBreakTypes
 *SquareConnect.LaborApi* | [**listEmployeeWages**](docs/LaborApi.md#listEmployeeWages) | **GET** /v2/labor/employee-wages | ListEmployeeWages
+*SquareConnect.LaborApi* | [**listTeamMemberWages**](docs/LaborApi.md#listTeamMemberWages) | **GET** /v2/labor/team-member-wages | ListTeamMemberWages
 *SquareConnect.LaborApi* | [**listWorkweekConfigs**](docs/LaborApi.md#listWorkweekConfigs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs
 *SquareConnect.LaborApi* | [**searchShifts**](docs/LaborApi.md#searchShifts) | **POST** /v2/labor/shifts/search | SearchShifts
 *SquareConnect.LaborApi* | [**updateBreakType**](docs/LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType
@@ -178,12 +180,12 @@ Class | Method | HTTP request | Description
 *SquareConnect.OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken
 *SquareConnect.OAuthApi* | [**renewToken**](docs/OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken
 *SquareConnect.OAuthApi* | [**revokeToken**](docs/OAuthApi.md#revokeToken) | **POST** /oauth2/revoke | RevokeToken
-*SquareConnect.OrdersApi* | [**batchRetrieveOrders**](docs/OrdersApi.md#batchRetrieveOrders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders
+*SquareConnect.OrdersApi* | [**batchRetrieveOrders**](docs/OrdersApi.md#batchRetrieveOrders) | **POST** /v2/orders/batch-retrieve | BatchRetrieveOrders
 *SquareConnect.OrdersApi* | [**calculateOrder**](docs/OrdersApi.md#calculateOrder) | **POST** /v2/orders/calculate | CalculateOrder
-*SquareConnect.OrdersApi* | [**createOrder**](docs/OrdersApi.md#createOrder) | **POST** /v2/locations/{location_id}/orders | CreateOrder
+*SquareConnect.OrdersApi* | [**createOrder**](docs/OrdersApi.md#createOrder) | **POST** /v2/orders | CreateOrder
 *SquareConnect.OrdersApi* | [**payOrder**](docs/OrdersApi.md#payOrder) | **POST** /v2/orders/{order_id}/pay | PayOrder
 *SquareConnect.OrdersApi* | [**searchOrders**](docs/OrdersApi.md#searchOrders) | **POST** /v2/orders/search | SearchOrders
-*SquareConnect.OrdersApi* | [**updateOrder**](docs/OrdersApi.md#updateOrder) | **PUT** /v2/locations/{location_id}/orders/{order_id} | UpdateOrder
+*SquareConnect.OrdersApi* | [**updateOrder**](docs/OrdersApi.md#updateOrder) | **PUT** /v2/orders/{order_id} | UpdateOrder
 *SquareConnect.PaymentsApi* | [**cancelPayment**](docs/PaymentsApi.md#cancelPayment) | **POST** /v2/payments/{payment_id}/cancel | CancelPayment
 *SquareConnect.PaymentsApi* | [**cancelPaymentByIdempotencyKey**](docs/PaymentsApi.md#cancelPaymentByIdempotencyKey) | **POST** /v2/payments/cancel | CancelPaymentByIdempotencyKey
 *SquareConnect.PaymentsApi* | [**completePayment**](docs/PaymentsApi.md#completePayment) | **POST** /v2/payments/{payment_id}/complete | CompletePayment
@@ -193,8 +195,6 @@ Class | Method | HTTP request | Description
 *SquareConnect.RefundsApi* | [**getPaymentRefund**](docs/RefundsApi.md#getPaymentRefund) | **GET** /v2/refunds/{refund_id} | GetPaymentRefund
 *SquareConnect.RefundsApi* | [**listPaymentRefunds**](docs/RefundsApi.md#listPaymentRefunds) | **GET** /v2/refunds | ListPaymentRefunds
 *SquareConnect.RefundsApi* | [**refundPayment**](docs/RefundsApi.md#refundPayment) | **POST** /v2/refunds | RefundPayment
-*SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivableRefunds**](docs/ReportingApi.md#listAdditionalRecipientReceivableRefunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds
-*SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivables**](docs/ReportingApi.md#listAdditionalRecipientReceivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables
 *SquareConnect.SubscriptionsApi* | [**cancelSubscription**](docs/SubscriptionsApi.md#cancelSubscription) | **POST** /v2/subscriptions/{subscription_id}/cancel | CancelSubscription
 *SquareConnect.SubscriptionsApi* | [**createSubscription**](docs/SubscriptionsApi.md#createSubscription) | **POST** /v2/subscriptions | CreateSubscription
 *SquareConnect.SubscriptionsApi* | [**listSubscriptionEvents**](docs/SubscriptionsApi.md#listSubscriptionEvents) | **GET** /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents
@@ -301,8 +301,6 @@ Class | Method | HTTP request | Description
  - [SquareConnect.AddGroupToCustomerRequest](docs/AddGroupToCustomerRequest.md)
  - [SquareConnect.AddGroupToCustomerResponse](docs/AddGroupToCustomerResponse.md)
  - [SquareConnect.AdditionalRecipient](docs/AdditionalRecipient.md)
- - [SquareConnect.AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
- - [SquareConnect.AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
  - [SquareConnect.Address](docs/Address.md)
  - [SquareConnect.AdjustLoyaltyPointsRequest](docs/AdjustLoyaltyPointsRequest.md)
  - [SquareConnect.AdjustLoyaltyPointsResponse](docs/AdjustLoyaltyPointsResponse.md)
@@ -351,6 +349,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CardBrand](docs/CardBrand.md)
  - [SquareConnect.CardPaymentDetails](docs/CardPaymentDetails.md)
  - [SquareConnect.CardPrepaidType](docs/CardPrepaidType.md)
+ - [SquareConnect.CardSquareProduct](docs/CardSquareProduct.md)
  - [SquareConnect.CardType](docs/CardType.md)
  - [SquareConnect.CashDrawerDevice](docs/CashDrawerDevice.md)
  - [SquareConnect.CashDrawerEventType](docs/CashDrawerEventType.md)
@@ -535,6 +534,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.GetPaymentResponse](docs/GetPaymentResponse.md)
  - [SquareConnect.GetShiftRequest](docs/GetShiftRequest.md)
  - [SquareConnect.GetShiftResponse](docs/GetShiftResponse.md)
+ - [SquareConnect.GetTeamMemberWageRequest](docs/GetTeamMemberWageRequest.md)
+ - [SquareConnect.GetTeamMemberWageResponse](docs/GetTeamMemberWageResponse.md)
  - [SquareConnect.GetTerminalCheckoutRequest](docs/GetTerminalCheckoutRequest.md)
  - [SquareConnect.GetTerminalCheckoutResponse](docs/GetTerminalCheckoutResponse.md)
  - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md)
@@ -560,10 +561,6 @@ Class | Method | HTTP request | Description
  - [SquareConnect.ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
  - [SquareConnect.JobAssignment](docs/JobAssignment.md)
  - [SquareConnect.JobAssignmentPayType](docs/JobAssignmentPayType.md)
- - [SquareConnect.ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md)
- - [SquareConnect.ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md)
- - [SquareConnect.ListAdditionalRecipientReceivablesRequest](docs/ListAdditionalRecipientReceivablesRequest.md)
- - [SquareConnect.ListAdditionalRecipientReceivablesResponse](docs/ListAdditionalRecipientReceivablesResponse.md)
  - [SquareConnect.ListBankAccountsRequest](docs/ListBankAccountsRequest.md)
  - [SquareConnect.ListBankAccountsResponse](docs/ListBankAccountsResponse.md)
  - [SquareConnect.ListBreakTypesRequest](docs/ListBreakTypesRequest.md)
@@ -606,6 +603,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.ListRefundsResponse](docs/ListRefundsResponse.md)
  - [SquareConnect.ListSubscriptionEventsRequest](docs/ListSubscriptionEventsRequest.md)
  - [SquareConnect.ListSubscriptionEventsResponse](docs/ListSubscriptionEventsResponse.md)
+ - [SquareConnect.ListTeamMemberWagesRequest](docs/ListTeamMemberWagesRequest.md)
+ - [SquareConnect.ListTeamMemberWagesResponse](docs/ListTeamMemberWagesResponse.md)
  - [SquareConnect.ListTransactionsRequest](docs/ListTransactionsRequest.md)
  - [SquareConnect.ListTransactionsResponse](docs/ListTransactionsResponse.md)
  - [SquareConnect.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md)
@@ -657,7 +656,6 @@ Class | Method | HTTP request | Description
  - [SquareConnect.MeasurementUnitWeight](docs/MeasurementUnitWeight.md)
  - [SquareConnect.Merchant](docs/Merchant.md)
  - [SquareConnect.MerchantStatus](docs/MerchantStatus.md)
- - [SquareConnect.MethodErrorCodes](docs/MethodErrorCodes.md)
  - [SquareConnect.ModelBreak](docs/ModelBreak.md)
  - [SquareConnect.Money](docs/Money.md)
  - [SquareConnect.ObtainTokenRequest](docs/ObtainTokenRequest.md)
@@ -840,7 +838,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.TeamMemberAssignedLocations](docs/TeamMemberAssignedLocations.md)
  - [SquareConnect.TeamMemberAssignedLocationsAssignmentType](docs/TeamMemberAssignedLocationsAssignmentType.md)
  - [SquareConnect.TeamMemberStatus](docs/TeamMemberStatus.md)
+ - [SquareConnect.TeamMemberWage](docs/TeamMemberWage.md)
  - [SquareConnect.Tender](docs/Tender.md)
+ - [SquareConnect.TenderBankTransferDetails](docs/TenderBankTransferDetails.md)
+ - [SquareConnect.TenderBankTransferDetailsStatus](docs/TenderBankTransferDetailsStatus.md)
  - [SquareConnect.TenderCardDetails](docs/TenderCardDetails.md)
  - [SquareConnect.TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md)
  - [SquareConnect.TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md)

docs/BatchChangeInventoryRequest.md

@@ -8,7 +8,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **idempotency_key** | **String** | A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information. | [optional] 
-**changes** | [**[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] 
+**changes** | [**[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. | [optional] 
 **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] 
 
 

docs/BatchRetrieveInventoryChangesRequest.md

@@ -7,12 +7,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**catalog_object_ids** | **[String]** | Filters results by `CatalogObject` ID. Only applied when set. Max size is 500 IDs. Default: unset. | [optional] 
-**location_ids** | **[String]** | Filters results by `Location` ID. Only applied when set. Default: unset. | [optional] 
-**types** | **[String]** | Filters results by `InventoryChangeType`. Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] 
-**states** | **[String]** | Filters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] 
-**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] 
-**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] 
+**catalog_object_ids** | **[String]** | The filter to return results by `CatalogObject` ID. The filter is only applicable when set. The default value is null. | [optional] 
+**location_ids** | **[String]** | The filter to return results by `Location` ID.  The filter is only applicable when set. The default value is null. | [optional] 
+**types** | **[String]** | The filter to return results by `InventoryChangeType` values other than `TRANSFER`. The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] 
+**states** | **[String]** | The filter to return `ADJUSTMENT` query results by `InventoryState`. This filter is only applied when set. The default value is null. See [InventoryState](#type-inventorystate) for possible values | [optional] 
+**updated_after** | **String** | The filter to return results with their `calculated_at` value   after the given time as specified in an RFC 3339 timestamp.  The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | [optional] 
+**updated_before** | **String** | The filter to return results with their `created_at` or `calculated_at` value   strictly before the given time as specified in an RFC 3339 timestamp.  The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | [optional] 
 **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 the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | [optional]