square_connect 2.0.0 → 2.0.2.13

data/docs/CustomerCardApi.md

@@ -0,0 +1,116 @@
+# SquareConnect::CustomerCardApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_customer_card**](CustomerCardApi.md#create_customer_card) | **POST** /v2/customers/{customer_id}/cards | CreateCustomerCard
+[**delete_customer_card**](CustomerCardApi.md#delete_customer_card) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard
+
+
+# **create_customer_card**
+> CreateCustomerCardResponse create_customer_card(authorization, customer_id, body)
+
+CreateCustomerCard
+
+Adds a card on file to an existing customer.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::CustomerCardApi.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`.
+
+customer_id = "customer_id_example" # String | The ID of the customer to link the card on file to.
+
+body = SquareConnect::CreateCustomerCardRequest.new # CreateCustomerCardRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #CreateCustomerCard
+  result = api_instance.create_customer_card(authorization, customer_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CustomerCardApi->create_customer_card: #{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`. | 
+ **customer_id** | **String**| The ID of the customer to link the card on file to. | 
+ **body** | [**CreateCustomerCardRequest**](CreateCustomerCardRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**CreateCustomerCardResponse**](CreateCustomerCardResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_customer_card**
+> DeleteCustomerCardResponse delete_customer_card(authorization, customer_id, card_id)
+
+DeleteCustomerCard
+
+Removes a card on file from a customer.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::CustomerCardApi.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`.
+
+customer_id = "customer_id_example" # String | The ID of the customer that the card on file belongs to.
+
+card_id = "card_id_example" # String | The ID of the card on file to delete.
+
+
+begin
+  #DeleteCustomerCard
+  result = api_instance.delete_customer_card(authorization, customer_id, card_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CustomerCardApi->delete_customer_card: #{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`. | 
+ **customer_id** | **String**| The ID of the customer that the card on file belongs to. | 
+ **card_id** | **String**| The ID of the card on file to delete. | 
+
+### Return type
+
+[**DeleteCustomerCardResponse**](DeleteCustomerCardResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CustomerGroupInfo.md

@@ -0,0 +1,13 @@
+# SquareConnect::CustomerGroupInfo
+
+### Description
+
+Contains some brief information about a customer group with its identifier included.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the customer group. | 
+**name** | **String** | The name of the customer group. | 
+
+

data/docs/CustomerPreferences.md

@@ -0,0 +1,12 @@
+# SquareConnect::CustomerPreferences
+
+### Description
+
+Represents a particular customer's preferences.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_unsubscribed** | **BOOLEAN** | The customer has unsubscribed from receiving marketing campaign emails. | [optional] 
+
+

data/docs/DeleteCustomerCardRequest.md

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

data/docs/DeleteCustomerCardResponse.md

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

data/docs/DeleteCustomerRequest.md

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

data/docs/DeleteCustomerResponse.md

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

data/docs/Error.md

@@ -0,0 +1,15 @@
+# SquareConnect::Error
+
+### Description
+
+Represents an error encountered during a request to the Connect API.  See [Handling errors](#handlingerrors) for more information.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **String** | The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values. | 
+**code** | **String** | The error's specific code. See [ErrorCode](#type-errorcode) for possible values | 
+**detail** | **String** | A human-readable description of the error for debugging purposes. | [optional] 
+**field** | **String** | The name of the field provided in the original request that the error pertains to, if any. | [optional] 
+
+

data/docs/ErrorCategory.md

@@ -0,0 +1,17 @@
+# SquareConnect::ErrorCategory
+
+### Description
+
+Indicates which high-level category of error has occurred during a request to the Connect API.
+
+## Properties
+Name | Type
+------------ | -------------
+**API_ERROR** | string
+**AUTHENTICATION_ERROR** | string
+**INVALID_REQUEST_ERROR** | string
+**RATE_LIMIT_ERROR** | string
+**PAYMENT_METHOD_ERROR** | string
+**REFUND_ERROR** | string
+
+

data/docs/ErrorCode.md

@@ -0,0 +1,83 @@
+# SquareConnect::ErrorCode
+
+### Description
+
+Indicates specific errors that can occur during a request to the Connect API.
+
+## Properties
+Name | Type
+------------ | -------------
+**INTERNAL_SERVER_ERROR** | string
+**UNAUTHORIZED** | string
+**ACCESS_TOKEN_EXPIRED** | string
+**ACCESS_TOKEN_REVOKED** | string
+**FORBIDDEN** | string
+**INSUFFICIENT_SCOPES** | string
+**APPLICATION_DISABLED** | string
+**V1_APPLICATION** | string
+**V1_ACCESS_TOKEN** | string
+**CARD_PROCESSING_NOT_ENABLED** | string
+**BAD_REQUEST** | string
+**MISSING_REQUIRED_PARAMETER** | string
+**INCORRECT_TYPE** | string
+**INVALID_TIME** | string
+**INVALID_TIME_RANGE** | string
+**INVALID_VALUE** | string
+**INVALID_CURSOR** | string
+**UNKNOWN_QUERY_PARAMETER** | string
+**CONFLICTING_PARAMETERS** | string
+**EXPECTED_JSON_BODY** | string
+**INVALID_SORT_ORDER** | string
+**VALUE_REGEX_MISMATCH** | string
+**VALUE_TOO_SHORT** | string
+**VALUE_TOO_LONG** | string
+**VALUE_TOO_LOW** | string
+**VALUE_TOO_HIGH** | string
+**VALUE_EMPTY** | string
+**ARRAY_EMPTY** | string
+**EXPECTED_BOOLEAN** | string
+**EXPECTED_INTEGER** | string
+**EXPECTED_FLOAT** | string
+**EXPECTED_STRING** | string
+**EXPECTED_OBJECT** | string
+**EXPECTED_ARRAY** | string
+**EXPECTED_BASE64_ENCODED_BYTE_ARRAY** | string
+**INVALID_ARRAY_VALUE** | string
+**INVALID_ENUM_VALUE** | string
+**INVALID_CONTENT_TYPE** | string
+**INVALID_FORM_VALUE** | string
+**ONE_INSTRUMENT_EXPECTED** | string
+**NO_FIELDS_SET** | string
+**CARD_EXPIRED** | string
+**INVALID_EXPIRATION** | string
+**INVALID_EXPIRATION_YEAR** | string
+**INVALID_EXPIRATION_DATE** | string
+**UNSUPPORTED_CARD_BRAND** | string
+**INVALID_CARD** | string
+**DELAYED_TRANSACTION_EXPIRED** | string
+**DELAYED_TRANSACTION_CANCELED** | string
+**DELAYED_TRANSACTION_CAPTURED** | string
+**DELAYED_TRANSACTION_FAILED** | string
+**CARD_TOKEN_EXPIRED** | string
+**CARD_TOKEN_USED** | string
+**AMOUNT_TOO_HIGH** | string
+**UNSUPPORTED_INSTRUMENT_TYPE** | string
+**REFUND_AMOUNT_INVALID** | string
+**REFUND_ALREADY_PENDING** | string
+**PAYMENT_NOT_REFUNDABLE** | string
+**INVALID_CARD_DATA** | string
+**IDEMPOTENCY_KEY_REUSED** | string
+**CARD_DECLINED** | string
+**VERIFY_CVV_FAILURE** | string
+**VERIFY_AVS_FAILURE** | string
+**CARD_DECLINED_CALL_ISSUER** | string
+**NOT_FOUND** | string
+**REQUEST_TIMEOUT** | string
+**CONFLICT** | string
+**REQUEST_ENTITY_TOO_LARGE** | string
+**UNSUPPORTED_MEDIA_TYPE** | string
+**RATE_LIMITED** | string
+**NOT_IMPLEMENTED** | string
+**SERVICE_UNAVAILABLE** | string
+
+

data/docs/ListCustomersRequest.md

@@ -0,0 +1,12 @@
+# SquareConnect::ListCustomersRequest
+
+### Description
+
+Defines the query parameters that can be provided in a request to the [ListCustomers](#endpoint-listcustomers) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/ListCustomersResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::ListCustomersResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [ListCustomers](#endpoint-listcustomers) endpoint.  One of `errors` or `customers` 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] 
+**customers** | [**Array<Customer>**](Customer.md) | An array of `Customer` objects that match your query. | [optional] 
+**cursor** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/ListLocationsRequest.md

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

data/docs/ListLocationsResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::ListLocationsResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [ListLocations](#endpoint-listlocations) endpoint.  One of `errors` or `locations` 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] 
+**locations** | [**Array<Location>**](Location.md) | The business's locations. | [optional] 
+
+

data/docs/ListRefundsRequest.md

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

data/docs/ListRefundsResponse.md

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

data/docs/ListTransactionsRequest.md

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

data/docs/ListTransactionsResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::ListTransactionsResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [ListTransactions](#endpoint-listtransactions) endpoint.  One of `errors` or `transactions` 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] 
+**transactions** | [**Array<Transaction>**](Transaction.md) | An array of transactions that match your query. | [optional] 
+**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

data/docs/Location.md

@@ -0,0 +1,16 @@
+# SquareConnect::Location
+
+### Description
+
+Represents one of a business's locations.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The location's unique ID. | [optional] 
+**name** | **String** | The location's name. | [optional] 
+**address** | [**Address**](Address.md) | The location's physical address. | [optional] 
+**timezone** | **String** | The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone. | [optional] 
+**capabilities** | **Array<String>** | Indicates which Square features are enabled for the location.  See [LocationCapability](#type-locationcapability) for possible values. | [optional] 
+
+