square_connect 2.0.0 → 2.0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2450e79746e4ced5399510f8792b30f0ecf3d7b7
-  data.tar.gz: e8b039a0ac5e579c7d80d64b4c75bf6561104087
+  metadata.gz: 2079515ea891e08b25df4d246d5720ff331fb60a
+  data.tar.gz: 7f9aa2305578144d592c9e0be8e760ba94d47574
 SHA512:
-  metadata.gz: dfeac07d26ac053117336bde427b97eb606314b38234765b6fb63bfd4b0782c751bbeee71777cb04d1223b365543984e44f087d1511ac1ec7ee936cc939e3fff
-  data.tar.gz: 34264b57627602750d85d1b3d278ba9741dbf7317792e910c6807a1dee9112b777367e965059e4d6c3da043881aabf11deb4236b307a50a0cf348d0896c0afc0
+  metadata.gz: 8b40ee2dc79d631f99664550b92e0402d86d8e7efe5403aee1e8014277c921c7d177dd0f5f94b0bff3cbed33cfbe3e3c5623ecedf40c583347b90cd12f8fe5b2
+  data.tar.gz: df4315592045d57ac6e80a728a2aff7c9207b35acd72c497d43ccc920299b34570087a624fbe95d25ffa81c751e1249a79a00d2edfa674231994d391d8fc5196

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -1,14 +1,19 @@
-Connect v2 SDKs
+Connect v2 Ruby SDKs [![Build Status](https://travis-ci.org/square/connect-ruby-sdk.svg?branch=master)](https://travis-ci.org/square/connect-ruby-sdk)[![Gem Version](https://badge.fury.io/rb/square_connect.svg)](https://badge.fury.io/rb/square_connect)
 ===============
 
-This repository contains the released Ruby client SDK. Check out our other
-repository for the specification and template files we used to generate this.
+This repository contains the released Ruby client SDK. Check out our [API
+specification repository](https://github.com/square/connect-api-specification)
+for the specification and template files we used to generate this.
 
-Usage
------
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-### Ruby
+- API version: 2.0
+- Package version: 2.0.2
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
 
+## Installation
+
+### RubyGems
 The Ruby SDK is published as a gem. Simply run:
 
 ```
@@ -21,17 +26,154 @@ Or add this line to your Gemfile:
 gem 'square_connect'
 ```
 
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/square/connect-ruby-sdk, then add the following in the Gemfile:
+
+    gem 'square_connect', :git => 'https://github.com/square/connect-ruby-sdk.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::CheckoutApi.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 business location to associate the checkout with.
+
+body = SquareConnect::CreateCheckoutRequest.new # CreateCheckoutRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #CreateCheckout
+  result = api_instance.create_checkout(authorization, location_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CheckoutApi->create_checkout: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://connect.squareup.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SquareConnect::CheckoutApi* | [**create_checkout**](docs/CheckoutApi.md#create_checkout) | **POST** /v2/locations/{location_id}/checkouts | CreateCheckout
+*SquareConnect::CustomerApi* | [**create_customer**](docs/CustomerApi.md#create_customer) | **POST** /v2/customers | CreateCustomer
+*SquareConnect::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /v2/customers/{customer_id} | DeleteCustomer
+*SquareConnect::CustomerApi* | [**list_customers**](docs/CustomerApi.md#list_customers) | **GET** /v2/customers | ListCustomers
+*SquareConnect::CustomerApi* | [**retrieve_customer**](docs/CustomerApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
+*SquareConnect::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
+*SquareConnect::CustomerCardApi* | [**create_customer_card**](docs/CustomerCardApi.md#create_customer_card) | **POST** /v2/customers/{customer_id}/cards | CreateCustomerCard
+*SquareConnect::CustomerCardApi* | [**delete_customer_card**](docs/CustomerCardApi.md#delete_customer_card) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard
+*SquareConnect::LocationApi* | [**list_locations**](docs/LocationApi.md#list_locations) | **GET** /v2/locations | ListLocations
+*SquareConnect::RefundApi* | [**create_refund**](docs/RefundApi.md#create_refund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund
+*SquareConnect::RefundApi* | [**list_refunds**](docs/RefundApi.md#list_refunds) | **GET** /v2/locations/{location_id}/refunds | ListRefunds
+*SquareConnect::TransactionApi* | [**capture_transaction**](docs/TransactionApi.md#capture_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction
+*SquareConnect::TransactionApi* | [**charge**](docs/TransactionApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge
+*SquareConnect::TransactionApi* | [**list_transactions**](docs/TransactionApi.md#list_transactions) | **GET** /v2/locations/{location_id}/transactions | ListTransactions
+*SquareConnect::TransactionApi* | [**retrieve_transaction**](docs/TransactionApi.md#retrieve_transaction) | **GET** /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction
+*SquareConnect::TransactionApi* | [**void_transaction**](docs/TransactionApi.md#void_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction
+
+
+## Documentation for Models
+
+ - [SquareConnect::Address](docs/Address.md)
+ - [SquareConnect::CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
+ - [SquareConnect::CaptureTransactionResponse](docs/CaptureTransactionResponse.md)
+ - [SquareConnect::Card](docs/Card.md)
+ - [SquareConnect::CardBrand](docs/CardBrand.md)
+ - [SquareConnect::ChargeRequest](docs/ChargeRequest.md)
+ - [SquareConnect::ChargeResponse](docs/ChargeResponse.md)
+ - [SquareConnect::Checkout](docs/Checkout.md)
+ - [SquareConnect::Country](docs/Country.md)
+ - [SquareConnect::CreateCheckoutRequest](docs/CreateCheckoutRequest.md)
+ - [SquareConnect::CreateCheckoutResponse](docs/CreateCheckoutResponse.md)
+ - [SquareConnect::CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md)
+ - [SquareConnect::CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md)
+ - [SquareConnect::CreateCustomerRequest](docs/CreateCustomerRequest.md)
+ - [SquareConnect::CreateCustomerResponse](docs/CreateCustomerResponse.md)
+ - [SquareConnect::CreateOrderRequest](docs/CreateOrderRequest.md)
+ - [SquareConnect::CreateOrderRequestLineItem](docs/CreateOrderRequestLineItem.md)
+ - [SquareConnect::CreateOrderRequestOrder](docs/CreateOrderRequestOrder.md)
+ - [SquareConnect::CreateRefundRequest](docs/CreateRefundRequest.md)
+ - [SquareConnect::CreateRefundResponse](docs/CreateRefundResponse.md)
+ - [SquareConnect::Currency](docs/Currency.md)
+ - [SquareConnect::Customer](docs/Customer.md)
+ - [SquareConnect::CustomerGroupInfo](docs/CustomerGroupInfo.md)
+ - [SquareConnect::CustomerPreferences](docs/CustomerPreferences.md)
+ - [SquareConnect::DeleteCustomerCardRequest](docs/DeleteCustomerCardRequest.md)
+ - [SquareConnect::DeleteCustomerCardResponse](docs/DeleteCustomerCardResponse.md)
+ - [SquareConnect::DeleteCustomerRequest](docs/DeleteCustomerRequest.md)
+ - [SquareConnect::DeleteCustomerResponse](docs/DeleteCustomerResponse.md)
+ - [SquareConnect::Error](docs/Error.md)
+ - [SquareConnect::ErrorCategory](docs/ErrorCategory.md)
+ - [SquareConnect::ErrorCode](docs/ErrorCode.md)
+ - [SquareConnect::ListCustomersRequest](docs/ListCustomersRequest.md)
+ - [SquareConnect::ListCustomersResponse](docs/ListCustomersResponse.md)
+ - [SquareConnect::ListLocationsRequest](docs/ListLocationsRequest.md)
+ - [SquareConnect::ListLocationsResponse](docs/ListLocationsResponse.md)
+ - [SquareConnect::ListRefundsRequest](docs/ListRefundsRequest.md)
+ - [SquareConnect::ListRefundsResponse](docs/ListRefundsResponse.md)
+ - [SquareConnect::ListTransactionsRequest](docs/ListTransactionsRequest.md)
+ - [SquareConnect::ListTransactionsResponse](docs/ListTransactionsResponse.md)
+ - [SquareConnect::Location](docs/Location.md)
+ - [SquareConnect::LocationCapability](docs/LocationCapability.md)
+ - [SquareConnect::Money](docs/Money.md)
+ - [SquareConnect::Order](docs/Order.md)
+ - [SquareConnect::OrderLineItem](docs/OrderLineItem.md)
+ - [SquareConnect::Refund](docs/Refund.md)
+ - [SquareConnect::RefundStatus](docs/RefundStatus.md)
+ - [SquareConnect::RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md)
+ - [SquareConnect::RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md)
+ - [SquareConnect::RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
+ - [SquareConnect::RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
+ - [SquareConnect::SortOrder](docs/SortOrder.md)
+ - [SquareConnect::Tender](docs/Tender.md)
+ - [SquareConnect::TenderCardDetails](docs/TenderCardDetails.md)
+ - [SquareConnect::TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md)
+ - [SquareConnect::TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md)
+ - [SquareConnect::TenderCashDetails](docs/TenderCashDetails.md)
+ - [SquareConnect::TenderType](docs/TenderType.md)
+ - [SquareConnect::Transaction](docs/Transaction.md)
+ - [SquareConnect::TransactionProduct](docs/TransactionProduct.md)
+ - [SquareConnect::UpdateCustomerRequest](docs/UpdateCustomerRequest.md)
+ - [SquareConnect::UpdateCustomerResponse](docs/UpdateCustomerResponse.md)
+ - [SquareConnect::VoidTransactionRequest](docs/VoidTransactionRequest.md)
+ - [SquareConnect::VoidTransactionResponse](docs/VoidTransactionResponse.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+
+
 Contributing
 ------------
 
-Send bug reports, feature requests, and code contributions to API specifications
-repository, as this repository contains only the generated SDK code.
+Send bug reports, feature requests, and code contributions to the [API
+specifications repository](https://github.com/square/connect-api-specification),
+as this repository contains only the generated SDK code.
 
 License
 -------
 
 ```
-Copyright 2016 Square, Inc.
+Copyright 2017 Square, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Address.md

@@ -0,0 +1,26 @@
+# SquareConnect::Address
+
+### Description
+
+Represents a physical address.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_line_1** | **String** | The first line of the address.  Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields). | [optional] 
+**address_line_2** | **String** | The second line of the address, if any. | [optional] 
+**address_line_3** | **String** | The third line of the address, if any. | [optional] 
+**locality** | **String** | The city or town of the address. | [optional] 
+**sublocality** | **String** | A civil region within the address's `locality`, if any. | [optional] 
+**sublocality_2** | **String** | A civil region within the address's `sublocality`, if any. | [optional] 
+**sublocality_3** | **String** | A civil region within the address's `sublocality_2`, if any. | [optional] 
+**administrative_district_level_1** | **String** | A civil entity within the address's country. In the US, this is the state. | [optional] 
+**administrative_district_level_2** | **String** | A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. | [optional] 
+**administrative_district_level_3** | **String** | A civil entity within the address's `administrative_district_level_2`, if any. | [optional] 
+**postal_code** | **String** | The address's postal code. | [optional] 
+**country** | **String** | The address's country, in ISO 3166-1-alpha-2 format. | [optional] 
+**first_name** | **String** | Optional first name when it's representing recipient. | [optional] 
+**last_name** | **String** | Optional last name when it's representing recipient. | [optional] 
+**organization** | **String** | Optional organization name when it's representing recipient. | [optional] 
+
+

data/docs/CaptureTransactionRequest.md

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

data/docs/CaptureTransactionResponse.md

@@ -0,0 +1,12 @@
+# SquareConnect::CaptureTransactionResponse
+
+### 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/docs/Card.md

@@ -0,0 +1,18 @@
+# SquareConnect::Card
+
+### Description
+
+Represents the non-confidential details of a credit card.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The card's unique ID, if any. | [optional] 
+**card_brand** | **String** | The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for all possible values. | [optional] 
+**last_4** | **String** | The last 4 digits of the card's number. | [optional] 
+**exp_month** | **Integer** | The month of the card's expiration date. This value is always between `1` and `12`, inclusive. | [optional] 
+**exp_year** | **Integer** | The four-digit year of the card's expiration date. | [optional] 
+**cardholder_name** | **String** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional] 
+**billing_address** | [**Address**](Address.md) | The card's billing address. This value is present only if this object represents a customer's card on file. | [optional] 
+
+

data/docs/CardBrand.md

@@ -0,0 +1,20 @@
+# SquareConnect::CardBrand
+
+### Description
+
+Indicates a credit card's brand, such as `VISA`.
+
+## Properties
+Name | Type
+------------ | -------------
+**OTHER_BRAND** | string
+**VISA** | string
+**MASTERCARD** | string
+**AMERICAN_EXPRESS** | string
+**DISCOVER** | string
+**DISCOVER_DINERS** | string
+**JCB** | string
+**CHINA_UNIONPAY** | string
+**SQUARE_GIFT_CARD** | string
+
+

data/docs/ChargeRequest.md

@@ -0,0 +1,22 @@
+# SquareConnect::ChargeRequest
+
+### Description
+
+Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idempotency_key** | **String** | A value you specify that uniquely identifies this transaction among transactions you've created.  If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer.  See [Idempotency keys](#idempotencykeys) for more information. | 
+**amount_money** | [**Money**](Money.md) | The amount of money to charge.  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.  The value of `currency` must match the currency associated with the business that is charging the card. | 
+**card_nonce** | **String** | A nonce generated from the `SqPaymentForm` that represents the card to charge.  The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid.  Do not provide a value for this field if you provide a value for `customer_card_id`. | [optional] 
+**customer_card_id** | **String** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`.  If you provide this value, you _must_ also provide a value for `customer_id`. | [optional] 
+**delay_capture** | **BOOLEAN** | If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransation](#endpoint-voidtransaction) endpoint).  Default value: `false` | [optional] 
+**reference_id** | **String** | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
+**note** | **String** | An optional note to associate with the transaction.  This value cannot exceed 60 characters. | [optional] 
+**customer_id** | **String** | The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise. | [optional] 
+**billing_address** | [**Address**](Address.md) | The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. | [optional] 
+**shipping_address** | [**Address**](Address.md) | The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. | [optional] 
+**buyer_email_address** | **String** | The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. | [optional] 
+
+

data/docs/ChargeResponse.md

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

data/docs/Checkout.md

@@ -0,0 +1,20 @@
+# SquareConnect::Checkout
+
+### Description
+
+Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID generated by Square Checkout when a new checkout is requested. | [optional] 
+**checkout_page_url** | **String** | The URL that the buyer's browser should be redirected to after the checkout is completed. | [optional] 
+**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. | [optional] 
+**order** | [**Order**](Order.md) | Order to be checked out. | [optional] 
+**created_at** | **String** | The time when the checkout was created, in RFC 3339 format. | [optional] 
+
+

data/docs/CheckoutApi.md

@@ -0,0 +1,62 @@
+# SquareConnect::CheckoutApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_checkout**](CheckoutApi.md#create_checkout) | **POST** /v2/locations/{location_id}/checkouts | CreateCheckout
+
+
+# **create_checkout**
+> CreateCheckoutResponse create_checkout(authorization, location_id, body)
+
+CreateCheckout
+
+Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+
+api_instance = SquareConnect::CheckoutApi.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 business location to associate the checkout with.
+
+body = SquareConnect::CreateCheckoutRequest.new # CreateCheckoutRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #CreateCheckout
+  result = api_instance.create_checkout(authorization, location_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CheckoutApi->create_checkout: #{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 business location to associate the checkout with. | 
+ **body** | [**CreateCheckoutRequest**](CreateCheckoutRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**CreateCheckoutResponse**](CreateCheckoutResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Country.md

@@ -0,0 +1,261 @@
+# SquareConnect::Country
+
+### Description
+
+Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
+
+## Properties
+Name | Type
+------------ | -------------
+**ZZ** | string
+**AD** | string
+**AE** | string
+**AF** | string
+**AG** | string
+**AI** | string
+**AL** | string
+**AM** | string
+**AO** | string
+**AQ** | string
+**AR** | string
+**AS** | string
+**AT** | string
+**AU** | string
+**AW** | string
+**AX** | string
+**AZ** | string
+**BA** | string
+**BB** | string
+**BD** | string
+**BE** | string
+**BF** | string
+**BG** | string
+**BH** | string
+**BI** | string
+**BJ** | string
+**BL** | string
+**BM** | string
+**BN** | string
+**BO** | string
+**BQ** | string
+**BR** | string
+**BS** | string
+**BT** | string
+**BV** | string
+**BW** | string
+**BY** | string
+**BZ** | string
+**CA** | string
+**CC** | string
+**CD** | string
+**CF** | string
+**CG** | string
+**CH** | string
+**CI** | string
+**CK** | string
+**CL** | string
+**CM** | string
+**CN** | string
+**CO** | string
+**CR** | string
+**CU** | string
+**CV** | string
+**CW** | string
+**CX** | string
+**CY** | string
+**CZ** | string
+**DE** | string
+**DJ** | string
+**DK** | string
+**DM** | string
+**DO** | string
+**DZ** | string
+**EC** | string
+**EE** | string
+**EG** | string
+**EH** | string
+**ER** | string
+**ES** | string
+**ET** | string
+**FI** | string
+**FJ** | string
+**FK** | string
+**FM** | string
+**FO** | string
+**FR** | string
+**GA** | string
+**GB** | string
+**GD** | string
+**GE** | string
+**GF** | string
+**GG** | string
+**GH** | string
+**GI** | string
+**GL** | string
+**GM** | string
+**GN** | string
+**GP** | string
+**GQ** | string
+**GR** | string
+**GS** | string
+**GT** | string
+**GU** | string
+**GW** | string
+**GY** | string
+**HK** | string
+**HM** | string
+**HN** | string
+**HR** | string
+**HT** | string
+**HU** | string
+**ID** | string
+**IE** | string
+**IL** | string
+**IM** | string
+**IN** | string
+**IO** | string
+**IQ** | string
+**IR** | string
+**IS** | string
+**IT** | string
+**JE** | string
+**JM** | string
+**JO** | string
+**JP** | string
+**KE** | string
+**KG** | string
+**KH** | string
+**KI** | string
+**KM** | string
+**KN** | string
+**KP** | string
+**KR** | string
+**KW** | string
+**KY** | string
+**KZ** | string
+**LA** | string
+**LB** | string
+**LC** | string
+**LI** | string
+**LK** | string
+**LR** | string
+**LS** | string
+**LT** | string
+**LU** | string
+**LV** | string
+**LY** | string
+**MA** | string
+**MC** | string
+**MD** | string
+**ME** | string
+**MF** | string
+**MG** | string
+**MH** | string
+**MK** | string
+**ML** | string
+**MM** | string
+**MN** | string
+**MO** | string
+**MP** | string
+**MQ** | string
+**MR** | string
+**MS** | string
+**MT** | string
+**MU** | string
+**MV** | string
+**MW** | string
+**MX** | string
+**MY** | string
+**MZ** | string
+**NA** | string
+**NC** | string
+**NE** | string
+**NF** | string
+**NG** | string
+**NI** | string
+**NL** | string
+**NO** | string
+**NP** | string
+**NR** | string
+**NU** | string
+**NZ** | string
+**OM** | string
+**PA** | string
+**PE** | string
+**PF** | string
+**PG** | string
+**PH** | string
+**PK** | string
+**PL** | string
+**PM** | string
+**PN** | string
+**PR** | string
+**PS** | string
+**PT** | string
+**PW** | string
+**PY** | string
+**QA** | string
+**RE** | string
+**RO** | string
+**RS** | string
+**RU** | string
+**RW** | string
+**SA** | string
+**SB** | string
+**SC** | string
+**SD** | string
+**SE** | string
+**SG** | string
+**SH** | string
+**SI** | string
+**SJ** | string
+**SK** | string
+**SL** | string
+**SM** | string
+**SN** | string
+**SO** | string
+**SR** | string
+**SS** | string
+**ST** | string
+**SV** | string
+**SX** | string
+**SY** | string
+**SZ** | string
+**TC** | string
+**TD** | string
+**TF** | string
+**TG** | string
+**TH** | string
+**TJ** | string
+**TK** | string
+**TL** | string
+**TM** | string
+**TN** | string
+**TO** | string
+**TR** | string
+**TT** | string
+**TV** | string
+**TW** | string
+**TZ** | string
+**UA** | string
+**UG** | string
+**UM** | string
+**US** | string
+**UY** | string
+**UZ** | string
+**VA** | string
+**VC** | string
+**VE** | string
+**VG** | string
+**VI** | string
+**VN** | string
+**VU** | string
+**WF** | string
+**WS** | string
+**YE** | string
+**YT** | string
+**ZA** | string
+**ZM** | string
+**ZW** | string
+
+