square_connect 2.0.2.69 → 2.1.0.beta

data/docs/V1LocationApi.md

@@ -0,0 +1,102 @@
+# SquareConnect::V1LocationApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_locations**](V1LocationApi.md#list_locations) | **GET** /v1/me/locations | Provides details for a business's locations, including their IDs.
+[**retrieve_business**](V1LocationApi.md#retrieve_business) | **GET** /v1/me | Get a business's information.
+
+
+# **list_locations**
+> Array<V1Merchant> list_locations
+
+Provides details for a business's locations, including their IDs.
+
+Provides details for a business's locations, including their IDs.
+
+### 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::V1LocationApi.new
+
+begin
+  #Provides details for a business's locations, including their IDs.
+  result = api_instance.list_locations
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1LocationApi->list_locations: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<V1Merchant>**](V1Merchant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_business**
+> V1Merchant retrieve_business
+
+Get a business's information.
+
+Get a business's information.
+
+### 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::V1LocationApi.new
+
+begin
+  #Get a business's information.
+  result = api_instance.retrieve_business
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1LocationApi->retrieve_business: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1Merchant**](V1Merchant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/V1LocationsApi.md

@@ -0,0 +1,102 @@
+# SquareConnect::V1LocationsApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_locations**](V1LocationsApi.md#list_locations) | **GET** /v1/me/locations | Provides details for a business's locations, including their IDs.
+[**retrieve_business**](V1LocationsApi.md#retrieve_business) | **GET** /v1/me | Get a business's information.
+
+
+# **list_locations**
+> Array<V1Merchant> list_locations
+
+Provides details for a business's locations, including their IDs.
+
+Provides details for a business's locations, including their IDs.
+
+### 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::V1LocationsApi.new
+
+begin
+  #Provides details for a business's locations, including their IDs.
+  result = api_instance.list_locations
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1LocationsApi->list_locations: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<V1Merchant>**](V1Merchant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_business**
+> V1Merchant retrieve_business
+
+Get a business's information.
+
+Get a business's information.
+
+### 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::V1LocationsApi.new
+
+begin
+  #Get a business's information.
+  result = api_instance.retrieve_business
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1LocationsApi->retrieve_business: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1Merchant**](V1Merchant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/V1Merchant.md

@@ -0,0 +1,26 @@
+# SquareConnect::V1Merchant
+
+### Description
+
+Defines the fields that are included in the response body of a request to the **RetrieveBusiness** endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The merchant account's unique identifier. | [optional] 
+**name** | **String** | The name associated with the merchant account. | [optional] 
+**email** | **String** | The email address associated with the merchant account. | [optional] 
+**account_type** | **String** | Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS). This value is almost always LOCATION. | [optional] 
+**account_capabilities** | **Array<String>** | Capabilities that are enabled for the merchant's Square account. Capabilities that are not listed in this array are not enabled for the account. | [optional] 
+**country_code** | **String** | The country associated with the merchant account, in ISO 3166-1-alpha-2 format. | [optional] 
+**language_code** | **String** | The language associated with the merchant account, in BCP 47 format. | [optional] 
+**currency_code** | **String** | The currency associated with the merchant account, in ISO 4217 format. For example, the currency code for US dollars is USD. | [optional] 
+**business_name** | **String** | The name of the merchant's business. | [optional] 
+**business_address** | [**Address**](Address.md) | The address of the merchant's business. | [optional] 
+**business_phone** | [**V1PhoneNumber**](V1PhoneNumber.md) | The phone number of the merchant's business. | [optional] 
+**business_type** | **String** | The type of business operated by the merchant. | [optional] 
+**shipping_address_** | [**Address**](Address.md) | The merchant's shipping address. | [optional] 
+**location_details** | [**V1MerchantLocationDetails**](V1MerchantLocationDetails.md) |  | [optional] 
+**market_url** | **String** | The URL of the merchant's online store. | [optional] 
+
+

data/docs/V1MerchantLocationDetails.md

@@ -0,0 +1,12 @@
+# SquareConnect::V1MerchantLocationDetails
+
+### Description
+
+Additional information for a single-location account specified by its associated business account, if it has one.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | The nickname assigned to the single-location account by the parent business. This value appears in the parent business's multi-location dashboard. | [optional] 
+
+

data/docs/V1ModifierList.md

@@ -0,0 +1,13 @@
+# SquareConnect::V1ModifierList
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The modifier list's unique ID. | [optional] 
+**name** | **String** | The modifier list's name. | [optional] 
+**selection_type** | **String** | Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. | [optional] 
+**modifier_options** | [**Array<V1ModifierOption>**](V1ModifierOption.md) | The options included in the modifier list. | [optional] 
+
+

data/docs/V1ModifierOption.md

@@ -0,0 +1,15 @@
+# SquareConnect::V1ModifierOption
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The modifier option's unique ID. | [optional] 
+**name** | **String** | The modifier option's name. | [optional] 
+**price_money** | [**V1Money**](V1Money.md) | The modifier option's price. | [optional] 
+**on_by_default** | **BOOLEAN** | If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE. | [optional] 
+**ordinal** | **Integer** | Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. | [optional] 
+**modifier_list_id** | **String** | The ID of the modifier list the option belongs to. | [optional] 
+
+

data/docs/V1Money.md

@@ -0,0 +1,13 @@
+# SquareConnect::V1Money
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). | [optional] 
+**currency_code** | **String** |  | [optional] 
+
+

