Generated PR for Release: 9.1.0.20210317

Author: autobot

CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change Log
 
+## Version 9.1.0.20210317 (2021-03-17)
+
+## Existing API updates
+
+* **Payments API:**
+  * [CreatePayment](https://developer.squareup.com/reference/square_2021-03-17/payments-api/create-payment). Until now, the `CreatePayment` endpoint supported only taking card payments. In this release, the API now supports cash and external payments. For more information, see [Take Payments.](https://developer.squareup.com/docs/payments-api/take-payments)
+  * [UpdatePayment](https://developer.squareup.com/reference/square_2021-03-17/payments-api/update-payment). This new  endpoint enables developers to change the payment amount and tip amount after a payment is created. For more information, see [Update Payments.](https://developer.squareup.com/docs/payments-api/update-payments)
+ 
+* **Invoices API:**
+  * [InvoiceDeliveryMethod](https://developer.squareup.com/reference/square_2021-03-17/enums/InvoiceDeliveryMethod) enum. Added the read-only `SMS` value.  
+  * [InvoiceRequestMethod](https://developer.squareup.com/reference/square_2021-03-17/enums/InvoiceRequestMethod) enum (deprecated). Added the read-only `SMS`, `SMS_CHARGE_CARD_ON_FILE`, and `SMS_CHARGE_BANK_ON_FILE` values for backward compatibility.  
+  
+  These values direct Square to send invoices and receipts to customers using SMS (text message). SMS settings can be configured from first-party Square applications only; they cannot be configured from the Invoices API. Square does not send invoice reminders when using SMS to communicate with customers.
+
+
+* **Terminal API:**
+  * [TerminalCheckout](https://developer.squareup.com/reference/square_2021-03-17/objects/TerminalCheckout). Previously, `TerminalCheckout` only supported tapped, dipped, or swiped credit cards. It now supports manual card entry and e-money. Added the `payment_type` field to denote a request for a manually entered payment card or an e-money payment.
+  * [TerminalCheckoutPaymentType.](https://developer.squareup.com/reference/square_2021-03-17enums/TerminalCheckoutPaymentType) A new enum for the Terminal checkout payment types that can be requested.
+  * [E-money support](https://developer.squareup.com/docs/terminal-api/e-money-payments) is now available for Terminal checkout requests in Japan.
+
+
+## SDKs
+* **Square Java SDK:**
+  * Updated the OkHttp dependency to version 4.9.0.
+  * Fixed a `NullPointerException` when passing an empty order ID to the `UpdateOrder` method.
+
+## Documentation updates
+
+* **Multi-language code examples.** Previously, various topics showed only cURL examples for the REST API operations. These topics now show examples in multiple languages. You can use the language drop-down list to choose a language.
+  
+* [When to Use Connect V1.](https://developer.squareup.com/docs/build-basics/using-connect-v1) Content is revised to reflect the most current information about when to use the Connect V1 API.
+
+
 ## Version 9.0.0.20210226 (2021-02-26)
 ## Existing API updates
 

doc/api/apple-pay.md

@@ -11,15 +11,15 @@ apple_pay_api = client.apple_pay
 
 # Register Domain
 
-Activates a domain for use with Web Apple Pay and Square. A validation
-will be performed on this domain by Apple to ensure is it properly set up as
+Activates a domain for use with Apple Pay on the Web and Square. A validation
+is performed on this domain by Apple to ensure that it is properly set up as
 an Apple Pay enabled domain.
 
 This endpoint provides an easy way for platform developers to bulk activate
-Web Apple Pay with Square for merchants using their platform.
+Apple Pay on the Web with Square for merchants using their platform.
 
-To learn more about Apple Pay on Web see the Apple Pay section in the
-[Square Payment Form Walkthrough](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough).
+To learn more about Web Apple Pay, see
+[Add the Apple Pay on the Web Button](https://developer.squareup.com/docs/payment-form/add-digital-wallets/apple-pay).
 
 ```python
 def register_domain(self,

doc/api/checkout.md

@@ -11,8 +11,8 @@ checkout_api = client.checkout
 
 # Create Checkout
 
-Links a `checkoutId` to a `checkout_page_url` that customers will
-be directed to in order to provide their payment information using a
+Links a `checkoutId` to a `checkout_page_url` that customers are
+directed to in order to provide their payment information using a
 payment processing workflow hosted on connect.squareup.com.
 
 ```python

doc/api/invoices.md

@@ -108,7 +108,7 @@ body['invoice']['payment_requests'] = []
 
 body['invoice']['payment_requests'].append({})
 body['invoice']['payment_requests'][0]['uid'] = 'uid4'
-body['invoice']['payment_requests'][0]['request_method'] = 'SHARE_MANUALLY'
+body['invoice']['payment_requests'][0]['request_method'] = 'SMS_CHARGE_CARD_ON_FILE'
 body['invoice']['payment_requests'][0]['request_type'] = 'BALANCE'
 body['invoice']['payment_requests'][0]['due_date'] = '2030-01-24'
 body['invoice']['payment_requests'][0]['fixed_amount_requested_money'] = {}
@@ -131,6 +131,18 @@ body['invoice']['invoice_number'] = 'inv-100'
 body['invoice']['title'] = 'Event Planning Services'
 body['invoice']['description'] = 'We appreciate your business!'
 body['invoice']['scheduled_at'] = '2030-01-13T10:00:00Z'
+body['invoice']['custom_fields'] = []
+
+body['invoice']['custom_fields'].append({})
+body['invoice']['custom_fields'][0]['label'] = 'Event Reference Number'
+body['invoice']['custom_fields'][0]['value'] = 'Ref. #1234'
+body['invoice']['custom_fields'][0]['placement'] = 'ABOVE_LINE_ITEMS'
+
+body['invoice']['custom_fields'].append({})
+body['invoice']['custom_fields'][1]['label'] = 'Terms of Service'
+body['invoice']['custom_fields'][1]['value'] = 'The terms of service are...'
+body['invoice']['custom_fields'][1]['placement'] = 'BELOW_LINE_ITEMS'
+
 body['idempotency_key'] = 'ce3748f9-5fc1-4762-aa12-aae5e843f1f4'
 
 result = invoices_api.create_invoice(body)
@@ -310,7 +322,7 @@ body['invoice']['payment_requests'] = []
 
 body['invoice']['payment_requests'].append({})
 body['invoice']['payment_requests'][0]['uid'] = '2da7964f-f3d2-4f43-81e8-5aa220bf3355'
-body['invoice']['payment_requests'][0]['request_method'] = 'SHARE_MANUALLY'
+body['invoice']['payment_requests'][0]['request_method'] = 'SMS_CHARGE_CARD_ON_FILE'
 body['invoice']['payment_requests'][0]['request_type'] = 'DEPOSIT'
 body['invoice']['payment_requests'][0]['due_date'] = 'due_date2'
 body['invoice']['payment_requests'][0]['fixed_amount_requested_money'] = {}

doc/api/payments.md

@@ -14,6 +14,7 @@ payments_api = client.payments
 * [Create Payment](/doc/api/payments.md#create-payment)
 * [Cancel Payment by Idempotency Key](/doc/api/payments.md#cancel-payment-by-idempotency-key)
 * [Get Payment](/doc/api/payments.md#get-payment)
+* [Update Payment](/doc/api/payments.md#update-payment)
 * [Cancel Payment](/doc/api/payments.md#cancel-payment)
 * [Complete Payment](/doc/api/payments.md#complete-payment)
 
@@ -79,17 +80,14 @@ elif result.is_error():
 
 # Create Payment
 
-Charges a payment source (for example, a card
-represented by customer's card on file or a card nonce). In addition
-to the payment source, the request must include the
-amount to accept for the payment.
+Creates a payment using the provided source. You can use this endpoint
+to charge a card (credit/debit card or  
+Square gift card) or record a payment that the seller received outside of Square
+(cash payment from a buyer or a payment that an external entity
+procesed on behalf of the seller).
 
-There are several optional parameters that you can include in the request
-(for example, tip money, whether to autocomplete the payment, or a reference ID
-to correlate this payment with another system).
-
-The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required
-to enable application fees.
+The endpoint creates a
+`Payment` object and returns it in the response.
 
 ```python
 def create_payment(self,
@@ -215,10 +213,59 @@ elif result.is_error():
 ```
 
 
+# Update Payment
+
+Updates a payment with the APPROVED status.
+You can update the `amount_money` and `tip_money` using this endpoint.
+
+```python
+def update_payment(self,
+                  payment_id,
+                  body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `payment_id` | `string` | Template, Required | The ID of the payment to update. |
+| `body` | [`Update Payment Request`](/doc/models/update-payment-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
+
+## Response Type
+
+[`Update Payment Response`](/doc/models/update-payment-response.md)
+
+## Example Usage
+
+```python
+payment_id = 'payment_id0'
+body = {}
+body['payment'] = {}
+body['payment']['id'] = 'id2'
+body['payment']['created_at'] = 'created_at0'
+body['payment']['updated_at'] = 'updated_at8'
+body['payment']['amount_money'] = {}
+body['payment']['amount_money']['amount'] = 1000
+body['payment']['amount_money']['currency'] = 'USD'
+body['payment']['tip_money'] = {}
+body['payment']['tip_money']['amount'] = 300
+body['payment']['tip_money']['currency'] = 'USD'
+body['payment']['version_token'] = 'Z3okDzm2VRv5m5nE3WGx381ItTNhvjkB4VapByyz54h6o'
+body['idempotency_key'] = '3d3c3b22-9572-4fc6-1111-e4d2f41b4122'
+
+result = payments_api.update_payment(payment_id, body)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
 # Cancel Payment
 
-Cancels (voids) a payment. If you set `autocomplete` to `false` when creating a payment,
-you can cancel the payment using this endpoint.
+Cancels (voids) a payment. You can use this endpoint to cancel a payment with
+the APPROVED `status`.
 
 ```python
 def cancel_payment(self,
@@ -229,7 +276,7 @@ def cancel_payment(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `payment_id` | `string` | Template, Required | The `payment_id` identifying the payment to be canceled. |
+| `payment_id` | `string` | Template, Required | The ID of the payment to cancel. |
 
 ## Response Type
 
@@ -252,10 +299,9 @@ elif result.is_error():
 # Complete Payment
 
 Completes (captures) a payment.
-
 By default, payments are set to complete immediately after they are created.
-If you set `autocomplete` to `false` when creating a payment, you can complete (capture)
-the payment using this endpoint.
+
+You can use this endpoint to complete a payment with the APPROVED `status`.
 
 ```python
 def complete_payment(self,

doc/api/refunds.md

@@ -74,7 +74,9 @@ elif result.is_error():
 # Refund Payment
 
 Refunds a payment. You can refund the entire payment amount or a
-portion of it.
+portion of it. You can use this endpoint to refund a card payment or record a
+refund of a cash or external payment. For more information, see
+[Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).
 
 ```python
 def refund_payment(self,

doc/api/terminal.md

@@ -22,7 +22,8 @@ terminal_api = client.terminal
 
 # Create Terminal Checkout
 
-Creates a new Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
+Creates a Terminal checkout request and sends it to the specified device to take a payment
+for the requested amount.
 
 ```python
 def create_terminal_checkout(self,
@@ -118,7 +119,7 @@ elif result.is_error():
 
 # Get Terminal Checkout
 
-Retrieves a Terminal checkout request by checkout_id.
+Retrieves a Terminal checkout request by `checkout_id`.
 
 ```python
 def get_terminal_checkout(self,
@@ -129,7 +130,7 @@ def get_terminal_checkout(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `checkout_id` | `string` | Template, Required | Unique ID for the desired `TerminalCheckout` |
+| `checkout_id` | `string` | Template, Required | The unique ID for the desired `TerminalCheckout`. |
 
 ## Response Type
 
@@ -162,7 +163,7 @@ def cancel_terminal_checkout(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `checkout_id` | `string` | Template, Required | Unique ID for the desired `TerminalCheckout` |
+| `checkout_id` | `string` | Template, Required | The unique ID for the desired `TerminalCheckout`. |
 
 ## Response Type
 
@@ -228,7 +229,7 @@ elif result.is_error():
 
 # Search Terminal Refunds
 
-Retrieves a filtered list of Terminal Interac refund requests created by the seller making the request.
+Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.
 
 ```python
 def search_terminal_refunds(self,
@@ -272,7 +273,7 @@ elif result.is_error():
 
 # Get Terminal Refund
 
-Retrieves an Interac terminal refund object by ID.
+Retrieves an Interac Terminal refund object by ID.
 
 ```python
 def get_terminal_refund(self,
@@ -283,7 +284,7 @@ def get_terminal_refund(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `terminal_refund_id` | `string` | Template, Required | Unique ID for the desired `TerminalRefund` |
+| `terminal_refund_id` | `string` | Template, Required | The unique ID for the desired `TerminalRefund`. |
 
 ## Response Type
 
@@ -305,7 +306,7 @@ elif result.is_error():
 
 # Cancel Terminal Refund
 
-Cancels an Interac terminal refund request by refund request ID if the status of the request permits it.
+Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.
 
 ```python
 def cancel_terminal_refund(self,
@@ -316,7 +317,7 @@ def cancel_terminal_refund(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `terminal_refund_id` | `string` | Template, Required | Unique ID for the desired `TerminalRefund` |
+| `terminal_refund_id` | `string` | Template, Required | The unique ID for the desired `TerminalRefund`. |
 
 ## Response Type