square_connect 2.4.0.175 → 2.5.0.180

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 164bd7dfb404078f9769e7229f4279401d5e347b
-  data.tar.gz: 7da70e0f767aedd553f09addc9ce86ec1747cf85
+SHA256:
+  metadata.gz: 7d89d4a38fcded28d65607829e4477a14ae3c8b0824b5b5b6a2e85dccd6524ce
+  data.tar.gz: 9471e8a46238e093a324f54db52a51e15137fcee67ae504486670ba8afc432e3
 SHA512:
-  metadata.gz: 974467a3e2712c96ab7d863f2cc4e29988c6bfbf7ec49709fe1e9c708057dd9ad878cd2a0b4cc4310166049d7d88971000f9773588171c4fd2149b09e060a776
-  data.tar.gz: d28880ee602068f6d4e58658513c3bbec05b92ff346314b0acab60e3c0977ba3c498086533efe8e6b7c3e85a38a3f040a9e5cf72a7da2e0cdfaddfe50258a27b
+  metadata.gz: 4f594f03d780d98c7b93d6088c2867d4dbac179900c505a43d33e54427fc59c3033622fcca525000b31701242ba9526d29d7e9230ac7ffe625076abc819a1237
+  data.tar.gz: 18bbc3b7cb2a8677b1b6edee6da4117c264dc1460591980556fe699d87817887f0049ece7d4ff5827823f8a28483f6c39ed3539ed3bf029462d5fd08e15405ca

data/CHANGES.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## Version 2.5 (2017-11-02)
+
+### New features: Transaction API and Reporting API
+
+The Transaction API now supports the following request objects:
+
+* `additional_recipients` — data type representing an additional recipient
+  (in other words, a recipient other than the merchant or Square) receiving a
+  portion of a tender.
+
+The new Reporting API includes two endpoints that let you pull information about distributions you have received as an additional recipient:
+
+* `AdditionalRecipientReceivables` — returns a list of receivables (across
+  all source locations) representing monies credited to the given location ID by
+  another Square account using the `additional_recipients` field in a transaction.
+
+* `AdditionalRecipientReceivablesRefunds` — returns a list of refunded
+  transactions (across all source locations) related to monies credited to the
+  given location ID by another Square account using the `additional_recipients`
+  field in a transaction.
+
 ## Version 2.4 (2017-09-27)
 
 ### New features: Register Domain for Apple Pay

