square_connect 2.0.2.69 → 2.1.0.beta

data/docs/V1PaymentModifier.md

@@ -0,0 +1,12 @@
+# SquareConnect::V1PaymentModifier
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The modifier option's name. | [optional] 
+**applied_money** | [**V1Money**](V1Money.md) | The amount of money that this modifier option adds to the payment. | [optional] 
+**modifier_option_id** | **String** | TThe ID of the applied modifier option, if available. Modifier options applied in older versions of Square Register might not have an ID. | [optional] 
+
+

data/docs/V1PaymentTax.md

@@ -0,0 +1,15 @@
+# SquareConnect::V1PaymentTax
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**name** | **String** | The merchant-defined name of the tax. | [optional] 
+**applied_money** | [**V1Money**](V1Money.md) | The amount of money that this tax adds to the payment. | [optional] 
+**rate** | **String** | The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. | [optional] 
+**inclusion_type** | **String** | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. | [optional] 
+**fee_id** | **String** | The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. | [optional] 
+
+

data/docs/V1PhoneNumber.md

@@ -0,0 +1,13 @@
+# SquareConnect::V1PhoneNumber
+
+### Description
+
+Represents a phone number.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calling_code** | **String** | The phone number's international calling code. For US phone numbers, this value is +1. | 
+**number** | **String** | The phone number. | 
+
+

data/docs/V1Refund.md

@@ -0,0 +1,16 @@
+# SquareConnect::V1Refund
+
+### Description
+
+## Properties
+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] 
+**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] 
+**merchant_id** | **String** |  | [optional] 
+
+

data/docs/V1Settlement.md

@@ -0,0 +1,15 @@
+# SquareConnect::V1Settlement
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The settlement's unique identifier. | [optional] 
+**status** | **String** | The settlement's current status. | [optional] 
+**total_money** | [**V1Money**](V1Money.md) | The amount of money involved in the settlement. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero. | [optional] 
+**initiated_at** | **String** | The time when the settlement was submitted for deposit or withdrawal, in ISO 8601 format. | [optional] 
+**bank_account_id** | **String** | The Square-issued unique identifier for the bank account associated with the settlement. | [optional] 
+**entries** | [**Array<V1SettlementEntry>**](V1SettlementEntry.md) | The entries included in this settlement. | [optional] 
+
+

data/docs/V1SettlementEntry.md

@@ -0,0 +1,13 @@
+# SquareConnect::V1SettlementEntry
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | The settlement's unique identifier. | [optional] 
+**type** | **String** | The settlement's current status. | [optional] 
+**amount_money** | [**V1Money**](V1Money.md) | The total amount of money this entry contributes to the total settlement amount. | [optional] 
+**fee_money** | [**V1Money**](V1Money.md) | The amount of all Square fees associated with this settlement entry. This value is always negative or zero. | [optional] 
+
+

data/docs/V1Tender.md

@@ -0,0 +1,22 @@
+# SquareConnect::V1Tender
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The tender's unique ID. | [optional] 
+**type** | **String** | The type of tender. | [optional] 
+**name** | **String** | A human-readable description of the tender. | [optional] 
+**employee_id** | **String** | The ID of the employee that processed the tender. | [optional] 
+**receipt_url** | **String** | The URL of the receipt for the tender. | [optional] 
+**card_brand** | **String** | The brand of credit card provided. | [optional] 
+**pan_suffix** | **String** | The last four digits of the provided credit card's account number. | [optional] 
+**entry_method** | **String** | The tender's unique ID. | [optional] 
+**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] 
+**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] 
+
+

data/docs/V1Timecard.md