data/docs/V1Order.md

@@ -0,0 +1,34 @@
+# SquareConnect::V1Order
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**id** | **String** | The order's unique identifier. | [optional] 
+**buyer_email** | **String** | The email address of the order's buyer. | [optional] 
+**recipient_name** | **String** | The name of the order's buyer. | [optional] 
+**recipient_phone_number** | **String** | The phone number to use for the order's delivery. | [optional] 
+**state** | **String** | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. | [optional] 
+**shipping_address** | [**Address**](Address.md) | The address to ship the order to. | [optional] 
+**subtotal_money** | [**V1Money**](V1Money.md) | The amount of all items purchased in the order, before taxes and shipping. | [optional] 
+**total_shipping_money** | [**V1Money**](V1Money.md) | The shipping cost for the order. | [optional] 
+**total_tax_money** | [**V1Money**](V1Money.md) | The total of all taxes applied to the order. | [optional] 
+**total_price_money** | [**V1Money**](V1Money.md) | The total cost of the order. | [optional] 
+**total_discount_money** | [**V1Money**](V1Money.md) | The total of all discounts applied to the order. | [optional] 
+**created_at** | **String** | The time when the order was created, in ISO 8601 format. | [optional] 
+**updated_at** | **String** | The time when the order was last modified, in ISO 8601 format. | [optional] 
+**expires_at** | **String** | The time when the order expires if no action is taken, in ISO 8601 format. | [optional] 
+**payment_id** | **String** | The unique identifier of the payment associated with the order. | [optional] 
+**buyer_note** | **String** | A note provided by the buyer when the order was created, if any. | [optional] 
+**completed_note** | **String** | A note provided by the merchant when the order's state was set to COMPLETED, if any | [optional] 
+**refunded_note** | **String** | A note provided by the merchant when the order's state was set to REFUNDED, if any. | [optional] 
+**canceled_note** | **String** | A note provided by the merchant when the order's state was set to CANCELED, if any. | [optional] 
+**tender** | [**V1Tender**](V1Tender.md) | The tender used to pay for the order. | [optional] 
+**order_history** | [**Array<V1OrderHistoryEntry>**](V1OrderHistoryEntry.md) | The history of actions associated with the order. | [optional] 
+**promo_code** | **String** | The promo code provided by the buyer, if any. | [optional] 
+**btc_receive_address** | **String** | For Bitcoin transactions, the address that the buyer sent Bitcoin to. | [optional] 
+**btc_price_satoshi** | **Float** | For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC). | [optional] 
+
+

data/docs/V1OrderHistoryEntry.md

@@ -0,0 +1,11 @@
+# SquareConnect::V1OrderHistoryEntry
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | The type of action performed on the order. | [optional] 
+**created_at** | **String** | The time when the action was performed, in ISO 8601 format. | [optional] 
+
+

data/docs/V1Page.md

@@ -0,0 +1,13 @@
+# SquareConnect::V1Page
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The page's unique identifier. | [optional] 
+**name** | **String** | The page's name, if any. | [optional] 
+**page_index** | **Integer** | The page's position in the merchant's list of pages. Always an integer between 0 and 4, inclusive. | [optional] 
+**cells** | [**Array<V1PageCell>**](V1PageCell.md) | The cells included on the page. | [optional] 
+
+

data/docs/V1PageCell.md

@@ -0,0 +1,15 @@
+# SquareConnect::V1PageCell
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_id** | **String** | The unique identifier of the page the cell is included on. | [optional] 
+**row** | **Integer** | The row of the cell. Always an integer between 0 and 4, inclusive. | [optional] 
+**column** | **Integer** | The column of the cell. Always an integer between 0 and 4, inclusive. | [optional] 
+**object_type** | **Array<String>** | The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). | [optional] 
+**object_id** | **String** | The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER. | [optional] 
+**placeholder_type** | **Array<String>** | For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. | [optional] 
+
+

data/docs/V1Payment.md

