square_connect 2.0.0 → 2.0.2.13

data/docs/LocationApi.md

@@ -0,0 +1,56 @@
+# SquareConnect::LocationApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_locations**](LocationApi.md#list_locations) | **GET** /v2/locations | ListLocations
+
+
+# **list_locations**
+> ListLocationsResponse list_locations(authorization)
+
+ListLocations
+
+Provides the details for all of a business's locations.  Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::LocationApi.new
+
+authorization = "authorization_example" # String | The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+
+
+begin
+  #ListLocations
+  result = api_instance.list_locations(authorization)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling LocationApi->list_locations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`. | 
+
+### Return type
+
+[**ListLocationsResponse**](ListLocationsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/LocationCapability.md

@@ -0,0 +1,12 @@
+# SquareConnect::LocationCapability
+
+### Description
+
+Indicates account capabilities that a business's location might or might not have enabled.
+
+## Properties
+Name | Type
+------------ | -------------
+**CREDIT_CARD_PROCESSING** | string
+
+

data/docs/Money.md

@@ -0,0 +1,13 @@
+# SquareConnect::Money
+
+### Description
+
+Represents an amount of money.  __Important:__ Unlike version 1 of the Connect API, __all monetary amounts returned by v2 endpoints are positive.__ (In v1, monetary amounts are negative if they represent money being paid _by_ a merchant, instead of money being paid _to_ a merchant.)
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. | [optional] 
+**currency** | **String** | The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`.  See [Currency](#type-currency) for possible values. | [optional] 
+
+

data/docs/Order.md

@@ -0,0 +1,16 @@
+# SquareConnect::Order
+
+### Description
+
+Contains all information related to a single order to process with Square, including line items that specify the products to purchase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The order's unique ID.  This value is not present if the order was not created with the [CreateOrder](#endpoint-createorder) endpoint. | [optional] 
+**location_id** | **String** | The ID of the merchant location this order is associated with. | [optional] 
+**reference_id** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional] 
+**line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. Every order has at least one line item. | [optional] 
+**total_money** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional] 
+
+

data/docs/OrderLineItem.md

@@ -0,0 +1,16 @@
+# SquareConnect::OrderLineItem
+
+### Description
+
+Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The line item's ID, unique only within this order. | [optional] 
+**name** | **String** | The name of the line item. | [optional] 
+**quantity** | **String** | The quantity of the product to purchase. Currently, this string must have an integer value. | [optional] 
+**base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item's associated variation.  If a line item represents a Custom Amount instead of a particular product, this field indicates that amount. | [optional] 
+**total_money** | [**Money**](Money.md) | The total amount of money to collect for this line item. | [optional] 
+
+

data/docs/Refund.md

@@ -0,0 +1,20 @@
+# SquareConnect::Refund
+
+### Description
+
+Represents a refund processed for a Square transaction.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The refund's unique ID. | 
+**location_id** | **String** | The ID of the refund's associated location. | 
+**transaction_id** | **String** | The ID of the transaction that the refunded tender is part of. | 
+**tender_id** | **String** | The ID of the refunded tender. | 
+**created_at** | **String** | The time when the refund was created, in RFC 3339 format. | [optional] 
+**reason** | **String** | The reason for the refund being issued. | 
+**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] 
+
+

data/docs/RefundApi.md

