Merge pull request #101 from square/release/4.20200625.0

Release/4.20200625.0

CHANGES.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## Version 4.20200625.0 (2020-06-25T00:00)
+## New API release
+
+* **Team API generally available (GA)** 
+  * For an overview, see [Team API Overview](https://developer.squareup.com/docs/team/overview).
+  * For technical reference, see [Team API](https://developer.squareup.com/reference/square_2020-06-25/team-api).
+
+## Existing API updates
+
+* **Catalog API**
+  * [Pricing](https://developer.squareup.com/reference/square_2020-06-25/objects/CatalogPricingRule) is now GA. It allows an application to configure catalog item pricing rules for the specified discounts to apply automatically. 
+
+* **Payments API**
+  * The [CardPaymentDetails](https://developer.squareup.com/reference/square_2020-06-25/objects/CardPaymentDetails) type now supports a new field, [refund_requires_card_presence](https://developer.squareup.com/reference/square_2020-06-25/objects/CardPaymentDetails#definition__property-refund_requires_card_presence). When set to true, the payment card must be physically present to refund a payment. 
+
+
 ## Version 3.20200528.0 (2020-05-28)
 ## API releases
 

README.md

@@ -9,14 +9,14 @@
 [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 ==================
 ## NOTICE: Square Connect Node.js SDK deprecated
-This Square Connect SDK will enter a security maintenance phase in Q4 2020 and will be RETIRED (EOL) in Q2 2021. In the security
+This Square Connect SDK will enter a security maintenance phase in Q3 2020 and will be RETIRED (EOL) in Q1 2021. In the security
 maintenance phase, this SDK will continue to receive support and security patches but will no longer receive bug fixes or product
 updates. Once it is retired, support and security patches will no longer be available.  A new SDK, more bespoke to the language, will be available once this SDK enters its security maintenance phase.
-The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning.  For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis).
+The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning.  For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https ://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis).
 
 | Security Maintenance | New SDK Release | Retired (EOL)  |
 | ------------- |-------------| -----|
-| Q4, 2020      | Q4, 2020 | Q2, 2021 |
+| Q3, 2020      | Q3, 2020 | Q1, 2021 |
 
 **If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://squ.re/2uLSRw5)**
 
@@ -186,6 +186,14 @@ Class | Method | HTTP request | Description
 *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.TeamApi* | [**bulkCreateTeamMembers**](docs/TeamApi.md#bulkCreateTeamMembers) | **POST** /v2/team-members/bulk-create | BulkCreateTeamMembers
+*SquareConnect.TeamApi* | [**bulkUpdateTeamMembers**](docs/TeamApi.md#bulkUpdateTeamMembers) | **POST** /v2/team-members/bulk-update | BulkUpdateTeamMembers
+*SquareConnect.TeamApi* | [**createTeamMember**](docs/TeamApi.md#createTeamMember) | **POST** /v2/team-members | CreateTeamMember
+*SquareConnect.TeamApi* | [**retrieveTeamMember**](docs/TeamApi.md#retrieveTeamMember) | **GET** /v2/team-members/{team_member_id} | RetrieveTeamMember
+*SquareConnect.TeamApi* | [**retrieveWageSetting**](docs/TeamApi.md#retrieveWageSetting) | **GET** /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting
+*SquareConnect.TeamApi* | [**searchTeamMembers**](docs/TeamApi.md#searchTeamMembers) | **POST** /v2/team-members/search | SearchTeamMembers
+*SquareConnect.TeamApi* | [**updateTeamMember**](docs/TeamApi.md#updateTeamMember) | **PUT** /v2/team-members/{team_member_id} | UpdateTeamMember
+*SquareConnect.TeamApi* | [**updateWageSetting**](docs/TeamApi.md#updateWageSetting) | **PUT** /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting
 *SquareConnect.TerminalApi* | [**cancelTerminalCheckout**](docs/TerminalApi.md#cancelTerminalCheckout) | **POST** /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout
 *SquareConnect.TerminalApi* | [**createTerminalCheckout**](docs/TerminalApi.md#createTerminalCheckout) | **POST** /v2/terminals/checkouts | CreateTerminalCheckout
 *SquareConnect.TerminalApi* | [**getTerminalCheckout**](docs/TerminalApi.md#getTerminalCheckout) | **GET** /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout
@@ -301,6 +309,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
  - [SquareConnect.BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md)
  - [SquareConnect.BreakType](docs/BreakType.md)
+ - [SquareConnect.BulkCreateTeamMembersRequest](docs/BulkCreateTeamMembersRequest.md)
+ - [SquareConnect.BulkCreateTeamMembersResponse](docs/BulkCreateTeamMembersResponse.md)
+ - [SquareConnect.BulkUpdateTeamMembersRequest](docs/BulkUpdateTeamMembersRequest.md)
+ - [SquareConnect.BulkUpdateTeamMembersResponse](docs/BulkUpdateTeamMembersResponse.md)
  - [SquareConnect.BusinessHours](docs/BusinessHours.md)
  - [SquareConnect.BusinessHoursPeriod](docs/BusinessHoursPeriod.md)
  - [SquareConnect.CalculateLoyaltyPointsRequest](docs/CalculateLoyaltyPointsRequest.md)
@@ -364,13 +376,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CatalogPricingType](docs/CatalogPricingType.md)
  - [SquareConnect.CatalogProductSet](docs/CatalogProductSet.md)
  - [SquareConnect.CatalogQuery](docs/CatalogQuery.md)
- - [SquareConnect.CatalogQueryCustomAttributeUsage](docs/CatalogQueryCustomAttributeUsage.md)
  - [SquareConnect.CatalogQueryExact](docs/CatalogQueryExact.md)
- - [SquareConnect.CatalogQueryFilteredItems](docs/CatalogQueryFilteredItems.md)
- - [SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilter](docs/CatalogQueryFilteredItemsCustomAttributeFilter.md)
- - [SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilterFilterType](docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md)
- - [SquareConnect.CatalogQueryFilteredItemsNullableAttribute](docs/CatalogQueryFilteredItemsNullableAttribute.md)
- - [SquareConnect.CatalogQueryFilteredItemsStockLevel](docs/CatalogQueryFilteredItemsStockLevel.md)
  - [SquareConnect.CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md)
  - [SquareConnect.CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md)
  - [SquareConnect.CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md)
@@ -428,6 +434,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CreateRefundResponse](docs/CreateRefundResponse.md)
  - [SquareConnect.CreateShiftRequest](docs/CreateShiftRequest.md)
  - [SquareConnect.CreateShiftResponse](docs/CreateShiftResponse.md)
+ - [SquareConnect.CreateTeamMemberRequest](docs/CreateTeamMemberRequest.md)
+ - [SquareConnect.CreateTeamMemberResponse](docs/CreateTeamMemberResponse.md)
  - [SquareConnect.CreateTerminalCheckoutRequest](docs/CreateTerminalCheckoutRequest.md)
  - [SquareConnect.CreateTerminalCheckoutResponse](docs/CreateTerminalCheckoutResponse.md)
  - [SquareConnect.Currency](docs/Currency.md)
@@ -508,6 +516,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.InventoryState](docs/InventoryState.md)
  - [SquareConnect.InventoryTransfer](docs/InventoryTransfer.md)
  - [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)
@@ -702,8 +712,12 @@ Class | Method | HTTP request | Description
  - [SquareConnect.RetrieveLoyaltyRewardResponse](docs/RetrieveLoyaltyRewardResponse.md)
  - [SquareConnect.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md)
  - [SquareConnect.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md)
+ - [SquareConnect.RetrieveTeamMemberRequest](docs/RetrieveTeamMemberRequest.md)
+ - [SquareConnect.RetrieveTeamMemberResponse](docs/RetrieveTeamMemberResponse.md)
  - [SquareConnect.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
  - [SquareConnect.RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
+ - [SquareConnect.RetrieveWageSettingRequest](docs/RetrieveWageSettingRequest.md)
+ - [SquareConnect.RetrieveWageSettingResponse](docs/RetrieveWageSettingResponse.md)
  - [SquareConnect.RevokeTokenRequest](docs/RevokeTokenRequest.md)
  - [SquareConnect.RevokeTokenResponse](docs/RevokeTokenResponse.md)
  - [SquareConnect.SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md)
@@ -731,6 +745,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md)
  - [SquareConnect.SearchShiftsRequest](docs/SearchShiftsRequest.md)
  - [SquareConnect.SearchShiftsResponse](docs/SearchShiftsResponse.md)
+ - [SquareConnect.SearchTeamMembersFilter](docs/SearchTeamMembersFilter.md)
+ - [SquareConnect.SearchTeamMembersQuery](docs/SearchTeamMembersQuery.md)
+ - [SquareConnect.SearchTeamMembersRequest](docs/SearchTeamMembersRequest.md)
+ - [SquareConnect.SearchTeamMembersResponse](docs/SearchTeamMembersResponse.md)
  - [SquareConnect.SearchTerminalCheckoutsRequest](docs/SearchTerminalCheckoutsRequest.md)
  - [SquareConnect.SearchTerminalCheckoutsResponse](docs/SearchTerminalCheckoutsResponse.md)
  - [SquareConnect.Shift](docs/Shift.md)
@@ -751,6 +769,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.SubmitEvidenceResponse](docs/SubmitEvidenceResponse.md)
  - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md)
  - [SquareConnect.TaxInclusionType](docs/TaxInclusionType.md)
+ - [SquareConnect.TeamMember](docs/TeamMember.md)
+ - [SquareConnect.TeamMemberAssignedLocations](docs/TeamMemberAssignedLocations.md)
+ - [SquareConnect.TeamMemberAssignedLocationsAssignmentType](docs/TeamMemberAssignedLocationsAssignmentType.md)
+ - [SquareConnect.TeamMemberStatus](docs/TeamMemberStatus.md)
  - [SquareConnect.Tender](docs/Tender.md)
  - [SquareConnect.TenderCardDetails](docs/TenderCardDetails.md)
  - [SquareConnect.TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md)
@@ -783,6 +805,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.UpdateOrderResponse](docs/UpdateOrderResponse.md)
  - [SquareConnect.UpdateShiftRequest](docs/UpdateShiftRequest.md)
  - [SquareConnect.UpdateShiftResponse](docs/UpdateShiftResponse.md)
+ - [SquareConnect.UpdateTeamMemberRequest](docs/UpdateTeamMemberRequest.md)
+ - [SquareConnect.UpdateTeamMemberResponse](docs/UpdateTeamMemberResponse.md)
+ - [SquareConnect.UpdateWageSettingRequest](docs/UpdateWageSettingRequest.md)
+ - [SquareConnect.UpdateWageSettingResponse](docs/UpdateWageSettingResponse.md)
  - [SquareConnect.UpdateWorkweekConfigRequest](docs/UpdateWorkweekConfigRequest.md)
  - [SquareConnect.UpdateWorkweekConfigResponse](docs/UpdateWorkweekConfigResponse.md)
  - [SquareConnect.UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md)
@@ -949,6 +975,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.V1VariationPricingType](docs/V1VariationPricingType.md)
  - [SquareConnect.VoidTransactionRequest](docs/VoidTransactionRequest.md)
  - [SquareConnect.VoidTransactionResponse](docs/VoidTransactionResponse.md)
+ - [SquareConnect.WageSetting](docs/WageSetting.md)
  - [SquareConnect.Weekday](docs/Weekday.md)
  - [SquareConnect.WorkweekConfig](docs/WorkweekConfig.md)
 

docs/BulkCreateTeamMembersRequest.md

@@ -0,0 +1,12 @@
+# SquareConnect.BulkCreateTeamMembersRequest
+
+### Description
+
+Represents a bulk create request for `TeamMember` objects.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**team_members** | [**{String: CreateTeamMemberRequest}**](CreateTeamMemberRequest.md) | The data which will be used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. | 
+
+

docs/BulkCreateTeamMembersResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect.BulkCreateTeamMembersResponse
+
+### Description
+
+Represents a response from a bulk create request, containing the created `TeamMember` objects or error messages.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**team_members** | [**{String: CreateTeamMemberResponse}**](CreateTeamMemberResponse.md) | The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. | [optional] 
+**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] 
+
+

docs/BulkUpdateTeamMembersRequest.md

@@ -0,0 +1,12 @@
+# SquareConnect.BulkUpdateTeamMembersRequest
+
+### Description
+
+Represents a bulk update request for `TeamMember` objects.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**team_members** | [**{String: UpdateTeamMemberRequest}**](UpdateTeamMemberRequest.md) | The data which will be used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. | 
+
+

docs/BulkUpdateTeamMembersResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect.BulkUpdateTeamMembersResponse
+
+### Description
+
+Represents a response from a bulk update request, containing the updated `TeamMember` objects or error messages.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**team_members** | [**{String: UpdateTeamMemberResponse}**](UpdateTeamMemberResponse.md) | The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. | [optional] 
+**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] 
+
+

docs/Card.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **exp_year** | **Number** | The four-digit year of the card's expiration date. | [optional] 
 **cardholder_name** | **String** | The name of the cardholder. | [optional] 
 **billing_address** | [**Address**](Address.md) | The billing address for this card. | [optional] 
-**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based  on the card number, to identify the card across multiple locations within a single application. | [optional] 
+**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] 
 **card_type** | **String** | The type of the card. The Card object includes this field only in response to Payments API calls. See [CardType](#type-cardtype) for possible values | [optional] [beta]
 **prepaid_type** | **String** | Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls. See [CardPrepaidType](#type-cardprepaidtype) for possible values | [optional] [beta]
 **bin** | **String** | The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field. | [optional] 

docs/CardBrand.md

@@ -23,4 +23,10 @@
 
 * `SQUARE_CAPITAL_CARD` (value: `"SQUARE_CAPITAL_CARD"`)
 
+* `INTERAC` (value: `"INTERAC"`)
+
+* `EFTPOS` (value: `"EFTPOS"`)
+
+* `FELICA` (value: `"FELICA"`)
+
 

docs/CardPaymentDetails.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **verification_results** | **String** | For EMV payments, the results of the cardholder verification.  Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`. | [optional] 
 **statement_description** | **String** | The statement description sent to the card networks.  Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis. | [optional] 
 **device_details** | [**DeviceDetails**](DeviceDetails.md) | Details about the device that took the payment. | [optional] 
+**refund_requires_card_presence** | **Boolean** | Whether or not the card is required to be physically present in order for the payment to be refunded.  If true, the card is required to be present. | [optional] [beta]
 **errors** | [**[Error]**](Error.md) | Information on errors encountered during the request. | [optional] 
 
 

docs/CatalogApi.md

@@ -360,7 +360,7 @@ Name | Type | Description  | Notes
 
 SearchCatalogObjects
 
-Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues).
+Queries the targeted catalog using a variety of query expressions.  Supported query expressions are of the following types: - [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), - [CatalogQueryExact](#type-catalogqueryexact), - [CatalogQueryRange](#type-catalogqueryrange), - [CatalogQueryText](#type-catalogquerytext), - [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), - [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), - [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and - [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues).
 
 ### Example
 ```javascript

docs/CatalogCustomAttributeDefinitionNumberConfig.md

@@ -8,6 +8,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**precision** | **Number** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example:  - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc.  Default: 3 | [optional] 
+**precision** | **Number** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example:  - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc.  Default: 5 | [optional]