@@ -0,0 +1,33 @@
+# SquareConnect::V1Payment
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The payment's unique identifier. | [optional] 
+**merchant_id** | **String** | The unique identifier of the merchant that took the payment. | [optional] 
+**created_at** | **String** | The time when the payment was created, in ISO 8601 format. | [optional] 
+**creator_id** | **BOOLEAN** | The unique identifier of the Square account that took the payment. | [optional] 
+**device** | [**Device**](Device.md) | The device that took the payment. | [optional] 
+**payment_url** | **String** | The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page. | [optional] 
+**receipt_url** | **String** | The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment. | [optional] 
+**inclusive_tax_money** | [**V1Money**](V1Money.md) | The sum of all inclusive taxes associated with the payment. | [optional] 
+**additive_tax_money** | [**V1Money**](V1Money.md) | The sum of all additive taxes associated with the payment. | [optional] 
+**tax_money** | [**V1Money**](V1Money.md) | The total of all taxes applied to the payment. This is always the sum of inclusive_tax_money and additive_tax_money. | [optional] 
+**tip_money** | [**V1Money**](V1Money.md) | The total of all tips applied to the payment. | [optional] 
+**discount_money** | [**V1Money**](V1Money.md) | The total of all discounts applied to the payment. | [optional] 
+**total_collected_money** | [**V1Money**](V1Money.md) | The total of all discounts applied to the payment. | [optional] 
+**processing_fee_money** | [**V1Money**](V1Money.md) | The total of all processing fees collected by Square for the payment. | [optional] 
+**net_total_money** | [**V1Money**](V1Money.md) | The amount to be deposited into the merchant's bank account for the payment. | [optional] 
+**refunded_money** | [**V1Money**](V1Money.md) | The total of all refunds applied to the payment. | [optional] 
+**swedish_rounding_money** | [**V1Money**](V1Money.md) |  | [optional] 
+**gross_sales_money** | [**V1Money**](V1Money.md) |  | [optional] 
+**net_sales_money** | [**V1Money**](V1Money.md) |  | [optional] 
+**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] 
+**itemizations** | [**Array<V1PaymentItemization>**](V1PaymentItemization.md) | The items purchased in the payment. | [optional] 
+
+

data/docs/V1PaymentDiscount.md

@@ -0,0 +1,12 @@
+# SquareConnect::V1PaymentDiscount
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The discount's name. | [optional] 
+**applied_money** | [**V1Money**](V1Money.md) | The amount of money that this discount adds to the payment (note that this value is always negative or zero). | [optional] 
+**discount_id** | **String** | The ID of the applied discount, if available. Discounts applied in older versions of Square Register might not have an ID. | [optional] 
+
+

data/docs/V1PaymentItemDetail.md

@@ -0,0 +1,13 @@
+# SquareConnect::V1PaymentItemDetail
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category_name** | **String** | The name of the item's merchant-defined category, if any. | [optional] 
+**sku** | **Float** |  The item's merchant-defined SKU, if any. | [optional] 
+**item_id** | **String** | The unique ID of the item purchased, if any. | [optional] 
+**item_variation_id** | **String** | The unique ID of the item variation purchased, if any. | [optional] 
+
+

data/docs/V1PaymentItemization.md

@@ -0,0 +1,23 @@
+# SquareConnect::V1PaymentItemization
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The item's name. | [optional] 
+**quantity** | **Float** | The quantity of the item purchased. This can be a decimal value. | [optional] 
+**itemization_type** | **String** | The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT | [optional] 
+**item_detail** | [**V1PaymentItemDetail**](V1PaymentItemDetail.md) | Details of the item, including its unique identifier and the identifier of the item variation purchased. | [optional] 
+**notes** | **String** | Notes entered by the merchant about the item at the time of payment, if any. | [optional] 
+**item_variation_name** | **String** | The name of the item variation purchased, if any. | [optional] 
+**total_money** | [**V1Money**](V1Money.md) | The total cost of the item, including all taxes and discounts. | [optional] 
+**single_quantity_money** | [**V1Money**](V1Money.md) | The cost of a single unit of this item. | [optional] 
+**gross_sales_money** | [**V1Money**](V1Money.md) | The total cost of the itemization and its modifiers, not including taxes or discounts. | [optional] 
+**discount_money** | [**V1Money**](V1Money.md) | The total of all discounts applied to the itemization. This value is always negative or zero. | [optional] 
+**net_sales_money** | [**V1Money**](V1Money.md) | The sum of gross_sales_money and discount_money. | [optional] 
+**taxes** | [**Array<V1PaymentTax>**](V1PaymentTax.md) | All taxes applied to this itemization. | [optional] 
+**discounts** | [**Array<V1PaymentDiscount>**](V1PaymentDiscount.md) | All discounts applied to this itemization. | [optional] 
+**modifiers** | [**Array<V1PaymentModifier>**](V1PaymentModifier.md) | All modifier options applied to this itemization. | [optional] 
+
+