Merge pull request #117 from square/release/4.20201028.5

Release 4.20201028.5
square · Oct 28, 2020 · 0b91ba4 · 0b91ba4
2 parents 9d7a54b + fa60202
commit 0b91ba4
Show file tree

Hide file tree

Showing 277 changed files with 4,331 additions and 1,224 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,37 @@
 # Change Log
 
+## Version 4.20201028.5 (2020-10-28T00:00)
+
+## Existing API updates
+
+* **Terminal API.** New endpoints to enable sellers in Canada refund Interac payments.
+    *  New endpoints:
+
+       * [CreateTerminalRefund](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/create-terminal-refund)
+        * [GetTerminalRefund](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/get-terminal-refund)
+       * [CancelTerminalRefund](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/cancel-terminal-refund)
+       * [SearchTerminalRefunds](https://developer.squareup.com/reference/square_2020-10-28/terminal-api/search-terminal-refunds)
+
+  * New webhooks:
+     * `terminal.refund.created`. Notification of a new Terminal refund request.
+     * `terminal.refund.updated`. Notification that a Terminal refund request state is changed.
+
+  * New topic [Refund Interac Payments.](https://developer.squareup.com/docs/terminal-api/square-terminal-refunds). Describes how to refund Interac payments.
+
+*  **Loyalty API (beta):** 
+   *  [SearchLoyaltyAccounts.](https://developer.squareup.com/reference/square_2020-10-28/loyalty-api/search-loyalty-accounts) The endpoint supports a new query parameter to search by customer ID.
+
+* **Locations API:** 
+  * [Location](https://developer.squareup.com/reference/square_2020-10-28/objects/Location) object. Has a new read-only field,[full_format_logo_url](https://developer.squareup.com/reference/square_2020-10-28/objects/Location#definition__property-full_format_logo_url), which provides URL of a full-format logo image for the location. 
+  * [Webhooks.](https://developer.squareup.com/docs/webhooks-api/subscribe-to-events#locations) The Locations API now supports notifications for when a location is created and when a location is updated.
+
+* **Orders API:** 
+  * [RetrieveOrder](https://developer.squareup.com/reference/square_2020-10-28/orders-api/retrieve-order), new endpoint. For more information, see the [Retrieve Orders](https://developer.squareup.com/docs/orders-api/manage-orders#retrieve-orders) overview.
+
+* **Invoices API (beta):**
+  * [Invoice](https://developer.squareup.com/reference/square_2020-10-28/objects/Invoice) object. The [payment_requests](https://developer.squareup.com/reference/square_2020-10-28/objects/Invoice#definition__property-payment_requests) field can now contain up to 13 payment requests, with a maximum of 12 `INSTALLMENT` request types. This is a service-level change that applies to all Square API versions. For more information, see [Payment requests.](https://developer.squareup.com/docs/invoices-api/overview#payment-requests)
+
+
 ## Version 4.20200923.4 (2020-09-23T00:00)
 ## Existing API updates 
 * Invoices API (beta)
@@ -159,17 +191,17 @@
 ## Version 3.20200422.0 (2020-04-22)
 ## API releases
 * **Terminal API.** The new Terminal API lets a custom third-party POS app integrate with the Square Terminal to send terminal checkout requests to collect payments.
-  * For an overview, see [Overview](/terminal-api/overview).
+  * For an overview, see [Overview](https://developer.squareup.com/docs/terminal-api/overview).
   * For technical reference, see [Terminal API](https://developer.squareup.com/reference/square/terminal-api).
 
 * **Devices API.** The new Devices API lets a custom third-party POS app generate a code used to sign in to a Square Terminal to create a pairing that lets the POS app send terminal checkout requests. For technical reference, see [Devices API](https://developer.squareup.com/reference/square/devices-api).
 
 * **Customer Groups API (beta).** The new Customer Groups API (Beta) enables full CRUD management of customer groups, including the ability to list, retrieve, create, update, and delete customer groups. Previously, this functionality was only available through the Square dashboard and point-of-sale product interfaces. 
-  * For an overview, see [Overview](/customer-groups-api/what-it-does) 
+  * For an overview, see [Overview](https://developer.squareup.com/docs/customer-groups-api/what-it-does) 
   * For technical reference, see [Customer Groups](https://developer.squareup.com/reference/square/customer-groups-api).  
 
 * **Customer Segments API (beta).** The new Customer Segments API (Beta) lets you list and retrieve customer segment (also called smart groups) information. Coupled with the new `segment_ids` field on the customer resource, this API lets you better understand and track the customer segments to which a customer belongs.
-  * For an overview, see [Overview](/customer-segmentss-api/what-it-does) 
+  * For an overview, see [Overview](https://developer.squareup.com/docs/customer-segmentss-api/what-it-does) 
   * For technical reference, see [Customer Segments]( https://developer.squareup.com/reference/square/customer-segments-api).  
 
 
@@ -207,7 +239,7 @@
   * [CatalogQuickAmountsSettings](https://developer.squareup.com/reference/square/objects/CatalogQuickAmountsSettings) type. Added to support predefined custom payment amounts in the Square Register checkout dialog box.
   * ENUM`CatalogItemProductType`. The ENUM value `GIFT_CARD` is now deprecated.
 
-* **Payments API.** See [Take Payments and Collect Fees](/payments-api/take-payments-and-collect-fees) for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally.   
+* **Payments API.** See [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally.   
 
 
 
@@ -268,7 +300,7 @@ All SDKs have been updated to support the following changes:
 
 ## Version 2.3.0-20191217 (2019-12-17)
 !!!important
-Square is excited to announce the public release of customized SDKs for [Java](https://github.com/square/square-java-sdk) and [.NET](https://github.com/square/square-dotnet-sdk). For more information, see [Square SDKs](/sdks).
+Square is excited to announce the public release of customized SDKs for [Java](https://github.com/square/square-java-sdk) and [.NET](https://github.com/square/square-dotnet-sdk). For more information, see [Square SDKs](https://developer.squareup.com/docs/sdks).
 !!!
 
 * __GA release:__ SDKs updated to support new `receipt_url` and `receipt_number` fields added to the  [Payment](https://developer.squareup.com/reference/square/objects/Payment) type.  
@@ -280,7 +312,7 @@ Square is excited to announce the public release of customized SDKs for [Java](h
 
 ## Version 2.20191120.0 (2019-11-20)
 !!!important
-Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](/migrate-from-v1) information page for details.
+Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](https://developer.squareup.com/docs/migrate-from-v1) information page for details.
 !!!
 
 * __GA releases:__ SDKs now support the new `modify_tax_basis` field to Discounts and v2 Sandbox

diff --git a/README.md b/README.md
@@ -184,6 +184,7 @@ Class | Method | HTTP request | Description
 *SquareConnect.OrdersApi* | [**calculateOrder**](docs/OrdersApi.md#calculateOrder) | **POST** /v2/orders/calculate | CalculateOrder
 *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* | [**retrieveOrder**](docs/OrdersApi.md#retrieveOrder) | **GET** /v2/orders/{order_id} | RetrieveOrder
 *SquareConnect.OrdersApi* | [**searchOrders**](docs/OrdersApi.md#searchOrders) | **POST** /v2/orders/search | SearchOrders
 *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
@@ -210,9 +211,13 @@ Class | Method | HTTP request | Description
 *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* | [**cancelTerminalRefund**](docs/TerminalApi.md#cancelTerminalRefund) | **POST** /v2/terminals/refunds/{terminal_refund_id}/cancel | CancelTerminalRefund
 *SquareConnect.TerminalApi* | [**createTerminalCheckout**](docs/TerminalApi.md#createTerminalCheckout) | **POST** /v2/terminals/checkouts | CreateTerminalCheckout
+*SquareConnect.TerminalApi* | [**createTerminalRefund**](docs/TerminalApi.md#createTerminalRefund) | **POST** /v2/terminals/refunds | CreateTerminalRefund
 *SquareConnect.TerminalApi* | [**getTerminalCheckout**](docs/TerminalApi.md#getTerminalCheckout) | **GET** /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout
+*SquareConnect.TerminalApi* | [**getTerminalRefund**](docs/TerminalApi.md#getTerminalRefund) | **GET** /v2/terminals/refunds/{terminal_refund_id} | GetTerminalRefund
 *SquareConnect.TerminalApi* | [**searchTerminalCheckouts**](docs/TerminalApi.md#searchTerminalCheckouts) | **POST** /v2/terminals/checkouts/search | SearchTerminalCheckouts
+*SquareConnect.TerminalApi* | [**searchTerminalRefunds**](docs/TerminalApi.md#searchTerminalRefunds) | **POST** /v2/terminals/refunds/search | SearchTerminalRefunds
 *SquareConnect.TransactionsApi* | [**captureTransaction**](docs/TransactionsApi.md#captureTransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction
 *SquareConnect.TransactionsApi* | [**charge**](docs/TransactionsApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge
 *SquareConnect.TransactionsApi* | [**createRefund**](docs/TransactionsApi.md#createRefund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund
@@ -343,6 +348,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CancelSubscriptionResponse](docs/CancelSubscriptionResponse.md)
  - [SquareConnect.CancelTerminalCheckoutRequest](docs/CancelTerminalCheckoutRequest.md)
  - [SquareConnect.CancelTerminalCheckoutResponse](docs/CancelTerminalCheckoutResponse.md)
+ - [SquareConnect.CancelTerminalRefundRequest](docs/CancelTerminalRefundRequest.md)
+ - [SquareConnect.CancelTerminalRefundResponse](docs/CancelTerminalRefundResponse.md)
  - [SquareConnect.CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
  - [SquareConnect.CaptureTransactionResponse](docs/CaptureTransactionResponse.md)
  - [SquareConnect.Card](docs/Card.md)
@@ -402,6 +409,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CatalogQueryItemsForTax](docs/CatalogQueryItemsForTax.md)
  - [SquareConnect.CatalogQueryPrefix](docs/CatalogQueryPrefix.md)
  - [SquareConnect.CatalogQueryRange](docs/CatalogQueryRange.md)
+ - [SquareConnect.CatalogQuerySet](docs/CatalogQuerySet.md)
  - [SquareConnect.CatalogQuerySortedAttribute](docs/CatalogQuerySortedAttribute.md)
  - [SquareConnect.CatalogQueryText](docs/CatalogQueryText.md)
  - [SquareConnect.CatalogQuickAmount](docs/CatalogQuickAmount.md)
@@ -462,6 +470,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CreateTeamMemberResponse](docs/CreateTeamMemberResponse.md)
  - [SquareConnect.CreateTerminalCheckoutRequest](docs/CreateTerminalCheckoutRequest.md)
  - [SquareConnect.CreateTerminalCheckoutResponse](docs/CreateTerminalCheckoutResponse.md)
+ - [SquareConnect.CreateTerminalRefundRequest](docs/CreateTerminalRefundRequest.md)
+ - [SquareConnect.CreateTerminalRefundResponse](docs/CreateTerminalRefundResponse.md)
  - [SquareConnect.Currency](docs/Currency.md)
  - [SquareConnect.CustomAttributeFilter](docs/CustomAttributeFilter.md)
  - [SquareConnect.Customer](docs/Customer.md)
@@ -538,6 +548,9 @@ Class | Method | HTTP request | Description
  - [SquareConnect.GetTeamMemberWageResponse](docs/GetTeamMemberWageResponse.md)
  - [SquareConnect.GetTerminalCheckoutRequest](docs/GetTerminalCheckoutRequest.md)
  - [SquareConnect.GetTerminalCheckoutResponse](docs/GetTerminalCheckoutResponse.md)
+ - [SquareConnect.GetTerminalRefundRequest](docs/GetTerminalRefundRequest.md)
+ - [SquareConnect.GetTerminalRefundResponse](docs/GetTerminalRefundResponse.md)
+ - [SquareConnect.InlineTypes](docs/InlineTypes.md)
  - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md)
  - [SquareConnect.InventoryAlertType](docs/InventoryAlertType.md)
  - [SquareConnect.InventoryChange](docs/InventoryChange.md)
@@ -760,6 +773,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.RetrieveLoyaltyRewardResponse](docs/RetrieveLoyaltyRewardResponse.md)
  - [SquareConnect.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md)
  - [SquareConnect.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md)
+ - [SquareConnect.RetrieveOrderRequest](docs/RetrieveOrderRequest.md)
+ - [SquareConnect.RetrieveOrderResponse](docs/RetrieveOrderResponse.md)
  - [SquareConnect.RetrieveSubscriptionRequest](docs/RetrieveSubscriptionRequest.md)
  - [SquareConnect.RetrieveSubscriptionResponse](docs/RetrieveSubscriptionResponse.md)
  - [SquareConnect.RetrieveTeamMemberRequest](docs/RetrieveTeamMemberRequest.md)
@@ -810,6 +825,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.SearchTeamMembersResponse](docs/SearchTeamMembersResponse.md)
  - [SquareConnect.SearchTerminalCheckoutsRequest](docs/SearchTerminalCheckoutsRequest.md)
  - [SquareConnect.SearchTerminalCheckoutsResponse](docs/SearchTerminalCheckoutsResponse.md)
+ - [SquareConnect.SearchTerminalRefundsRequest](docs/SearchTerminalRefundsRequest.md)
+ - [SquareConnect.SearchTerminalRefundsResponse](docs/SearchTerminalRefundsResponse.md)
  - [SquareConnect.Shift](docs/Shift.md)
  - [SquareConnect.ShiftFilter](docs/ShiftFilter.md)
  - [SquareConnect.ShiftFilterStatus](docs/ShiftFilterStatus.md)
@@ -840,8 +857,6 @@ Class | Method | HTTP request | Description
  - [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)
@@ -851,6 +866,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.TerminalCheckoutQuery](docs/TerminalCheckoutQuery.md)
  - [SquareConnect.TerminalCheckoutQueryFilter](docs/TerminalCheckoutQueryFilter.md)
  - [SquareConnect.TerminalCheckoutQuerySort](docs/TerminalCheckoutQuerySort.md)
+ - [SquareConnect.TerminalRefund](docs/TerminalRefund.md)
+ - [SquareConnect.TerminalRefundQuery](docs/TerminalRefundQuery.md)
+ - [SquareConnect.TerminalRefundQueryFilter](docs/TerminalRefundQueryFilter.md)
+ - [SquareConnect.TerminalRefundQuerySort](docs/TerminalRefundQuerySort.md)
  - [SquareConnect.TimeRange](docs/TimeRange.md)
  - [SquareConnect.TipSettings](docs/TipSettings.md)
  - [SquareConnect.Transaction](docs/Transaction.md)
@@ -1044,6 +1063,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.V1Variation](docs/V1Variation.md)
  - [SquareConnect.V1VariationInventoryAlertType](docs/V1VariationInventoryAlertType.md)
  - [SquareConnect.V1VariationPricingType](docs/V1VariationPricingType.md)
+ - [SquareConnect.VersionedCatalogObject](docs/VersionedCatalogObject.md)
  - [SquareConnect.VoidTransactionRequest](docs/VoidTransactionRequest.md)
  - [SquareConnect.VoidTransactionResponse](docs/VoidTransactionResponse.md)
  - [SquareConnect.WageSetting](docs/WageSetting.md)

diff --git a/docs/ApplePayApi.md b/docs/ApplePayApi.md
@@ -26,7 +26,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 var apiInstance = new SquareConnect.ApplePayApi();
 
-var body = new SquareConnect.RegisterDomainRequest(); // RegisterDomainRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+var body = SquareConnect.ApplePayApi.constructFromObject({}); // RegisterDomainRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
 
 apiInstance.registerDomain(body).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);