data/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.4.0
+- Package version: 2.5.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -97,6 +97,8 @@ Class | Method | HTTP request | Description
 *SquareConnect::LocationsApi* | [**list_locations**](docs/LocationsApi.md#list_locations) | **GET** /v2/locations | ListLocations
 *SquareConnect::OrdersApi* | [**batch_retrieve_orders**](docs/OrdersApi.md#batch_retrieve_orders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders
 *SquareConnect::OrdersApi* | [**create_order**](docs/OrdersApi.md#create_order) | **POST** /v2/locations/{location_id}/orders | CreateOrder
+*SquareConnect::ReportingApi* | [**list_additional_recipient_receivable_refunds**](docs/ReportingApi.md#list_additional_recipient_receivable_refunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds
+*SquareConnect::ReportingApi* | [**list_additional_recipient_receivables**](docs/ReportingApi.md#list_additional_recipient_receivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables
 *SquareConnect::TransactionsApi* | [**capture_transaction**](docs/TransactionsApi.md#capture_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction
 *SquareConnect::TransactionsApi* | [**charge**](docs/TransactionsApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge
 *SquareConnect::TransactionsApi* | [**create_refund**](docs/TransactionsApi.md#create_refund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund
@@ -177,6 +179,9 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [SquareConnect::AdditionalRecipient](docs/AdditionalRecipient.md)
+ - [SquareConnect::AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
+ - [SquareConnect::AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
  - [SquareConnect::Address](docs/Address.md)
  - [SquareConnect::BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
  - [SquareConnect::BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md)
@@ -220,6 +225,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogTax](docs/CatalogTax.md)
  - [SquareConnect::CatalogV1Id](docs/CatalogV1Id.md)
  - [SquareConnect::ChargeRequest](docs/ChargeRequest.md)
+ - [SquareConnect::ChargeRequestAdditionalRecipient](docs/ChargeRequestAdditionalRecipient.md)
  - [SquareConnect::ChargeResponse](docs/ChargeResponse.md)
  - [SquareConnect::Checkout](docs/Checkout.md)
  - [SquareConnect::Country](docs/Country.md)
@@ -253,6 +259,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect::ErrorCode](docs/ErrorCode.md)
  - [SquareConnect::InventoryAlertType](docs/InventoryAlertType.md)
  - [SquareConnect::ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
+ - [SquareConnect::ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md)
+ - [SquareConnect::ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md)
+ - [SquareConnect::ListAdditionalRecipientReceivablesRequest](docs/ListAdditionalRecipientReceivablesRequest.md)
+ - [SquareConnect::ListAdditionalRecipientReceivablesResponse](docs/ListAdditionalRecipientReceivablesResponse.md)
  - [SquareConnect::ListCatalogRequest](docs/ListCatalogRequest.md)
  - [SquareConnect::ListCatalogResponse](docs/ListCatalogResponse.md)
  - [SquareConnect::ListCustomersRequest](docs/ListCustomersRequest.md)

data/docs/AdditionalRecipient.md

@@ -0,0 +1,15 @@
+# SquareConnect::AdditionalRecipient
+
+### Description
+
+Represents an additional recipient (other than the merchant) receiving a portion of this tender.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location_id** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | 
+**description** | **String** | The description of the additional recipient. | 
+**amount_money** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
+**receivable_id** | **String** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. TODO(botros): add required annotations on this, SETL-7263 | [optional] 
+
+

data/docs/AdditionalRecipientReceivable.md

@@ -0,0 +1,17 @@
+# SquareConnect::AdditionalRecipientReceivable
+
+### Description
+
+Represents a monetary distribution of part of a [Transaction](#type-transaction)'s amount for Transactions which included additional recipients. The location of this receivable is that same as the one specified in the [AdditionalRecipient](#type-additionalrecipient).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The additional recipient receivable's unique ID, issued by Square payments servers. | 
+**transaction_id** | **String** | The ID of the transaction that the additional recipient receivable was applied to. | 
+**transaction_location_id** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | 
+**amount_money** | [**Money**](Money.md) | The amount of the receivable. This will always be non-negative. | 
+**created_at** | **String** | The time when the additional recipient receivable was created, in RFC 3339 format. | [optional] 
+**refunds** | [**Array<AdditionalRecipientReceivableRefund>**](AdditionalRecipientReceivableRefund.md) | Any refunds of the receivable that have been applied. | [optional] 
+
+

data/docs/AdditionalRecipientReceivableRefund.md

@@ -0,0 +1,17 @@
+# SquareConnect::AdditionalRecipientReceivableRefund
+
+### Description
+
+A refund of an [AdditionalRecipientReceivable](#type-additionalrecipientreceivable). This includes the ID of the additional recipient receivable associated to this object, as well as a reference to the [Refund](#type-refund) that created this receivable refund.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The receivable refund's unique ID, issued by Square payments servers. | 
+**receivable_id** | **String** | The ID of the receivable that the refund was applied to. | 
+**refund_id** | **String** | The ID of the refund that is associated to this receivable refund. | 
+**transaction_location_id** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | 
+**amount_money** | [**Money**](Money.md) | The amount of the refund. This will always be non-negative. | 
+**created_at** | **String** | The time when the refund was created, in RFC 3339 format. | [optional] 
+
+

data/docs/CatalogApi.md

@@ -387,7 +387,7 @@ Name | Type | Description  | Notes
 
 SearchCatalogObjects
 
-Queries the targeted catalog using a variety of query types ([CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), ([CatalogQueryExact](#type-catalogqueryexact), ([CatalogQueryRange](#type-catalogqueryrange), ([CatalogQueryText](#type-catalogquerytext), ([CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), ([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).
+Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist).
 
 ### Example
 ```ruby

data/docs/ChargeRequest.md

@@ -19,5 +19,6 @@ Name | Type | Description | Notes
 **shipping_address** | [**Address**](Address.md) | The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. | [optional] 
 **buyer_email_address** | **String** | The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. | [optional] 
 **order_id** | **String** | The ID of the order to associate with this transaction.  If you provide this value, the `amount_money` value of your request must __exactly match__ the `total_money` value of the order's `order_amounts` field. | [optional] 
+**additional_recipients** | [**Array<AdditionalRecipient>**](AdditionalRecipient.md) | The basic primitive of multi party settlement. The value is optional. The transation facilitated by you can be splited from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in you charge's request. The `location_id` must be the valid location of the app owner merchant.  This field is currently not supported in sandbox. | [optional] 
 
 

data/docs/ChargeRequestAdditionalRecipient.md

@@ -0,0 +1,14 @@
+# SquareConnect::ChargeRequestAdditionalRecipient
+
+### Description
+
+Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location_id** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of the tender. | 
+**description** | **String** | The description of the additional recipient. | 
+**amount_money** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
+
+

data/docs/Checkout.md

@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **redirect_url** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to:  `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx`  If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. | [optional] 
 **order** | [**Order**](Order.md) | Order to be checked out. | [optional] 
 **created_at** | **String** | The time when the checkout was created, in RFC 3339 format. | [optional] 
+**additional_recipients** | [**Array<AdditionalRecipient>**](AdditionalRecipient.md) | Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration. | [optional] 
 
 

data/docs/CreateCheckoutRequest.md

@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 **pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field.  Default: none; only exists if explicitly set. | [optional] 
 **pre_populate_shipping_address** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields.  Default: none; only exists if explicitly set. | [optional] 
 **redirect_url** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to:  `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx`  If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.  Default: none; only exists if explicitly set. | [optional] 
+**additional_recipients** | [**Array<ChargeRequestAdditionalRecipient>**](ChargeRequestAdditionalRecipient.md) | The basic primitive of multi party settlement. The value is optional. The transation facilitated by you can be splited from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `total_money` calcualted by Square for your order. The `location_id` must be the valid location of the app owner merchant.  This field is currently not supported in sandbox. | [optional] 
 
 

data/docs/CreateCustomerCardRequest.md

@@ -7,7 +7,7 @@ Defines the fields that are included in the request body of a request to the [Cr
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**card_nonce** | **String** | A card nonce representing the credit card to link to the customer.  Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](/articles/adding-payment-form/) for more information. | 
+**card_nonce** | **String** | A card nonce representing the credit card to link to the customer.  Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](/articles/adding-payment-form/) for more information.  __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. | 
 **billing_address** | [**Address**](Address.md) | Address information for the card on file. Only the `postal_code` field is required for payments in the US and Canada. | [optional] 
 **cardholder_name** | **String** | The cardholder's name. | [optional] 
 

data/docs/ErrorCode.md

@@ -55,6 +55,7 @@ Name | Type
 **INVALID_EXPIRATION_YEAR** | string
 **INVALID_EXPIRATION_DATE** | string
 **UNSUPPORTED_CARD_BRAND** | string
+**UNSUPPORTED_ENTRY_METHOD** | string
 **INVALID_CARD** | string
 **DELAYED_TRANSACTION_EXPIRED** | string
 **DELAYED_TRANSACTION_CANCELED** | string
@@ -72,6 +73,7 @@ Name | Type
 **UNEXPECTED_VALUE** | string
 **SANDBOX_NOT_SUPPORTED** | string
 **INVALID_EMAIL_ADDRESS** | string
+**INVALID_PHONE_NUMBER** | string
 **CHECKOUT_EXPIRED** | string
 **CARD_DECLINED** | string
 **VERIFY_CVV_FAILURE** | string

data/docs/ListAdditionalRecipientReceivableRefundsRequest.md

@@ -0,0 +1,15 @@
+# SquareConnect::ListAdditionalRecipientReceivableRefundsRequest
+
+### Description
+
+Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**begin_time** | **String** | 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. | [optional] 
+**end_time** | **String** | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
+**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/ListAdditionalRecipientReceivableRefundsResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::ListAdditionalRecipientReceivableRefundsResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint.  One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**receivable_refunds** | [**Array<AdditionalRecipientReceivableRefund>**](AdditionalRecipientReceivableRefund.md) | An array of AdditionalRecipientReceivableRefunds that match your query. | [optional] 
+**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/ListAdditionalRecipientReceivablesRequest.md

@@ -0,0 +1,15 @@
+# SquareConnect::ListAdditionalRecipientReceivablesRequest
+
+### Description
+
+Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**begin_time** | **String** | 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. | [optional] 
+**end_time** | **String** | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
+**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/ListAdditionalRecipientReceivablesResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::ListAdditionalRecipientReceivablesResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint.  One of `errors` or `additional_recipient_receivables` is present in a given response (never both).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**receivables** | [**Array<AdditionalRecipientReceivable>**](AdditionalRecipientReceivable.md) | An array of AdditionalRecipientReceivables that match your query. | [optional] 
+**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/Refund.md

@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **amount_money** | [**Money**](Money.md) | The amount of money refunded to the buyer. | 
 **status** | **String** | The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). | 
 **processing_fee_money** | [**Money**](Money.md) | The amount of Square processing fee money refunded to the *merchant*. | [optional] 
+**additional_recipients** | [**Array<AdditionalRecipient>**](AdditionalRecipient.md) | Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration. | [optional] 
 
 

data/docs/ReportingApi.md

@@ -0,0 +1,134 @@
+# SquareConnect::ReportingApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_additional_recipient_receivable_refunds**](ReportingApi.md#list_additional_recipient_receivable_refunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds
+[**list_additional_recipient_receivables**](ReportingApi.md#list_additional_recipient_receivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables
+
+
+# **list_additional_recipient_receivable_refunds**
+> ListAdditionalRecipientReceivableRefundsResponse list_additional_recipient_receivable_refunds(location_id, opts)
+
+ListAdditionalRecipientReceivableRefunds
+
+Lists Additional Recipient Receivable Refunds for a particular location.  Max results per [page](#paginatingresults): 50
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::ReportingApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list AdditionalRecipientReceivableRefunds for.
+
+opts = { 
+  begin_time: "begin_time_example", # String | 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.
+  end_time: "end_time_example", # String | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
+  sort_order: "sort_order_example", # String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
+  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 your original query.  See [Paginating results](#paginatingresults) for more information.
+}
+
+begin
+  #ListAdditionalRecipientReceivableRefunds
+  result = api_instance.list_additional_recipient_receivable_refunds(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling ReportingApi->list_additional_recipient_receivable_refunds: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list AdditionalRecipientReceivableRefunds for. | 
+ **begin_time** | **String**| 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. | [optional] 
+ **end_time** | **String**| The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
+ **sort_order** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+ **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+### Return type
+
+[**ListAdditionalRecipientReceivableRefundsResponse**](ListAdditionalRecipientReceivableRefundsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_additional_recipient_receivables**
+> ListAdditionalRecipientReceivablesResponse list_additional_recipient_receivables(location_id, opts)
+
+ListAdditionalRecipientReceivables
+
+Lists Additional Recipient Receivables for a particular location.  Max results per [page](#paginatingresults): 50
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::ReportingApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list AdditionalRecipientReceivables for.
+
+opts = { 
+  begin_time: "begin_time_example", # String | 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.
+  end_time: "end_time_example", # String | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
+  sort_order: "sort_order_example", # String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
+  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 your original query.  See [Paginating results](#paginatingresults) for more information.
+}
+
+begin
+  #ListAdditionalRecipientReceivables
+  result = api_instance.list_additional_recipient_receivables(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling ReportingApi->list_additional_recipient_receivables: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list AdditionalRecipientReceivables for. | 
+ **begin_time** | **String**| 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. | [optional] 
+ **end_time** | **String**| The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
+ **sort_order** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+ **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+### Return type
+
+[**ListAdditionalRecipientReceivablesResponse**](ListAdditionalRecipientReceivablesResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Tender.md

@@ -18,5 +18,6 @@ Name | Type | Description | Notes
 **type** | **String** | The type of tender, such as `CARD` or `CASH`. | 
 **card_details** | [**TenderCardDetails**](TenderCardDetails.md) | The details of the card tender.  This value is present only if the value of `type` is `CARD`. | [optional] 
 **cash_details** | [**TenderCashDetails**](TenderCashDetails.md) | The details of the cash tender.  This value is present only if the value of `type` is `CASH`. | [optional] 
+**additional_recipients** | [**Array<AdditionalRecipient>**](AdditionalRecipient.md) | Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration. | [optional] 
 
 

data/lib/square_connect.rb

@@ -14,6 +14,9 @@ require 'square_connect/version'
 require 'square_connect/configuration'
 
 # Models
+require 'square_connect/models/additional_recipient'
+require 'square_connect/models/additional_recipient_receivable'
+require 'square_connect/models/additional_recipient_receivable_refund'
 require 'square_connect/models/address'
 require 'square_connect/models/batch_delete_catalog_objects_request'
 require 'square_connect/models/batch_delete_catalog_objects_response'
@@ -57,6 +60,7 @@ require 'square_connect/models/catalog_query_text'
 require 'square_connect/models/catalog_tax'
 require 'square_connect/models/catalog_v1_id'
 require 'square_connect/models/charge_request'
+require 'square_connect/models/charge_request_additional_recipient'
 require 'square_connect/models/charge_response'
 require 'square_connect/models/checkout'
 require 'square_connect/models/country'
@@ -90,6 +94,10 @@ require 'square_connect/models/error_category'
 require 'square_connect/models/error_code'
 require 'square_connect/models/inventory_alert_type'
 require 'square_connect/models/item_variation_location_overrides'
+require 'square_connect/models/list_additional_recipient_receivable_refunds_request'
+require 'square_connect/models/list_additional_recipient_receivable_refunds_response'
+require 'square_connect/models/list_additional_recipient_receivables_request'
+require 'square_connect/models/list_additional_recipient_receivables_response'
 require 'square_connect/models/list_catalog_request'
 require 'square_connect/models/list_catalog_response'
 require 'square_connect/models/list_customers_request'
@@ -193,6 +201,7 @@ require 'square_connect/api/checkout_api'
 require 'square_connect/api/customers_api'
 require 'square_connect/api/locations_api'
 require 'square_connect/api/orders_api'
+require 'square_connect/api/reporting_api'
 require 'square_connect/api/transactions_api'
 require 'square_connect/api/v1_employees_api'
 require 'square_connect/api/v1_items_api'