square_connect 2.0.0 → 2.0.2.13

data/docs/CreateCheckoutRequest.md

@@ -0,0 +1,18 @@
+# SquareConnect::CreateCheckoutRequest
+
+### Description
+
+Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idempotency_key** | **String** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID.  The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates.  We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys.  See [Idempotency keys](#idempotencykeys) for more information. | 
+**order** | [**CreateOrderRequestOrder**](CreateOrderRequestOrder.md) | The order including line items to be checked out. | 
+**ask_for_shipping_address** | **BOOLEAN** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard.  Default is `false`. | [optional] 
+**merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant.  If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account.  Default is unset. | [optional] 
+**pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field.  Default is unset. | [optional] 
+**pre_populate_shipping_address** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields.  Default is unset. | [optional] 
+**redirect_url** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to:  `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx`  If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.  Default is unset. | [optional] 
+
+

data/docs/CreateCheckoutResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::CreateCheckoutResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**checkout** | [**Checkout**](Checkout.md) | The newly created checkout. If the same request was made with the same idempotency_key, this will be the checkout created with the idempotency_key. | [optional] 
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+
+

data/docs/CreateCustomerCardRequest.md

@@ -0,0 +1,14 @@
+# SquareConnect::CreateCustomerCardRequest
+
+### Description
+
+Defines the fields that are included in the request body of a request to the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_nonce** | **String** | A card nonce representing the credit card to link to the customer.  Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](/articles/adding-payment-form/) for more information. | 
+**billing_address** | [**Address**](Address.md) | Address information for the card on file. Only the `postal_code` field is required for payments in the US and Canada. | [optional] 
+**cardholder_name** | **String** | The cardholder's name. | [optional] 
+
+

data/docs/CreateCustomerCardResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::CreateCustomerCardResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.  One of `errors` or `card` 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] 
+**card** | [**Card**](Card.md) | The created card on file. | [optional] 
+
+

data/docs/CreateCustomerRequest.md

