Merge pull request #121 from square/release/2.20200122.1

Release 2.20200122.1

CHANGES.md

@@ -1,9 +1,15 @@
 # Change Log
 
+## Version 2.20200122.2 (2020-02-12)
+**Documentation Changes**
+
+* Minor updates for Payments API descriptions
+* Deprecation & retirement dates added for Transactions API endpoints
+
+
 ## Version 2.20200122.1 (2020-02-04)
 * Addresses bug that doesn't allow `getV1BatchTokenFromHeaders` to retrieve batch_token
 
-
 ## 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.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "square/connect",
-    "version": "2.20200122.1",
+    "version": "2.20200122.2",
     "description": "PHP client library for the Square Connect v2 API",
     "keywords": [
         "swagger",

docs/Api/PaymentsApi.md

@@ -65,7 +65,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'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'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
 ```php
@@ -272,7 +272,7 @@ $begin_time = "begin_time_example"; // string | Timestamp for the beginning of t
 $end_time = "end_time_example"; // string | Timestamp for the end of the requested reporting period, in RFC 3339 format.  Default: The current time.
 $sort_order = "sort_order_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.
-$location_id = "location_id_example"; // string | ID of location associated with payment
+$location_id = "location_id_example"; // string | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant.
 $total = 789; // int | The exact amount in the total_money for a `Payment`.
 $last_4 = "last_4_example"; // string | The last 4 digits of `Payment` card.
 $card_brand = "card_brand_example"; // string | The brand of `Payment` card. For example, `VISA`
@@ -294,7 +294,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. - `ASC` - oldest to newest - `DESC` - 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** | **int**| The exact amount in the total_money for a `Payment`. | [optional]
  **last_4** | **string**| The last 4 digits of `Payment` card. | [optional]
  **card_brand** | **string**| The brand of `Payment` card. For example, `VISA` | [optional]

docs/Api/TransactionsApi.md

@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 CaptureTransaction
 
-Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information.
+Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---  See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information.
 
 ### Example
 ```php
@@ -70,7 +70,7 @@ Name | Type | Description  | Notes
 
 Charge
 
-Charges a card represented by a card nonce or a customer's card on file.  Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment)  Your request to this endpoint must include _either_:  - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file)  In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request:  - `buyer_email_address` - At least one of `billing_address` or `shipping_address`  When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction.
+Charges a card represented by a card nonce or a customer's card on file.  Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment)  ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---  Your request to this endpoint must include _either_:  - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file)  In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request:  - `buyer_email_address` - At least one of `billing_address` or `shipping_address`  When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction.
 
 ### Example
 ```php
@@ -121,7 +121,7 @@ Name | Type | Description  | Notes
 
 CreateRefund
 
-Initiates a refund for a previously charged tender.  Deprecated - recommend using [RefundPayment](#endpoint-refunds-refundpayment)  You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior.  NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app).
+Initiates a refund for a previously charged tender.  Deprecated - recommend using [RefundPayment](#endpoint-refunds-refundpayment)  ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---   You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior.  NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app).
 
 ### Example
 ```php
@@ -174,7 +174,7 @@ Name | Type | Description  | Notes
 
 ListRefunds
 
-Lists refunds for one of a business's locations.  Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)  In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications.  Refunds with a `status` of `PENDING` are not currently included in this endpoint's response.  Max results per [page](#paginatingresults): 50
+Lists refunds for one of a business's locations.  Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)  ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---   In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications.  Refunds with a `status` of `PENDING` are not currently included in this endpoint's response.  Max results per [page](#paginatingresults): 50
 
 ### Example
 ```php
@@ -231,7 +231,7 @@ Name | Type | Description  | Notes
 
 ListTransactions
 
-Lists transactions for a particular location.  Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)  Transactions include payment information from sales and exchanges and refund information from returns and exchanges.  Max results per [page](#paginatingresults): 50
+Lists transactions for a particular location.  Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---   Transactions include payment information from sales and exchanges and refund information from returns and exchanges.  Max results per [page](#paginatingresults): 50
 
 ### Example
 ```php
@@ -288,7 +288,7 @@ Name | Type | Description  | Notes
 
 RetrieveTransaction
 
-Retrieves details for a single transaction.  Deprecated - recommend using [BatchRetrieveOrders](#endpoint-batchretrieveorders)
+Retrieves details for a single transaction.  Deprecated - recommend using [BatchRetrieveOrders](#endpoint-batchretrieveorders) ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---
 
 ### Example
 ```php
@@ -339,7 +339,7 @@ Name | Type | Description  | Notes
 
 VoidTransaction
 
-Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information.
+Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  ---  - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api)  ---  See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information.
 
 ### Example
 ```php

docs/Model/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 | Getter | Setter | Type | Description | Notes