@@ -0,0 +1,20 @@
+# SquareConnect::V1Timecard
+
+### Description
+
+Represents a timecard for an employee.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The timecard's unique ID. | [optional] 
+**employee_id** | **String** | The ID of the employee the timecard is associated with. | 
+**deleted** | **BOOLEAN** | If true, the timecard was deleted by the merchant, and it is no longer valid. | [optional] 
+**clockin_time** | **String** | The clock-in time for the timecard, in ISO 8601 format. | [optional] 
+**clockout_time** | **String** | The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system. | [optional] 
+**clockin_location_id** | **String** | The ID of the location the employee clocked in from, if any. | [optional] 
+**clockout_location_id** | **String** | The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system. | [optional] 
+**created_at** | **String** | The time when the timecard was created, in ISO 8601 format. | [optional] 
+**updated_at** | **String** | The time when the timecard was most recently updated, in ISO 8601 format. | [optional] 
+
+

data/docs/V1TimecardEvent.md

@@ -0,0 +1,14 @@
+# SquareConnect::V1TimecardEvent
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The event's unique ID. | [optional] 
+**event_type** | **String** | The ID of the timecard to list events for. | [optional] 
+**clockin_time** | **String** | The time the employee clocked in, in ISO 8601 format. | [optional] 
+**clockout_time** | **String** | The time the employee clocked out, in ISO 8601 format. | [optional] 
+**created_at** | **String** | The time when the event was created, in ISO 8601 format. | [optional] 
+
+

data/docs/V1TransactionsApi.md

