Release/2.20180918.1 (#51)

ssung88 · web-flow · commit d5bcdca14e52 · 2018-10-24T12:26:21.000-07:00
* Release 2.20180918.1
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,20 @@
 # Change Log
 
+## Version 2.20180918.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.20180918.0 (2018-09-18)
 
 We have added Connect v2 Inventory API and birthdays in `Customer` entities.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 2.20180918.0
+- Package version: 2.20180918.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
diff --git a/docs/V1Payment.md b/docs/V1Payment.md
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
 **itemizations** | [**Array&lt;V1PaymentItemization&gt;**](V1PaymentItemization.md) | The items purchased in the payment. | [optional] 
 **surcharge_money** | [**V1Money**](V1Money.md) | The total of all surcharges applied to the payment. | [optional] 
 **surcharges** | [**Array&lt;V1PaymentSurcharge&gt;**](V1PaymentSurcharge.md) | A list of all surcharges associated with the payment. | [optional] 
+**is_partial** | **BOOLEAN** | 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
@@ -12,6 +12,6 @@ Name | Type | Description | Notes
 **type** | **String** | Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. | [optional] 
 **taxable** | **BOOLEAN** | Indicates whether the surcharge is taxable. | [optional] 
 **taxes** | [**Array&lt;V1PaymentTax&gt;**](V1PaymentTax.md) | The list of taxes that should be applied to the surcharge. | [optional] 
-**surcharge_id** | **String** |  | [optional] 
+**surcharge_id** | **String** | A Square-issued unique identifier associated with the surcharge. | [optional] 
 
 
diff --git a/docs/V1Tender.md b/docs/V1Tender.md
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
 **payment_note** | **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] 
 **total_money** | [**V1Money**](V1Money.md) | The total amount of money provided in this form of tender. | [optional] 
 **tendered_money** | [**V1Money**](V1Money.md) | The amount of total_money applied to the payment. | [optional] 
+**tendered_at** | **String** | The time when the tender was created, in ISO 8601 format. | [optional] 
+**settled_at** | **String** | The time when the tender was settled, in ISO 8601 format. | [optional] 
 **change_back_money** | [**V1Money**](V1Money.md) | The amount of total_money returned to the buyer as change. | [optional] 
 **refunded_money** | [**V1Money**](V1Money.md) | The total of all refunds applied to this tender. This amount is always negative or zero. | [optional] 
 **is_exchange** | **BOOLEAN** | 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
@@ -210,7 +210,8 @@ opts = {
   begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
   end_time: "end_time_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.
   limit: 56, # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
-  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+  batch_token: "batch_token_example", # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+  include_partial: true # BOOLEAN | 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.
 }
 
 begin
@@ -232,6 +233,7 @@ Name | Type | Description  | Notes
  **end_time** | **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** | **Integer**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
  **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
+ **include_partial** | **BOOLEAN**| 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
 
diff --git a/lib/square_connect/api/v1_transactions_api.rb b/lib/square_connect/api/v1_transactions_api.rb
@@ -208,6 +208,7 @@ def list_orders_with_http_info(location_id, opts = {})
     # @option opts [String] :end_time 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.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
     # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @option opts [BOOLEAN] :include_partial 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.
     # @return [Array<V1Payment>]
     def list_payments(location_id, opts = {})
       data, _status_code, _headers = list_payments_with_http_info(location_id, opts)
@@ -223,6 +224,7 @@ def list_payments(location_id, opts = {})
     # @option opts [String] :end_time 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.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
     # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @option opts [BOOLEAN] :include_partial 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.
     # @return [Array<(Array<V1Payment>, Fixnum, Hash)>] Array<V1Payment> data, response status code and response headers
     def list_payments_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -247,6 +249,7 @@ def list_payments_with_http_info(location_id, opts = {})
       query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
+      query_params[:'include_partial'] = opts[:'include_partial'] if !opts[:'include_partial'].nil?
 
       # header parameters
       header_params = {}
diff --git a/lib/square_connect/api_client.rb b/lib/square_connect/api_client.rb
@@ -30,7 +30,7 @@ def initialize(config = Configuration.default)
       @config = config
 
       # Construct user agent string. Returns slightly different string for JRuby
-      @user_agent = "Square-Connect-Ruby/2.20180918.0"
+      @user_agent = "Square-Connect-Ruby/2.20180918.1"
 
       @default_headers = {
         'Content-Type' => "application/json",
diff --git a/lib/square_connect/models/v1_payment.rb b/lib/square_connect/models/v1_payment.rb
@@ -90,6 +90,9 @@ class V1Payment
     # A list of all surcharges associated with the payment.
     attr_accessor :surcharges
 
+    # 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.
+    attr_accessor :is_partial
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -119,7 +122,8 @@ def self.attribute_map
         :'refunds' => :'refunds',
         :'itemizations' => :'itemizations',
         :'surcharge_money' => :'surcharge_money',
-        :'surcharges' => :'surcharges'
+        :'surcharges' => :'surcharges',
+        :'is_partial' => :'is_partial'
       }
     end
 
@@ -151,7 +155,8 @@ def self.swagger_types
         :'refunds' => :'Array<V1Refund>',
         :'itemizations' => :'Array<V1PaymentItemization>',
         :'surcharge_money' => :'V1Money',
