square_connect 2.0.2.69 → 2.1.0.beta

data/docs/CustomerApi.md

@@ -1,267 +0,0 @@
-# SquareConnect::CustomerApi
-
-All URIs are relative to *https://connect.squareup.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_customer**](CustomerApi.md#create_customer) | **POST** /v2/customers | CreateCustomer
-[**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /v2/customers/{customer_id} | DeleteCustomer
-[**list_customers**](CustomerApi.md#list_customers) | **GET** /v2/customers | ListCustomers
-[**retrieve_customer**](CustomerApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
-[**update_customer**](CustomerApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
-
-
-# **create_customer**
-> CreateCustomerResponse create_customer(authorization, body)
-
-CreateCustomer
-
-Creates a new customer for a business, which can have associated cards on file.  You must provide __at least one__ of the following values in your request to this endpoint:  - `given_name` - `family_name` - `company_name` - `email_address` - `phone_number`  This endpoint does not accept an idempotency key. If you accidentally create a duplicate customer, you can delete it with the [DeleteCustomer](#endpoint-deletecustomer) endpoint.
-
-### Example
-```ruby
-# load the gem
-require 'square_connect'
-
-api_instance = SquareConnect::CustomerApi.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`.
-
-body = SquareConnect::CreateCustomerRequest.new # CreateCustomerRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
-
-
-begin
-  #CreateCustomer
-  result = api_instance.create_customer(authorization, body)
-  p result
-rescue SquareConnect::ApiError => e
-  puts "Exception when calling CustomerApi->create_customer: #{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`. | 
- **body** | [**CreateCustomerRequest**](CreateCustomerRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
-
-### Return type
-
-[**CreateCustomerResponse**](CreateCustomerResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **delete_customer**
-> DeleteCustomerResponse delete_customer(authorization, customer_id)
-
-DeleteCustomer
-
-Deletes a customer from a business, along with any linked cards on file.
-
-### Example
-```ruby
-# load the gem
-require 'square_connect'
-
-api_instance = SquareConnect::CustomerApi.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 delete.
-
-
-begin
-  #DeleteCustomer
-  result = api_instance.delete_customer(authorization, customer_id)
-  p result
-rescue SquareConnect::ApiError => e
-  puts "Exception when calling CustomerApi->delete_customer: #{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 delete. | 
-
-### Return type
-
-[**DeleteCustomerResponse**](DeleteCustomerResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **list_customers**
-> ListCustomersResponse list_customers(authorization, opts)
-
-ListCustomers
-
-Lists a business's customers.
-
-### Example
-```ruby
-# load the gem
-require 'square_connect'
-
-api_instance = SquareConnect::CustomerApi.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`.
-
-opts = { 
-  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
-  #ListCustomers
-  result = api_instance.list_customers(authorization, opts)
-  p result
-rescue SquareConnect::ApiError => e
-  puts "Exception when calling CustomerApi->list_customers: #{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`. | 
- **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
-
-[**ListCustomersResponse**](ListCustomersResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **retrieve_customer**
-> RetrieveCustomerResponse retrieve_customer(authorization, customer_id)
-
-RetrieveCustomer
-
-Returns details for a single customer.
-
-### Example
-```ruby
-# load the gem
-require 'square_connect'
-
-api_instance = SquareConnect::CustomerApi.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 retrieve.
-
-
-begin
-  #RetrieveCustomer
-  result = api_instance.retrieve_customer(authorization, customer_id)
-  p result
-rescue SquareConnect::ApiError => e
-  puts "Exception when calling CustomerApi->retrieve_customer: #{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 retrieve. | 
-
-### Return type
-
-[**RetrieveCustomerResponse**](RetrieveCustomerResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **update_customer**
-> UpdateCustomerResponse update_customer(authorization, customer_id, body)
-
-UpdateCustomer
-
-Updates the details of an existing customer.  You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
-
-### Example
-```ruby
-# load the gem
-require 'square_connect'
-
-api_instance = SquareConnect::CustomerApi.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 update.
-
-body = SquareConnect::UpdateCustomerRequest.new # UpdateCustomerRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
-
-
-begin
-  #UpdateCustomer
-  result = api_instance.update_customer(authorization, customer_id, body)
-  p result
-rescue SquareConnect::ApiError => e
-  puts "Exception when calling CustomerApi->update_customer: #{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 update. | 
- **body** | [**UpdateCustomerRequest**](UpdateCustomerRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
-
-### Return type
-
-[**UpdateCustomerResponse**](UpdateCustomerResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/docs/CustomerCardApi.md

@@ -1,116 +0,0 @@
-# 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/LocationApi.md

@@ -1,56 +0,0 @@
-# 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/RefundApi.md

@@ -1,126 +0,0 @@
-# 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
-
-
-