square_connect 2.0.0 → 2.0.2.13

data/docs/Transaction.md

@@ -0,0 +1,21 @@
+# SquareConnect::Transaction
+
+### Description
+
+Represents a transaction processed with Square, either with the Connect API or with Square Register.  The `tenders` field of this object lists all methods of payment used to pay in the transaction.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The transaction's unique ID, issued by Square payments servers. | [optional] 
+**location_id** | **String** | The ID of the transaction's associated location. | [optional] 
+**created_at** | **String** | The time when the transaction was created, in RFC 3339 format. | [optional] 
+**tenders** | [**Array<Tender>**](Tender.md) | The tenders used to pay in the transaction. | [optional] 
+**refunds** | [**Array<Refund>**](Refund.md) | Refunds that have been applied to any tender in the transaction. | [optional] 
+**reference_id** | **String** | If the transaction was created with the [Charge](#endpoint-charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. | [optional] 
+**product** | **String** | The Square product that processed the transaction. | [optional] 
+**client_id** | **String** | If the transaction was created in the Square Register app, this value is the ID generated for the transaction by Square Register.  This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode).  It is not currently possible with the Connect API to perform a transaction lookup by this value. | [optional] 
+**order** | [**Order**](Order.md) | The order associated with this transaction, if any. | [optional] 
+**shipping_address** | [**Address**](Address.md) | The shipping address provided in the request, if any. | [optional] 
+
+

data/docs/TransactionApi.md