-        :'surcharges' => :'Array<V1PaymentSurcharge>'
+        :'surcharges' => :'Array<V1PaymentSurcharge>',
+        :'is_partial' => :'BOOLEAN'
       }
     end
 
@@ -279,6 +284,10 @@ def initialize(attributes = {})
         end
       end
 
+      if attributes.has_key?(:'is_partial')
+        self.is_partial = attributes[:'is_partial']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -324,7 +333,8 @@ def ==(o)
           refunds == o.refunds &&
           itemizations == o.itemizations &&
           surcharge_money == o.surcharge_money &&
-          surcharges == o.surcharges
+          surcharges == o.surcharges &&
+          is_partial == o.is_partial
     end
 
     # @see the `==` method
@@ -336,7 +346,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, merchant_id, created_at, creator_id, device, payment_url, receipt_url, inclusive_tax_money, additive_tax_money, tax_money, tip_money, discount_money, total_collected_money, processing_fee_money, net_total_money, refunded_money, swedish_rounding_money, gross_sales_money, net_sales_money, inclusive_tax, additive_tax, tender, refunds, itemizations, surcharge_money, surcharges].hash
+      [id, merchant_id, created_at, creator_id, device, payment_url, receipt_url, inclusive_tax_money, additive_tax_money, tax_money, tip_money, discount_money, total_collected_money, processing_fee_money, net_total_money, refunded_money, swedish_rounding_money, gross_sales_money, net_sales_money, inclusive_tax, additive_tax, tender, refunds, itemizations, surcharge_money, surcharges, is_partial].hash
     end
 
     # Builds the object from hash
diff --git a/lib/square_connect/models/v1_payment_surcharge.rb b/lib/square_connect/models/v1_payment_surcharge.rb
@@ -33,6 +33,7 @@ class V1PaymentSurcharge
     # The list of taxes that should be applied to the surcharge.
     attr_accessor :taxes
 
+    # A Square-issued unique identifier associated with the surcharge.
     attr_accessor :surcharge_id
 
     class EnumAttributeValidator
diff --git a/lib/square_connect/models/v1_tender.rb b/lib/square_connect/models/v1_tender.rb
@@ -45,6 +45,12 @@ class V1Tender
     # The amount of total_money applied to the payment.
     attr_accessor :tendered_money
 
+    # The time when the tender was created, in ISO 8601 format.
+    attr_accessor :tendered_at
+
+    # The time when the tender was settled, in ISO 8601 format.
+    attr_accessor :settled_at
+
     # The amount of total_money returned to the buyer as change.
     attr_accessor :change_back_money
 
@@ -90,6 +96,8 @@ def self.attribute_map
         :'payment_note' => :'payment_note',
         :'total_money' => :'total_money',
         :'tendered_money' => :'tendered_money',
+        :'tendered_at' => :'tendered_at',
+        :'settled_at' => :'settled_at',
         :'change_back_money' => :'change_back_money',
         :'refunded_money' => :'refunded_money',
         :'is_exchange' => :'is_exchange'
@@ -110,6 +118,8 @@ def self.swagger_types
         :'payment_note' => :'String',
         :'total_money' => :'V1Money',
         :'tendered_money' => :'V1Money',
+        :'tendered_at' => :'String',
+        :'settled_at' => :'String',
         :'change_back_money' => :'V1Money',
         :'refunded_money' => :'V1Money',
         :'is_exchange' => :'BOOLEAN'
@@ -168,6 +178,14 @@ def initialize(attributes = {})
         self.tendered_money = attributes[:'tendered_money']
       end
 
+      if attributes.has_key?(:'tendered_at')
+        self.tendered_at = attributes[:'tendered_at']
+      end
+
+      if attributes.has_key?(:'settled_at')
+        self.settled_at = attributes[:'settled_at']
+      end
+
       if attributes.has_key?(:'change_back_money')
         self.change_back_money = attributes[:'change_back_money']
       end
@@ -247,6 +265,8 @@ def ==(o)
           payment_note == o.payment_note &&
           total_money == o.total_money &&
           tendered_money == o.tendered_money &&
+          tendered_at == o.tendered_at &&
+          settled_at == o.settled_at &&
           change_back_money == o.change_back_money &&
           refunded_money == o.refunded_money &&
           is_exchange == o.is_exchange
@@ -261,7 +281,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, type, name, employee_id, receipt_url, card_brand, pan_suffix, entry_method, payment_note, total_money, tendered_money, change_back_money, refunded_money, is_exchange].hash
+      [id, type, name, employee_id, receipt_url, card_brand, pan_suffix, entry_method, payment_note, total_money, tendered_money, tendered_at, settled_at, change_back_money, refunded_money, is_exchange].hash
     end
 
     # Builds the object from hash
diff --git a/lib/square_connect/version.rb b/lib/square_connect/version.rb
@@ -8,5 +8,5 @@
 =end
 
 module SquareConnect
-  VERSION = "2.20180918.0"
+  VERSION = "2.20180918.1"
 end
diff --git a/square_connect.gemspec b/square_connect.gemspec
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
