Release 2.7.0 (#34)

* Release 2.7.0

Author: yonpols

CHANGES.md

@@ -1,5 +1,27 @@
 # Change Log
 
+## Version 2.7.0 (2018-04-26)
+
+### New features: Transactions API and Payments API
+
+The Transactions API in Connect v2 now includes payment and refund information from exchanges.
+
+* `ListTransactions` now includes payment information from sales and exchanges and refund
+information from returns and exchanges.
+* `ListRefunds` now includes refunds that result from exchanges in addition to partial refunds and
+itemized returns through Square's Point of Sale applications.
+
+The Payments API in Connect v1 now includes payment and refund information from exchanges.
+
+* `ListPayments` now includes refunds that are generated from exchanges to account for the
+value of returned goods.
+* `ListRefunds` now returns an approximate number of refunds (default: 100, max: 200).
+The response may contain more results than the prescribed limit when refunds are made
+simultaneously to multiple tenders in a payment or when refunds are generated from exchanges
+to account for the value of returned goods.
+* `is_exchange` is added to `V1Refund` and `V1Tender`. Refunds and tenders marked in this way
+represent the value of returned goods in an exchange, rather than actual money movement.
+
 ## Version 2.6.1 (2018-03-28)
 
 * Updates user-agent header

README.md

@@ -1,7 +1,7 @@
 Square Connect Ruby SDKs [![Build Status](https://travis-ci.org/square/connect-ruby-sdk.svg?branch=master)](https://travis-ci.org/square/connect-ruby-sdk)[![Gem Version](https://badge.fury.io/rb/square_connect.svg)](https://badge.fury.io/rb/square_connect)
 ==================
 
-**If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://docs.google.com/forms/d/e/1FAIpQLSfAZGIEZoNs-XryKqUoW3atFQHdQw5UqXLMOVPq3V4DEq-AJw/viewform?usp=sf_link#response=ACYDBNj5LFgPy8Tcac2gSgv_IjXvgWsPy2CO2xTXwnc0OSSxCvWFgc7SCDHvVQ)**
+**If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://squ.re/2GYvF2B)**
 
 This repository contains the released Ruby client SDK. Check out our [API
 specification repository](https://github.com/square/connect-api-specification)
@@ -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.6.1
+- Package version: 2.7.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)

docs/TransactionsApi.md

@@ -186,7 +186,7 @@ Name | Type | Description  | Notes
 
 ListRefunds
 
-Lists refunds for one of a business's locations.  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.  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
 ```ruby
@@ -248,7 +248,7 @@ Name | Type | Description  | Notes
 
 ListTransactions
 
-Lists transactions for a particular location.  Max results per [page](#paginatingresults): 50
+Lists transactions for a particular location.  Transactions include payment information from sales and exchanges and refund information from returns and exchanges.  Max results per [page](#paginatingresults): 50
 
 ### Example
 ```ruby

docs/V1Payment.md

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
 **inclusive_tax** | [**Array<V1PaymentTax>**](V1PaymentTax.md) | All of the inclusive taxes associated with the payment. | [optional] 
 **additive_tax** | [**Array<V1PaymentTax>**](V1PaymentTax.md) | All of the additive taxes associated with the payment. | [optional] 
 **tender** | [**Array<V1Tender>**](V1Tender.md) | All of the additive taxes associated with the payment. | [optional] 
-**refunds** | [**Array<V1Refund>**](V1Refund.md) | All of the refunds applied to the payment. | [optional] 
+**refunds** | [**Array<V1Refund>**](V1Refund.md) | All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange. | [optional] 
 **itemizations** | [**Array<V1PaymentItemization>**](V1PaymentItemization.md) | The items purchased in the payment. | [optional] 
 
 

docs/V1Refund.md

@@ -8,9 +8,10 @@ Name | Type | Description | Notes
 **type** | **String** | The type of refund  | [optional] 
 **reason** | **String** | The merchant-specified reason for the refund. | [optional] 
 **refunded_money** | [**V1Money**](V1Money.md) | The amount of money refunded. This amount is always negative. | [optional] 
-**created_at** | **String** | The time when the merchant initiated the refund for Square to process, in ISO 8601 format.. | [optional] 
+**created_at** | **String** | The time when the merchant initiated the refund for Square to process, in ISO 8601 format. | [optional] 
 **processed_at** | **String** | The time when Square processed the refund on behalf of the merchant, in ISO 8601 format. | [optional] 
-**payment_id** | **String** | The Square-issued ID of the payment the refund is applied to. | [optional] 
+**payment_id** | **String** | A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders. | [optional] 
 **merchant_id** | **String** |  | [optional] 
+**is_exchange** | **BOOLEAN** | Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded. | [optional] 
 
 

docs/V1Tender.md

@@ -18,5 +18,6 @@ Name | Type | Description | Notes
 **tendered_money** | [**V1Money**](V1Money.md) | The amount of total_money applied to the payment. | [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] 
 
 

docs/V1TransactionsApi.md

@@ -273,7 +273,7 @@ opts = {
   order: "order_example", # String | TThe order in which payments are listed in the response.
   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.
+  limit: 56, # Integer | The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.
   batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
@@ -294,7 +294,7 @@ Name | Type | Description  | Notes
  **order** | **String**| TThe order in which payments are listed in the response. | [optional] 
  **begin_time** | **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. | [optional] 
  **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] 
+ **limit** | **Integer**| The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods. | [optional] 
  **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
@@ -509,7 +509,7 @@ api_instance = SquareConnect::V1TransactionsApi.new
 
 location_id = "location_id_example" # String | The ID of the payment's associated location.
 
-payment_id = "payment_id_example" # String | The payment's Square-issued ID. You obtain this value from Payment objects returned by the List Payments endpoint, or Settlement objects returned by the List Settlements endpoint.
+payment_id = "payment_id_example" # String | The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.
 
 
 begin
@@ -526,7 +526,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **location_id** | **String**| The ID of the payment's associated location. | 
- **payment_id** | **String**| The payment's Square-issued ID. You obtain this value from Payment objects returned by the List Payments endpoint, or Settlement objects returned by the List Settlements endpoint. | 
+ **payment_id** | **String**| The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint. | 
 
 ### Return type
 

lib/square_connect/api/transactions_api.rb

@@ -193,7 +193,7 @@ def create_refund_with_http_info(location_id, transaction_id, body, opts = {})
     end
 
     # ListRefunds
-    # Lists refunds for one of a business's locations.  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.  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
     # @param location_id The ID of the location to list refunds for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
@@ -207,7 +207,7 @@ def list_refunds(location_id, opts = {})
     end
 
     # ListRefunds
-    # Lists refunds for one of a business's locations.  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.  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
     # @param location_id The ID of the location to list refunds for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
@@ -261,7 +261,7 @@ def list_refunds_with_http_info(location_id, opts = {})
     end
 
     # ListTransactions
-    # Lists transactions for a particular location.  Max results per [page](#paginatingresults): 50
+    # Lists transactions for a particular location.  Transactions include payment information from sales and exchanges and refund information from returns and exchanges.  Max results per [page](#paginatingresults): 50
     # @param location_id The ID of the location to list transactions for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
@@ -275,7 +275,7 @@ def list_transactions(location_id, opts = {})
     end
 
     # ListTransactions
-    # Lists transactions for a particular location.  Max results per [page](#paginatingresults): 50
+    # Lists transactions for a particular location.  Transactions include payment information from sales and exchanges and refund information from returns and exchanges.  Max results per [page](#paginatingresults): 50
     # @param location_id The ID of the location to list transactions for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.

lib/square_connect/api/v1_transactions_api.rb

@@ -278,7 +278,7 @@ def list_payments_with_http_info(location_id, opts = {})
     # @option opts [String] :order TThe order in which payments are listed in the response.
     # @option opts [String] :begin_time 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.
     # @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 [Integer] :limit The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.
     # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Refund>]
     def list_refunds(location_id, opts = {})
@@ -293,7 +293,7 @@ def list_refunds(location_id, opts = {})
     # @option opts [String] :order TThe order in which payments are listed in the response.
     # @option opts [String] :begin_time 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.
     # @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 [Integer] :limit The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.
     # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Refund>, Fixnum, Hash)>] Array<V1Refund> data, response status code and response headers
     def list_refunds_with_http_info(location_id, opts = {})
@@ -544,7 +544,7 @@ def retrieve_order_with_http_info(location_id, order_id, opts = {})
     # Provides comprehensive information for a single payment.
     # Provides comprehensive information for a single payment.
     # @param location_id The ID of the payment&#39;s associated location.
-    # @param payment_id The payment&#39;s Square-issued ID. You obtain this value from Payment objects returned by the List Payments endpoint, or Settlement objects returned by the List Settlements endpoint.
+    # @param payment_id The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.
     # @param [Hash] opts the optional parameters
     # @return [V1Payment]
     def retrieve_payment(location_id, payment_id, opts = {})
@@ -555,7 +555,7 @@ def retrieve_payment(location_id, payment_id, opts = {})
     # Provides comprehensive information for a single payment.
     # Provides comprehensive information for a single payment.
     # @param location_id The ID of the payment&#39;s associated location.
-    # @param payment_id The payment&#39;s Square-issued ID. You obtain this value from Payment objects returned by the List Payments endpoint, or Settlement objects returned by the List Settlements endpoint.
+    # @param payment_id The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.
     # @param [Hash] opts the optional parameters
     # @return [Array<(V1Payment, Fixnum, Hash)>] V1Payment data, response status code and response headers
     def retrieve_payment_with_http_info(location_id, payment_id, opts = {})

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.6.1"
+      @user_agent = "Square-Connect-Ruby/2.7.0"
 
       @default_headers = {
         'Content-Type' => "application/json",