@@ -0,0 +1,285 @@
+# SquareConnect::TransactionApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**capture_transaction**](TransactionApi.md#capture_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction
+[**charge**](TransactionApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge
+[**list_transactions**](TransactionApi.md#list_transactions) | **GET** /v2/locations/{location_id}/transactions | ListTransactions
+[**retrieve_transaction**](TransactionApi.md#retrieve_transaction) | **GET** /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction
+[**void_transaction**](TransactionApi.md#void_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction
+
+
+# **capture_transaction**
+> CaptureTransactionResponse capture_transaction(authorization, location_id, transaction_id)
+
+CaptureTransaction
+
+Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::TransactionApi.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 | 
+
+transaction_id = "transaction_id_example" # String | 
+
+
+begin
+  #CaptureTransaction
+  result = api_instance.capture_transaction(authorization, location_id, transaction_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling TransactionApi->capture_transaction: #{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**|  | 
+ **transaction_id** | **String**|  | 
+
+### Return type
+
+[**CaptureTransactionResponse**](CaptureTransactionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **charge**
+> ChargeResponse charge(authorization, location_id, body)
+
+Charge
+
+Charges a card represented by a card nonce or a customer's card on file.  Your request to this endpoint must include _either_:  - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file)  In order for an e-commerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request:  - `buyer_email_address` - At least one of `billing_address` or `shipping_address`  When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::TransactionApi.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 associate the created transaction with.
+
+body = SquareConnect::ChargeRequest.new # ChargeRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Charge
+  result = api_instance.charge(authorization, location_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling TransactionApi->charge: #{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 associate the created transaction with. | 
+ **body** | [**ChargeRequest**](ChargeRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**ChargeResponse**](ChargeResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_transactions**
+> ListTransactionsResponse list_transactions(authorization, location_id, opts)
+
+ListTransactions
+
+Lists transactions for a particular location.  Max results per [page](#paginatingresults): 50
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::TransactionApi.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 transactions 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
+  #ListTransactions
+  result = api_instance.list_transactions(authorization, location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling TransactionApi->list_transactions: #{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 transactions 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
+
+[**ListTransactionsResponse**](ListTransactionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_transaction**
+> RetrieveTransactionResponse retrieve_transaction(authorization, location_id, transaction_id)
+
+RetrieveTransaction
+
+Retrieves details for a single transaction.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::TransactionApi.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 transaction's associated location.
+
+transaction_id = "transaction_id_example" # String | The ID of the transaction to retrieve.
+
+
+begin
+  #RetrieveTransaction
+  result = api_instance.retrieve_transaction(authorization, location_id, transaction_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling TransactionApi->retrieve_transaction: #{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 transaction's associated location. | 
+ **transaction_id** | **String**| The ID of the transaction to retrieve. | 
+
+### Return type
+
+[**RetrieveTransactionResponse**](RetrieveTransactionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **void_transaction**
+> VoidTransactionResponse void_transaction(authorization, location_id, transaction_id)
+
+VoidTransaction
+
+Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::TransactionApi.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 | 
+
+transaction_id = "transaction_id_example" # String | 
+
+
+begin
+  #VoidTransaction
+  result = api_instance.void_transaction(authorization, location_id, transaction_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling TransactionApi->void_transaction: #{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**|  | 
+ **transaction_id** | **String**|  | 
+
+### Return type
+
+[**VoidTransactionResponse**](VoidTransactionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TransactionProduct.md

@@ -0,0 +1,19 @@
+# SquareConnect::TransactionProduct
+
+### Description
+
+Indicates the Square product used to process a transaction.
+
+## Properties
+Name | Type
+------------ | -------------
+**REGISTER** | string
+**EXTERNAL_API** | string
+**BILLING** | string
+**APPOINTMENTS** | string
+**INVOICES** | string
+**ONLINE_STORE** | string
+**PAYROLL** | string
+**OTHER** | string
+
+

data/docs/UpdateCustomerRequest.md

@@ -0,0 +1,20 @@
+# SquareConnect::UpdateCustomerRequest
+
+### Description
+
+Defines the body parameters that can be provided in a request to the [UpdateCustomer](#endpoint-updatecustomer) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**given_name** | **String** | The customer's given (i.e., first) name. | [optional] 
+**family_name** | **String** | The customer's family (i.e., last) name. | [optional] 
+**company_name** | **String** | The name of the customer's company. | [optional] 
+**nickname** | **String** | A nickname for the customer. | [optional] 
+**email_address** | **String** | The customer's email address. | [optional] 
+**address** | [**Address**](Address.md) | The customer's physical address. | [optional] 
+**phone_number** | **String** | The customer's phone number. | [optional] 
+**reference_id** | **String** | An optional second ID you can set to associate the customer with an entity in another system. | [optional] 
+**note** | **String** | An optional note to associate with the customer. | [optional] 
+
+

data/docs/UpdateCustomerResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::UpdateCustomerResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [UpdateCustomer](#endpoint-updatecustomer) 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 updated customer. | [optional] 
+
+

data/docs/VoidTransactionRequest.md

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

data/docs/VoidTransactionResponse.md

@@ -0,0 +1,12 @@
+# SquareConnect::VoidTransactionResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+
+

data/lib/square_connect.rb

@@ -1,11 +1,10 @@
 =begin
-Square Connect API
+#Square Connect API
 
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-
 =end
 
 # Common files
@@ -15,59 +14,77 @@ require 'square_connect/version'
 require 'square_connect/configuration'
 
 # Models
-require 'square_connect/models/card_brand'
-require 'square_connect/models/country'
-require 'square_connect/models/currency'
-require 'square_connect/models/error_category'
-require 'square_connect/models/error_code'
-require 'square_connect/models/location_capability'
-require 'square_connect/models/refund_status'
-require 'square_connect/models/sort_order'
-require 'square_connect/models/tender_card_details_entry_method'
-require 'square_connect/models/tender_card_details_status'
-require 'square_connect/models/tender_type'
-require 'square_connect/models/transaction_product'
 require 'square_connect/models/address'
+require 'square_connect/models/capture_transaction_request'
 require 'square_connect/models/capture_transaction_response'
 require 'square_connect/models/card'
+require 'square_connect/models/card_brand'
 require 'square_connect/models/charge_request'
 require 'square_connect/models/charge_response'
+require 'square_connect/models/checkout'
+require 'square_connect/models/country'
+require 'square_connect/models/create_checkout_request'
+require 'square_connect/models/create_checkout_response'
 require 'square_connect/models/create_customer_card_request'
 require 'square_connect/models/create_customer_card_response'
 require 'square_connect/models/create_customer_request'
 require 'square_connect/models/create_customer_response'
+require 'square_connect/models/create_order_request'
+require 'square_connect/models/create_order_request_line_item'
+require 'square_connect/models/create_order_request_order'
 require 'square_connect/models/create_refund_request'
 require 'square_connect/models/create_refund_response'
+require 'square_connect/models/currency'
 require 'square_connect/models/customer'
+require 'square_connect/models/customer_group_info'
+require 'square_connect/models/customer_preferences'
+require 'square_connect/models/delete_customer_card_request'
 require 'square_connect/models/delete_customer_card_response'
+require 'square_connect/models/delete_customer_request'
 require 'square_connect/models/delete_customer_response'
 require 'square_connect/models/error'
+require 'square_connect/models/error_category'
+require 'square_connect/models/error_code'
 require 'square_connect/models/list_customers_request'
 require 'square_connect/models/list_customers_response'
+require 'square_connect/models/list_locations_request'
 require 'square_connect/models/list_locations_response'
 require 'square_connect/models/list_refunds_request'
 require 'square_connect/models/list_refunds_response'
 require 'square_connect/models/list_transactions_request'
 require 'square_connect/models/list_transactions_response'
 require 'square_connect/models/location'
+require 'square_connect/models/location_capability'
 require 'square_connect/models/money'
+require 'square_connect/models/order'
+require 'square_connect/models/order_line_item'
 require 'square_connect/models/refund'
+require 'square_connect/models/refund_status'
+require 'square_connect/models/retrieve_customer_request'
 require 'square_connect/models/retrieve_customer_response'
+require 'square_connect/models/retrieve_transaction_request'
 require 'square_connect/models/retrieve_transaction_response'
+require 'square_connect/models/sort_order'
 require 'square_connect/models/tender'
 require 'square_connect/models/tender_card_details'
+require 'square_connect/models/tender_card_details_entry_method'
+require 'square_connect/models/tender_card_details_status'
 require 'square_connect/models/tender_cash_details'
+require 'square_connect/models/tender_type'
 require 'square_connect/models/transaction'
+require 'square_connect/models/transaction_product'
 require 'square_connect/models/update_customer_request'
 require 'square_connect/models/update_customer_response'
+require 'square_connect/models/void_transaction_request'
 require 'square_connect/models/void_transaction_response'
 
 # APIs
+require 'square_connect/api/checkout_api'
+require 'square_connect/api/customer_api'
 require 'square_connect/api/customer_card_api'
+require 'square_connect/api/location_api'
 require 'square_connect/api/refund_api'
 require 'square_connect/api/transaction_api'
-require 'square_connect/api/customer_api'
-require 'square_connect/api/location_api'
 
 module SquareConnect
   class << self