@@ -0,0 +1,20 @@
+# SquareConnect::CreateCustomerRequest
+
+### Description
+
+Defines the body parameters that can be provided in a request to the [CreateCustomer](#endpoint-createcustomer) 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/CreateCustomerResponse.md

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

data/docs/CreateOrderRequest.md

@@ -0,0 +1,13 @@
+# SquareConnect::CreateOrderRequest
+
+### Description
+
+Defines the parameters that can be included in the body of a request to the [CreateOrder](#endpoint-createorder) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idempotency_key** | **String** | A value you specify that uniquely identifies this order among orders you've created.  If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders.  See [Idempotency keys](#idempotencykeys) for more information. | 
+**order** | [**Order**](Order.md) | The order to be created. | 
+
+

data/docs/CreateOrderRequestLineItem.md

@@ -0,0 +1,14 @@
+# SquareConnect::CreateOrderRequestLineItem
+
+### Description
+
+Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the line item. This value cannot exceed 500 characters. | 
+**quantity** | **String** | The quantity to purchase, as a string representation of a number. Currently, only integer values are supported. | 
+**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. | 
+
+

data/docs/CreateOrderRequestOrder.md

@@ -0,0 +1,13 @@
+# SquareConnect::CreateOrderRequestOrder
+
+### Description
+
+The object describes the order.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference_id** | **String** | An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
+**line_items** | [**Array<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | The line items to associate with this order.  Each line item represents a different product (or a custom monetary amount) to include in a purchase. | 
+
+

data/docs/CreateRefundRequest.md

@@ -0,0 +1,15 @@
+# SquareConnect::CreateRefundRequest
+
+### Description
+
+Defines the body parameters that can be included in a request to the [CreateRefund](#endpoint-createrefund) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idempotency_key** | **String** | A value you specify that uniquely identifies this refund among refunds you've created for the tender.  If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund.  See [Idempotency keys](#idempotencykeys) for more information. | 
+**tender_id** | **String** | The ID of the tender to refund.  A [`Transaction`](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. | 
+**reason** | **String** | A description of the reason for the refund.  Default value: `Refund via API` | [optional] 
+**amount_money** | [**Money**](Money.md) | The amount of money to refund.  Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details.  This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. | 
+
+

data/docs/CreateRefundResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::CreateRefundResponse
+
+### Description
+
+Defines the fields that are included in the response body of a request to the [CreateRefund](#endpoint-createrefund) endpoint.  One of `errors` or `refund` 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] 
+**refund** | [**Refund**](Refund.md) | The created refund. | [optional] 
+
+

data/docs/Currency.md

@@ -0,0 +1,191 @@
+# SquareConnect::Currency
+
+### Description
+
+Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
+
+## Properties
+Name | Type
+------------ | -------------
+**AED** | string
+**AFN** | string
+**ALL** | string
+**AMD** | string
+**ANG** | string
+**AOA** | string
+**ARS** | string
+**AUD** | string
+**AWG** | string
+**AZN** | string
+**BAM** | string
+**BBD** | string
+**BDT** | string
+**BGN** | string
+**BHD** | string
+**BIF** | string
+**BMD** | string
+**BND** | string
+**BOB** | string
+**BOV** | string
+**BRL** | string
+**BSD** | string
+**BTN** | string
+**BWP** | string
+**BYR** | string
+**BZD** | string
+**CAD** | string
+**CDF** | string
+**CHE** | string
+**CHF** | string
+**CHW** | string
+**CLF** | string
+**CLP** | string
+**CNY** | string
+**COP** | string
+**COU** | string
+**CRC** | string
+**CUC** | string
+**CUP** | string
+**CVE** | string
+**CZK** | string
+**DJF** | string
+**DKK** | string
+**DOP** | string
+**DZD** | string
+**EGP** | string
+**ERN** | string
+**ETB** | string
+**EUR** | string
+**FJD** | string
+**FKP** | string
+**GBP** | string
+**GEL** | string
+**GHS** | string
+**GIP** | string
+**GMD** | string
+**GNF** | string
+**GTQ** | string
+**GYD** | string
+**HKD** | string
+**HNL** | string
+**HRK** | string
+**HTG** | string
+**HUF** | string
+**IDR** | string
+**ILS** | string
+**INR** | string
+**IQD** | string
+**IRR** | string
+**ISK** | string
+**JMD** | string
+**JOD** | string
+**JPY** | string
+**KES** | string
+**KGS** | string
+**KHR** | string
+**KMF** | string
+**KPW** | string
+**KRW** | string
+**KWD** | string
+**KYD** | string
+**KZT** | string
+**LAK** | string
+**LBP** | string
+**LKR** | string
+**LRD** | string
+**LSL** | string
+**LTL** | string
+**LVL** | string
+**LYD** | string
+**MAD** | string
+**MDL** | string
+**MGA** | string
+**MKD** | string
+**MMK** | string
+**MNT** | string
+**MOP** | string
+**MRO** | string
+**MUR** | string
+**MVR** | string
+**MWK** | string
+**MXN** | string
+**MXV** | string
+**MYR** | string
+**MZN** | string
+**NAD** | string
+**NGN** | string
+**NIO** | string
+**NOK** | string
+**NPR** | string
+**NZD** | string
+**OMR** | string
+**PAB** | string
+**PEN** | string
+**PGK** | string
+**PHP** | string
+**PKR** | string
+**PLN** | string
+**PYG** | string
+**QAR** | string
+**RON** | string
+**RSD** | string
+**RUB** | string
+**RWF** | string
+**SAR** | string
+**SBD** | string
+**SCR** | string
+**SDG** | string
+**SEK** | string
+**SGD** | string
+**SHP** | string
+**SLL** | string
+**SOS** | string
+**SRD** | string
+**SSP** | string
+**STD** | string
+**SVC** | string
+**SYP** | string
+**SZL** | string
+**THB** | string
+**TJS** | string
+**TMT** | string
+**TND** | string
+**TOP** | string
+**TRY** | string
+**TTD** | string
+**TWD** | string
+**TZS** | string
+**UAH** | string
+**UGX** | string
+**USD** | string
+**USN** | string
+**USS** | string
+**UYI** | string
+**UYU** | string
+**UZS** | string
+**VEF** | string
+**VND** | string
+**VUV** | string
+**WST** | string
+**XAF** | string
+**XAG** | string
+**XAU** | string
+**XBA** | string
+**XBB** | string
+**XBC** | string
+**XBD** | string
+**XCD** | string
+**XDR** | string
+**XOF** | string
+**XPD** | string
+**XPF** | string
+**XPT** | string
+**XTS** | string
+**XXX** | string
+**YER** | string
+**ZAR** | string
+**ZMK** | string
+**ZMW** | string
+**BTC** | string
+
+

data/docs/Customer.md

@@ -0,0 +1,26 @@
+# SquareConnect::Customer
+
+### Description
+
+Represents one of a business's customers, which can have one or more cards on file associated with it.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The customer's unique ID. | 
+**created_at** | **String** | The time when the customer was created, in RFC 3339 format. | 
+**updated_at** | **String** | The time when the customer was last updated, in RFC 3339 format. | 
+**cards** | [**Array<Card>**](Card.md) | The non-confidential details of the customer's cards on file. | [optional] 
+**given_name** | **String** | The customer's given (i.e., first) name. | [optional] 
+**family_name** | **String** | The customer's family (i.e., last) name. | [optional] 
+**nickname** | **String** | The customer's nickname. | [optional] 
+**company_name** | **String** | The name of the customer's company. | [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** | A second ID you can set to associate the customer with an entity in another system. | [optional] 
+**note** | **String** | A note to associate with the customer. | [optional] 
+**preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional] 
+**groups** | [**Array<CustomerGroupInfo>**](CustomerGroupInfo.md) | The groups the customer belongs to. | [optional] 
+
+

data/docs/CustomerApi.md

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