Merge pull request #86 from square/release/2.20200122.1

Release 2.20200122.1
square · Feb 12, 2020 · efe1eb6 · efe1eb6
2 parents 143c5d4 + 5252b15
commit efe1eb6
Show file tree

Hide file tree

Showing 196 changed files with 287 additions and 280 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,12 @@
 # Change Log
 
+## Version 2.20200122.1 (2020-02-12)
+**Documentation Changes**
+
+* Minor updates for Payments API descriptions
+* Deprecation & retirement dates added for Transactions API endpoints
+
+
 ## Version 2.20200122.0 (2020-01-22)
 * New field:  The **Employee** object now has an `is_owner` field.
 * New field:  The **Card** enumeration has a new `SQUARE_CAPITAL_CARD` enum value to support a Square one-time Installments payment.

diff --git a/docs/CancelPaymentByIdempotencyKeyResponse.md b/docs/CancelPaymentByIdempotencyKeyResponse.md
@@ -2,7 +2,7 @@
 
 ### Description
 
-Return value from the [CancelPaymentByIdempotencyKey](#endpoint-payments-cancelpaymentbyidempotencykey) endpoint.  On success, `errors` will be empty.
+Return value from the [CancelPaymentByIdempotencyKey](#endpoint-payments-cancelpaymentbyidempotencykey) endpoint. On success, `errors` will be empty.
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/CreatePaymentRequest.md b/docs/CreatePaymentRequest.md
@@ -8,17 +8,17 @@ Creates a payment from the source (nonce, card on file, etc.)  The `PAYMENTS_WRI
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **source_id** | **String** | The ID for the source of funds for this payment.  This can be a nonce generated by the Payment Form or a card on file made with the Customers API. | 
-**idempotency_key** | **String** | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request.   Max: 45 characters  See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | 
+**idempotency_key** | **String** | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request.  Max: 45 characters  See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | 
 **amount_money** | [**Money**](Money.md) | The amount of money to accept for this payment, not including &#x60;tip_money&#x60;.  Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.  The currency code must match the currency associated with the business that is accepting the payment. | 
 **tip_money** | [**Money**](Money.md) | The amount designated as a tip, in addition to &#x60;amount_money&#x60;  Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.  The currency code must match the currency associated with the business that is accepting the payment. | [optional] 
-**app_fee_money** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller.  Cannot be more than 90% of the total amount of the Payment.  Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.  The fee currency code must match the currency associated with the merchant that is accepting the payment. The application must be from a developer  account in the same country as the merchant.  For more information about the application fee scenario, see   [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] 
-**autocomplete** | **Boolean** | If set to &#x60;true&#x60;, this payment will be completed when possible. If set to &#x60;false&#x60;, this payment will be held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see  [Delayed Payments](https://developer.squareup.com/docs/payments-api/take-payments#delayed-payments).  Default: true | [optional] 
+**app_fee_money** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller.  Cannot be more than 90% of the total amount of the Payment.  Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.  The fee currency code must match the currency associated with the merchant that is accepting the payment. The application must be from a developer account in the same country, and using the same currency code, as the merchant.  For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] 
+**autocomplete** | **Boolean** | If set to &#x60;true&#x60;, this payment will be completed when possible. If set to &#x60;false&#x60;, this payment will be held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see [Delayed Payments](https://developer.squareup.com/docs/payments-api/take-payments#delayed-payments).  Default: true | [optional] 
 **order_id** | **String** | Associate a previously created order with this payment | [optional] 
 **customer_id** | **String** | The ID of the customer associated with the payment. Required if the &#x60;source_id&#x60; refers to a card on file created using the Customers API. | [optional] 
 **location_id** | **String** | The location ID to associate with the payment. If not specified, the default location is used. | [optional] 
 **reference_id** | **String** | A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system. For example, you might specify an order ID that is generated by a third-party shopping cart.  Limit 40 characters. | [optional] 
 **verification_token** | **String** | An identifying token generated by &#x60;SqPaymentForm.verifyBuyer()&#x60;. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.  See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). | [optional] 
-**accept_partial_authorization** | **Boolean** | If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested.  Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5.  You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment.  Cannot be &#x60;true&#x60; when &#x60;autocomplete &#x3D; true&#x60;.  For more information, see  [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card).  Default: false | [optional] [beta]
+**accept_partial_authorization** | **Boolean** | If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested.  Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5.  You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment.  Cannot be &#x60;true&#x60; when &#x60;autocomplete &#x3D; true&#x60;.  For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card).  Default: false | [optional] [beta]
 **buyer_email_address** | **String** | The buyer&#39;s e-mail address | [optional] 
 **billing_address** | [**Address**](Address.md) | The buyer&#39;s billing address. | [optional] 
 **shipping_address** | [**Address**](Address.md) | The buyer&#39;s shipping address. | [optional] 

diff --git a/docs/ListPaymentsRequest.md b/docs/ListPaymentsRequest.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **end_time** | **String** | Timestamp for the end of the requested reporting period, in RFC 3339 format.  Default: The current time. | [optional] 
 **sort_order** | **String** | The order in which results are listed. - &#x60;ASC&#x60; - oldest to newest - &#x60;DESC&#x60; - newest to oldest (default). | [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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 
-**location_id** | **String** | ID of location associated with payment | [optional] 
+**location_id** | **String** | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. | [optional] 
 **total** | **Number** | The exact amount in the total_money for a &#x60;Payment&#x60;. | [optional] 
 **last_4** | **String** | The last 4 digits of &#x60;Payment&#x60; card. | [optional] 
 **card_brand** | **String** | The brand of &#x60;Payment&#x60; card. For example, &#x60;VISA&#x60; | [optional] 

diff --git a/docs/Payment.md b/docs/Payment.md
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 **id** | **String** | Unique ID for the payment. | [optional] 
 **created_at** | **String** | Timestamp of when the payment was created, in RFC 3339 format. | [optional] 
 **updated_at** | **String** | Timestamp of when the payment was last updated, in RFC 3339 format. | [optional] 
-**amount_money** | [**Money**](Money.md) | The amount of money processed for this payment, not including &#x60;tip_money&#x60;. Specified in the smallest denomination of the applicable currency. For example,  US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] 
+**amount_money** | [**Money**](Money.md) | The amount of money processed for this payment, not including &#x60;tip_money&#x60;. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] 
 **tip_money** | [**Money**](Money.md) | The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] 
-**total_money** | [**Money**](Money.md) | The total money for the payment, including &#x60;amount_money&#x60; and &#x60;tip_money&#x60;. Specified in the smallest denomination of the applicable currency.  For example, US dollar amounts are specified in cents. | [optional] 
-**app_fee_money** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.   For more information, see   [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).  Cannot be more than 90% of the &#x60;total_money&#x60; value. | [optional] 
+**total_money** | [**Money**](Money.md) | The total money for the payment, including &#x60;amount_money&#x60; and &#x60;tip_money&#x60;. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] 
+**app_fee_money** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.  For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).  Cannot be more than 90% of the &#x60;total_money&#x60; value. | [optional] 
 **processing_fee** | [**[ProcessingFee]**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square on this payment. | [optional] 
 **refunded_money** | [**Money**](Money.md) | Total amount of the payment refunded to-date. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] 
 **status** | **String** | Indicates whether the payment is &#x60;APPROVED&#x60;, &#x60;COMPLETED&#x60;, &#x60;CANCELED&#x60;, or &#x60;FAILED&#x60;. | [optional] 

diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md
@@ -66,7 +66,7 @@ Name | Type | Description  | Notes
 
 CancelPaymentByIdempotencyKey
 
-Cancels (voids) a payment identified by the idempotency key that is specified in the request.   Use this method when status of a CreatePayment request is unknown.  For example, after you send a CreatePayment  request a network error occurs and you don&#39;t get a response. In this case, you can direct  Square to cancel the payment using this endpoint. In the request, you provide the same idempotency  key that you provided in your CreatePayment request you want  to cancel. After cancelling the  payment, you can submit your CreatePayment request again.  Note that if no payment with the specified idempotency key is found, no action is taken, the end  point returns successfully.
+Cancels (voids) a payment identified by the idempotency key that is specified in the request.  Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don&#39;t get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want  to cancel. After cancelling the payment, you can submit your CreatePayment request again.  Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully.
 
 ### Example
 ```javascript
@@ -276,7 +276,7 @@ var opts = {
   'endTime': "endTime_example", // String | Timestamp for the end of the requested reporting period, in RFC 3339 format.  Default: The current time.
   'sortOrder': "sortOrder_example", // String | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default).
   'cursor': "cursor_example", // 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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
-  'locationId': "locationId_example", // String | ID of location associated with payment
+  'locationId': "locationId_example", // String | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant.
   'total': 789, // Number | The exact amount in the total_money for a `Payment`.
   'last4': "last4_example", // String | The last 4 digits of `Payment` card.
   'cardBrand': "cardBrand_example" // String | The brand of `Payment` card. For example, `VISA`
@@ -297,7 +297,7 @@ Name | Type | Description  | Notes
  **endTime** | **String**| Timestamp for the end of the requested reporting period, in RFC 3339 format.  Default: The current time. | [optional] 
  **sortOrder** | **String**| The order in which results are listed. - &#x60;ASC&#x60; - oldest to newest - &#x60;DESC&#x60; - newest to oldest (default). | [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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 
- **locationId** | **String**| ID of location associated with payment | [optional] 
+ **locationId** | **String**| Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. | [optional] 
  **total** | **Number**| The exact amount in the total_money for a &#x60;Payment&#x60;. | [optional] 
  **last4** | **String**| The last 4 digits of &#x60;Payment&#x60; card. | [optional] 
  **cardBrand** | **String**| The brand of &#x60;Payment&#x60; card. For example, &#x60;VISA&#x60; | [optional]