@@ -0,0 +1,126 @@
+# SquareConnect::RefundApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_refund**](RefundApi.md#create_refund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund
+[**list_refunds**](RefundApi.md#list_refunds) | **GET** /v2/locations/{location_id}/refunds | ListRefunds
+
+
+# **create_refund**
+> CreateRefundResponse create_refund(authorization, location_id, transaction_id, body)
+
+CreateRefund
+
+Initiates a refund for a previously charged tender.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::RefundApi.new
+
+authorization = "authorization_example" # String | The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+
+location_id = "location_id_example" # String | The ID of the original transaction's associated location.
+
+transaction_id = "transaction_id_example" # String | The ID of the original transaction that includes the tender to refund.
+
+body = SquareConnect::CreateRefundRequest.new # CreateRefundRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #CreateRefund
+  result = api_instance.create_refund(authorization, location_id, transaction_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling RefundApi->create_refund: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`. | 
+ **location_id** | **String**| The ID of the original transaction's associated location. | 
+ **transaction_id** | **String**| The ID of the original transaction that includes the tender to refund. | 
+ **body** | [**CreateRefundRequest**](CreateRefundRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**CreateRefundResponse**](CreateRefundResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_refunds**
+> ListRefundsResponse list_refunds(authorization, location_id, opts)
+
+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
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::RefundApi.new
+
+authorization = "authorization_example" # String | The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+
+location_id = "location_id_example" # String | The ID of the location to list refunds 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
+  #ListRefunds
+  result = api_instance.list_refunds(authorization, location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling RefundApi->list_refunds: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`. | 
+ **location_id** | **String**| The ID of the location to list refunds 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
+
+[**ListRefundsResponse**](ListRefundsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/RefundStatus.md

@@ -0,0 +1,15 @@
+# SquareConnect::RefundStatus
+
+### Description
+
+Indicates a refund's current status.
+
+## Properties
+Name | Type
+------------ | -------------
+**PENDING** | string
+**APPROVED** | string
+**REJECTED** | string
+**FAILED** | string
+
+

data/docs/RetrieveCustomerRequest.md

@@ -0,0 +1,11 @@
+# SquareConnect::RetrieveCustomerRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RetrieveCustomerResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::RetrieveCustomerResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [RetrieveCustomer](#endpoint-retrievecustomer) endpoint.  One of `errors` or `customer` 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] 
+**customer** | [**Customer**](Customer.md) | The requested customer. | [optional] 
+
+

data/docs/RetrieveTransactionRequest.md

@@ -0,0 +1,11 @@
+# SquareConnect::RetrieveTransactionRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RetrieveTransactionResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::RetrieveTransactionResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [RetrieveTransaction](#endpont-retrievetransaction) endpoint.  One of `errors` or `transaction` 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] 
+**transaction** | [**Transaction**](Transaction.md) | The requested transaction. | [optional] 
+
+

data/docs/SortOrder.md

@@ -0,0 +1,13 @@
+# SquareConnect::SortOrder
+
+### Description
+
+The order (e.g., chronological or alphabetical) in which results from a request are returned.
+
+## Properties
+Name | Type
+------------ | -------------
+**DESC** | string
+**ASC** | string
+
+

data/docs/Tender.md

@@ -0,0 +1,22 @@
+# SquareConnect::Tender
+
+### Description
+
+Represents a tender (i.e., a method of payment) used in a Square transaction.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The tender's unique ID. | [optional] 
+**location_id** | **String** | The ID of the transaction's associated location. | [optional] 
+**transaction_id** | **String** | The ID of the tender's associated transaction. | [optional] 
+**created_at** | **String** | The time when the tender was created, in RFC 3339 format. | [optional] 
+**note** | **String** | An optional note associated with the tender at the time of payment. | [optional] 
+**amount_money** | [**Money**](Money.md) | The amount of the tender. | [optional] 
+**processing_fee_money** | [**Money**](Money.md) | The amount of any Square processing fees applied to the tender.  This field is not immediately populated when a new transaction is created. It is usually available after about ten seconds. | [optional] 
+**customer_id** | **String** | If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer. | [optional] 
+**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] 
+
+

data/docs/TenderCardDetails.md

@@ -0,0 +1,14 @@
+# SquareConnect::TenderCardDetails
+
+### Description
+
+Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values. | [optional] 
+**card** | [**Card**](Card.md) | The credit card's non-confidential details. | [optional] 
+**entry_method** | **String** | The method used to enter the card's details for the transaction. | [optional] 
+
+

data/docs/TenderCardDetailsEntryMethod.md

@@ -0,0 +1,16 @@
+# SquareConnect::TenderCardDetailsEntryMethod
+
+### Description
+
+Indicates the method used to enter the card's details.
+
+## Properties
+Name | Type
+------------ | -------------
+**SWIPED** | string
+**KEYED** | string
+**EMV** | string
+**ON_FILE** | string
+**CONTACTLESS** | string
+
+

data/docs/TenderCardDetailsStatus.md

@@ -0,0 +1,15 @@
+# SquareConnect::TenderCardDetailsStatus
+
+### Description
+
+Indicates the card transaction's current status.
+
+## Properties
+Name | Type
+------------ | -------------
+**AUTHORIZED** | string
+**CAPTURED** | string
+**VOIDED** | string
+**FAILED** | string
+
+

data/docs/TenderCashDetails.md

@@ -0,0 +1,13 @@
+# SquareConnect::TenderCashDetails
+
+### Description
+
+Represents the details of a tender with `type` `CASH`.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyer_tendered_money** | [**Money**](Money.md) | The total amount of cash provided by the buyer, before change is given. | [optional] 
+**change_back_money** | [**Money**](Money.md) | The amount of change returned to the buyer. | [optional] 
+
+

data/docs/TenderType.md

@@ -0,0 +1,17 @@
+# SquareConnect::TenderType
+
+### Description
+
+Indicates a tender's type.
+
+## Properties
+Name | Type
+------------ | -------------
+**CARD** | string
+**CASH** | string
+**THIRD_PARTY_CARD** | string
+**SQUARE_GIFT_CARD** | string
+**NO_SALE** | string
+**OTHER** | string
+
+