Release 2.11.1 (#83)

* Release 2.11.1
square · Oct 24, 2018 · e595568 · e595568
1 parent ee8ad26
commit e595568
Show file tree

Hide file tree

Showing 13 changed files with 104 additions and 25 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,7 @@ install:
 
 script:
   - export frameworkVersion=netstandard2.0
-  - export releaseVersion="2.11.0"
+  - export releaseVersion="2.11.1"
   - /bin/sh ./mono_nunit_test.sh
 
 after_success:

diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,20 @@
 # Change Log
 
+## Version 2.11.1 (2018-10-24)
+
+### New feature: Support for Partial Payments in Connect v1
+
+The Connect SDK now supports partial payment functionality for the Connect v1 Transactions API with the addition of a new `Payment` field:
+* `Payment.is_partial` &mdash; Indicates whether or not the payment is only partially paid for. If `true`, the payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.
+
+`Tender` also includes 2 new fields to help resolve timing around payments with multiple tenders. Invoices that involve partial payment (e.g., requiring a deposit) may include tenders settled well before the entire payment is completed:
+* `Tender.tendered_at` &mdash; The time when the tender was accepted by the merchant.
+* `Tender.settled_at` &mdash; The time when the tender was captured, in ISO 8601 format. Typically the same as (or within moments of) `tendered_at` unless the tender was part of a delay capture transaction.
+
+The change also makes some behavioral changes to the Connect v1 Payment endpoints:
+* **Create Refunds** rejects requests for invoices that have partial payments pending.
+* **List Payments** takes a new request field, `include_partial` to indicate whether partial payments should be included in the response.
+
 ## Version 2.11.0 (2018-09-18)
 
 We have added Connect v2 Inventory API and birthdays in `Customer` entities.

diff --git a/docs/V1Payment.md b/docs/V1Payment.md
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **Itemizations** | [**List&lt;V1PaymentItemization&gt;**](V1PaymentItemization.md) | The items purchased in the payment. | [optional] 
 **SurchargeMoney** | [**V1Money**](V1Money.md) | The total of all surcharges applied to the payment. | [optional] 
 **Surcharges** | [**List&lt;V1PaymentSurcharge&gt;**](V1PaymentSurcharge.md) | A list of all surcharges associated with the payment. | [optional] 
+**IsPartial** | **bool?** | Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed. | [optional] 
 
 
 

diff --git a/docs/V1PaymentSurcharge.md b/docs/V1PaymentSurcharge.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **Type** | **TypeEnum** | Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. | [optional] 
 **Taxable** | **bool?** | Indicates whether the surcharge is taxable. | [optional] 
 **Taxes** | [**List&lt;V1PaymentTax&gt;**](V1PaymentTax.md) | The list of taxes that should be applied to the surcharge. | [optional] 
-**SurchargeId** | **string** |  | [optional] 
+**SurchargeId** | **string** | A Square-issued unique identifier associated with the surcharge. | [optional] 
 
 
 ## TypeEnum

diff --git a/docs/V1Tender.md b/docs/V1Tender.md
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
 **PaymentNote** | **string** | Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. | [optional] 
 **TotalMoney** | [**V1Money**](V1Money.md) | The total amount of money provided in this form of tender. | [optional] 
 **TenderedMoney** | [**V1Money**](V1Money.md) | The amount of total_money applied to the payment. | [optional] 
+**TenderedAt** | **string** | The time when the tender was created, in ISO 8601 format. | [optional] 
+**SettledAt** | **string** | The time when the tender was settled, in ISO 8601 format. | [optional] 
 **ChangeBackMoney** | [**V1Money**](V1Money.md) | The amount of total_money returned to the buyer as change. | [optional] 
 **RefundedMoney** | [**V1Money**](V1Money.md) | The total of all refunds applied to this tender. This amount is always negative or zero. | [optional] 
 **IsExchange** | **bool?** | Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange. | [optional] 

diff --git a/docs/V1TransactionsApi.md b/docs/V1TransactionsApi.md
@@ -222,7 +222,7 @@ Name | Type | Description  | Notes
 
 <a name="listpayments"></a>
 # **ListPayments**
-> List<V1Payment> ListPayments (string locationId, string order = null, string beginTime = null, string endTime = null, int? limit = null, string batchToken = null)
+> List<V1Payment> ListPayments (string locationId, string order = null, string beginTime = null, string endTime = null, int? limit = null, string batchToken = null, bool? includePartial = null)
 
 Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.
 
@@ -253,11 +253,12 @@ namespace Example
             var endTime = endTime_example;  // string | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional) 
             var limit = 56;  // int? | The maximum number of payments to return in a single response. This value cannot exceed 200. (optional) 
             var batchToken = batchToken_example;  // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) 
+            var includePartial = true;  // bool? | Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. (optional) 
 
             try
             {
                 // Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.
-                List&lt;V1Payment&gt; result = apiInstance.ListPayments(locationId, order, beginTime, endTime, limit, batchToken);
+                List&lt;V1Payment&gt; result = apiInstance.ListPayments(locationId, order, beginTime, endTime, limit, batchToken, includePartial);
                 Debug.WriteLine(result);
             }
             catch (Exception e)
@@ -279,6 +280,7 @@ Name | Type | Description  | Notes
  **endTime** | **string**| The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] 
  **limit** | **int?**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
  **batchToken** | **string**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
+ **includePartial** | **bool?**| Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. | [optional] 
 
 ### Return type