@@ -0,0 +1,650 @@
+# SquareConnect::V1TransactionsApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_refund**](V1TransactionsApi.md#create_refund) | **POST** /v1/{location_id}/refunds | Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.
+[**list_bank_accounts**](V1TransactionsApi.md#list_bank_accounts) | **GET** /v1/{location_id}/bank-accounts | Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+[**list_orders**](V1TransactionsApi.md#list_orders) | **GET** /v1/{location_id}/orders | Provides summary information for a merchant's online store orders.
+[**list_payments**](V1TransactionsApi.md#list_payments) | **GET** /v1/{location_id}/payments | 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_refunds**](V1TransactionsApi.md#list_refunds) | **GET** /v1/{location_id}/refunds | Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.
+[**list_settlements**](V1TransactionsApi.md#list_settlements) | **GET** /v1/{location_id}/settlements | Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.
+[**retrieve_bank_account**](V1TransactionsApi.md#retrieve_bank_account) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+[**retrieve_order**](V1TransactionsApi.md#retrieve_order) | **GET** /v1/{location_id}/orders/{order_id} | Provides comprehensive information for a single online store order, including the order's history.
+[**retrieve_payment**](V1TransactionsApi.md#retrieve_payment) | **GET** /v1/{location_id}/payments/{payment_id} | Provides comprehensive information for a single payment.
+[**retrieve_settlement**](V1TransactionsApi.md#retrieve_settlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.
+[**update_order**](V1TransactionsApi.md#update_order) | **PUT** /v1/{location_id}/orders/{order_id} | Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
+
+
+# **create_refund**
+> V1Refund create_refund(location_id, body)
+
+Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.
+
+Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the original payment's associated location.
+
+body = SquareConnect::V1CreateRefundRequest.new # V1CreateRefundRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.
+  result = api_instance.create_refund(location_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->create_refund: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the original payment's associated location. | 
+ **body** | [**V1CreateRefundRequest**](V1CreateRefundRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1Refund**](V1Refund.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_bank_accounts**
+> Array<V1BankAccount> list_bank_accounts(location_id)
+
+Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+
+Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list bank accounts for.
+
+
+begin
+  #Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+  result = api_instance.list_bank_accounts(location_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->list_bank_accounts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list bank accounts for. | 
+
+### Return type
+
+[**Array<V1BankAccount>**](V1BankAccount.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_orders**
+> Array<V1Order> list_orders(location_id, opts)
+
+Provides summary information for a merchant's online store orders.
+
+Provides summary information for a merchant's online store orders.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list online store orders for.
+
+opts = { 
+  order: "order_example", # String | TThe order in which payments are listed in the response.
+  limit: 56 # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+}
+
+begin
+  #Provides summary information for a merchant's online store orders.
+  result = api_instance.list_orders(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->list_orders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list online store orders for. | 
+ **order** | **String**| TThe order in which payments are listed in the response. | [optional] 
+ **limit** | **Integer**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
+
+### Return type
+
+[**Array<V1Order>**](V1Order.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_payments**
+> Array<V1Payment> list_payments(location_id, opts)
+
+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.
+
+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.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
+
+opts = { 
+  order: "order_example", # String | The 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.
+}
+
+begin
+  #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.
+  result = api_instance.list_payments(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->list_payments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. | 
+ **order** | **String**| The 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] 
+
+### Return type
+
+[**Array<V1Payment>**](V1Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_refunds**
+> Array<V1Refund> list_refunds(location_id, opts)
+
+Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.
+
+Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list refunds for.
+
+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.
+}
+
+begin
+  #Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.
+  result = api_instance.list_refunds(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->list_refunds: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list refunds for. | 
+ **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] 
+
+### Return type
+
+[**Array<V1Refund>**](V1Refund.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_settlements**
+> Array<V1Settlement> list_settlements(location_id, opts)
+
+Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.
+
+Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. 
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
+
+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.
+  status: "status_example" # String | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
+}
+
+begin
+  #Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.
+  result = api_instance.list_settlements(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->list_settlements: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. | 
+ **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] 
+ **status** | **String**| Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). | [optional] 
+
+### Return type
+
+[**Array<V1Settlement>**](V1Settlement.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_bank_account**
+> V1BankAccount retrieve_bank_account(location_id, bank_account_id)
+
+Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+
+Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the bank account's associated location.
+
+bank_account_id = "bank_account_id_example" # String | The bank account's Square-issued ID. You obtain this value from Settlement objects returned.
+
+
+begin
+  #Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
+  result = api_instance.retrieve_bank_account(location_id, bank_account_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->retrieve_bank_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the bank account's associated location. | 
+ **bank_account_id** | **String**| The bank account's Square-issued ID. You obtain this value from Settlement objects returned. | 
+
+### Return type
+
+[**V1BankAccount**](V1BankAccount.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_order**
+> V1Order retrieve_order(location_id, order_id)
+
+Provides comprehensive information for a single online store order, including the order's history.
+
+Provides comprehensive information for a single online store order, including the order's history.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the order's associated location.
+
+order_id = "order_id_example" # String | The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint
+
+
+begin
+  #Provides comprehensive information for a single online store order, including the order's history.
+  result = api_instance.retrieve_order(location_id, order_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->retrieve_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the order's associated location. | 
+ **order_id** | **String**| The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint | 
+
+### Return type
+
+[**V1Order**](V1Order.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_payment**
+> V1Payment retrieve_payment(location_id, payment_id)
+
+Provides comprehensive information for a single payment.
+
+Provides comprehensive information for a single payment.
+
+### 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::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.
+
+
+begin
+  #Provides comprehensive information for a single payment.
+  result = api_instance.retrieve_payment(location_id, payment_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->retrieve_payment: #{e}"
+end
+```
+
+### Parameters
+
+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. | 
+
+### Return type
+
+[**V1Payment**](V1Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_settlement**
+> V1Settlement retrieve_settlement(location_id, settlement_id)
+
+Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.
+
+Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the settlements's associated location.
+
+settlement_id = "settlement_id_example" # String | The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.
+
+
+begin
+  #Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.
+  result = api_instance.retrieve_settlement(location_id, settlement_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->retrieve_settlement: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the settlements's associated location. | 
+ **settlement_id** | **String**| The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. | 
+
+### Return type
+
+[**V1Settlement**](V1Settlement.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_order**
+> V1Order update_order(location_id, order_id, body)
+
+Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
+
+Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
+
+### 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::V1TransactionsApi.new
+
+location_id = "location_id_example" # String | The ID of the order's associated location.
+
+order_id = "order_id_example" # String | The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint
+
+body = SquareConnect::V1UpdateOrderRequest.new # V1UpdateOrderRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
+  result = api_instance.update_order(location_id, order_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1TransactionsApi->update_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the order's associated location. | 
+ **order_id** | **String**| The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint | 
+ **body** | [**V1UpdateOrderRequest**](V1UpdateOrderRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1Order**](V1Order.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+