yapstone-payments 1.0.0

data/docs/AuthTokenRequest.md

@@ -0,0 +1,19 @@
+# Yapstone::AuthTokenRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | **String** |  | [optional] 
+**platform** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::AuthTokenRequest.new(authentication: null,
+                                 platform: null)
+```
+
+

data/docs/AuthTokenResponse.md

@@ -0,0 +1,17 @@
+# Yapstone::AuthTokenResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::AuthTokenResponse.new(token: null)
+```
+
+

data/docs/AuthenticationApi.md

@@ -0,0 +1,58 @@
+# Yapstone::AuthenticationApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**authenticate_partner**](AuthenticationApi.md#authenticate_partner) | **POST** /v1/oauth2/client_credential/accesstoken | Authenticate Partner
+
+
+
+## authenticate_partner
+
+> InlineResponse200 authenticate_partner(grant_type, authorization)
+
+Authenticate Partner
+
+Get an access token. It is OAuth2, and you must use the client credentials grant type. The token will allow you to authenticate with the other internal payments API endpoints. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+
+api_instance = Yapstone::AuthenticationApi.new
+grant_type = 'client_credentials' # String | To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user's resources. 
+authorization = 'Basic SGxkdU5OcU1xMzBUZ0djYUpDWVpIWVRsejJjQUJlSHo6YkdIeWNpWXVibzNVTXZLRA==' # String | Provide client_id:client_secret as base64 encoded basic auth. 
+
+begin
+  #Authenticate Partner
+  result = api_instance.authenticate_partner(grant_type, authorization)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AuthenticationApi->authenticate_partner: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **grant_type** | **String**| To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user's resources.  | 
+ **authorization** | **String**| Provide client_id:client_secret as base64 encoded basic auth.  | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BankAccount.md

@@ -0,0 +1,37 @@
+# Yapstone::BankAccount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | The full bank account number.  | 
+**routing_number** | **String** | The routing transit number for the bank account  | [optional] 
+**account_type** | **String** | The type of account being paid from - choose from checking or savings account.  | 
+**currency** | **String** | The currency of the bank account.  | 
+**bank_name** | **String** | The name of the bank.  | [optional] 
+**country** | **String** | The country the bank is located in.  | [optional] 
+**bic** | **String** | The bank identifier code (BIC) is the SWIFT address assigned to a bank in order to send automated payments quicky and accurately to the banks concerned.  | [optional] 
+**bank_code** | **String** | A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions. The name of bank codes can vary.  | [optional] 
+**branch_code** | **String** | A branch code is part of the Indian Financial System Code (IFSC), which is an 11 character alphanumeric code where the first four characters represent the bank's name, the fifth character is always 0 and the rest of the digits are the branch code.  | [optional] 
+**iban** | **String** | This is an International Bank Account Number (IBAN) which is an internationally agreed system of identifying bank accounts across national borders to facilitate the communication and processing of cross border transactions with a reduced risk of transcription errors.  | [optional] 
+**name_on_account** | **String** | The name of the person or business entity associated with the account.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BankAccount.new(account_number: null,
+                                 routing_number: null,
+                                 account_type: null,
+                                 currency: null,
+                                 bank_name: null,
+                                 country: null,
+                                 bic: null,
+                                 bank_code: null,
+                                 branch_code: null,
+                                 iban: null,
+                                 name_on_account: null)
+```
+
+

data/docs/BillingAddress.md

@@ -0,0 +1,29 @@
+# Yapstone::BillingAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**city** | **String** | City of Billing Address | [optional] 
+**country_code** | **String** | The country code represented in the ISO 3166 format.  | [optional] 
+**postal_code** | **String** | Postal code of Billing Address | [optional] 
+**state_or_province** | **String** | State or Province of Billing Address | [optional] 
+**street1** | **String** | Street1 of Billing Address | [optional] 
+**street2** | **String** | Street2 of Billing Address | [optional] 
+**street3** | **String** | Street3 of Billing Address | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BillingAddress.new(city: null,
+                                 country_code: null,
+                                 postal_code: null,
+                                 state_or_province: null,
+                                 street1: null,
+                                 street2: null,
+                                 street3: null)
+```
+
+

data/docs/BookingInfo.md

@@ -0,0 +1,31 @@
+# Yapstone::BookingInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**checkin_date** | **String** | ISO 8601 date of the guest's check in.  | [optional] 
+**checkout_date** | **String** | ISO 8601 date of the guest's check out.  | [optional] 
+**nightly_rate** | [**Amount**](Amount.md) |  | [optional] 
+**number_of_adults** | **Integer** | Number of adults who will be staying in this booking.  | [optional] 
+**number_of_children** | **Integer** | Number of children who will be staying in this booking.  | [optional] 
+**number_of_nights** | **Integer** | Number of nights that the guests will be staying.  | [optional] 
+**reservation_number** | **String** | Your system's reservation number for this booking.  | [optional] 
+**nightly_tax** | [**Amount**](Amount.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BookingInfo.new(checkin_date: 2019-05-27,
+                                 checkout_date: 2019-05-29,
+                                 nightly_rate: null,
+                                 number_of_adults: 2,
+                                 number_of_children: 3,
+                                 number_of_nights: 2,
+                                 reservation_number: FJ781AD,
+                                 nightly_tax: null)
+```
+
+

data/docs/CapturePaymentRequest.md

@@ -0,0 +1,21 @@
+# Yapstone::CapturePaymentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authorization_type** | **String** | For capturing a payment there are two steps, pre-authorization (PRIORAUTH) and capture (FINALAUTH). PRIORAUTH means that you are requesting pre-authorization. This is where you place a hold on your customer's credit card for a specified dollar amount based on a projected sale amount. Say your customer's card has $5000 on it and you want to reserve $250 for a payment so you put a $250 pre-authorization on their card. Now their credit limit is only $4750. Next, you must capture that money. The FINALAUTH enum is used to indicate that you are ready to authorize collection of the funds from the customer credit card.  | [optional] 
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**transactions** | [**Array<Transaction>**](Transaction.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CapturePaymentRequest.new(authorization_type: FINALAUTH,
+                                 amount: null,
+                                 transactions: null)
+```
+
+

data/docs/Card.md

@@ -0,0 +1,27 @@
+# Yapstone::Card
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billing_address** | [**BillingAddress**](BillingAddress.md) |  | [optional] 
+**card_number** | **String** | The full 16 digit number for the credit card.  | [optional] 
+**cvv** | **String** | Three or four digit security code for the credit card.  | [optional] 
+**expiration_month** | **String** | The month the card expires, using format MM.  | [optional] 
+**expiration_year** | **String** | The year the card expires, using the last two digits of the year.  | [optional] 
+**name_on_account** | **String** | The name of the person who owns the credit card.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Card.new(billing_address: null,
+                                 card_number: null,
+                                 cvv: null,
+                                 expiration_month: null,
+                                 expiration_year: null,
+                                 name_on_account: null)
+```
+
+

data/docs/CardResponse.md

@@ -0,0 +1,21 @@
+# Yapstone::CardResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_bin** | **String** | This is the bank identification number (BIN) for the credit card. It is the initial four to six numbers that appear on the card.  | [optional] 
+**card_country** | **String** | The country the credit card is from.  | [optional] 
+**card_issuer** | **String** | The bank that issued the card.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CardResponse.new(card_bin: null,
+                                 card_country: null,
+                                 card_issuer: null)
+```
+
+

data/docs/Consent.md

@@ -0,0 +1,21 @@
+# Yapstone::Consent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accepted** | **Boolean** |  | [optional] 
+**type** | **String** |  | [optional] 
+**version** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Consent.new(accepted: null,
+                                 type: null,
+                                 version: null)
+```
+
+

data/docs/CreditCardAuthResponse.md

@@ -0,0 +1,25 @@
+# Yapstone::CreditCardAuthResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_result** | [**Result**](Result.md) |  | [optional] 
+**cvv_result** | [**Result**](Result.md) |  | [optional] 
+**avs_result** | [**Result**](Result.md) |  | [optional] 
+**auth_verification_code** | **String** |  | [optional] 
+**processor** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CreditCardAuthResponse.new(auth_result: null,
+                                 cvv_result: null,
+                                 avs_result: null,
+                                 auth_verification_code: null,
+                                 processor: FD)
+```
+
+

data/docs/Customer.md

@@ -0,0 +1,29 @@
+# Yapstone::Customer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**Address**](Address.md) |  | [optional] 
+**email_address** | **String** | email address of the customer | [optional] 
+**name** | [**Name**](Name.md) |  | [optional] 
+**phone** | [**Phone**](Phone.md) |  | [optional] 
+**consents** | [**Array<Consent>**](Consent.md) |  | [optional] 
+**customer_id** | **String** | If you'd like to use an existing customer record instead of creating a new one, provide Yapstone's ID of that record here. In this case you can omit the other customer fields.  | [optional] 
+**external_customer_id** | **String** | Optionally provide your system's internal identifier for this entity, for use later if you need to correlate data across systems or consolidate records.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Customer.new(address: null,
+                                 email_address: null,
+                                 name: null,
+                                 phone: null,
+                                 consents: null,
+                                 customer_id: UP:PTY:_woMuYIdS7SVJaOYiD8ZRg,
+                                 external_customer_id: 0c1cbdf1-33b6-4801-9e89-acbb2d3f9085)
+```
+
+

data/docs/CustomerData.md

@@ -0,0 +1,19 @@
+# Yapstone::CustomerData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key1** | **String** | A custom field for customer information.  | [optional] 
+**key2** | **String** | An additional custom field for customer information.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CustomerData.new(key1: null,
+                                 key2: null)
+```
+
+

data/docs/CustomerDetails.md

@@ -0,0 +1,23 @@
+# Yapstone::CustomerDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_id** | **String** | The unique customer identifier generated by Yapstone.  | [optional] 
+**external_customer_id** | **String** | If you want to use your own custom identification for a customer you can do so with this field.  | [optional] 
+**name** | [**Name**](Name.md) |  | [optional] 
+**risk_status** | [**RiskStatus**](RiskStatus.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CustomerDetails.new(customer_id: null,
+                                 external_customer_id: null,
+                                 name: null,
+                                 risk_status: null)
+```
+
+

data/docs/Deposit.md

@@ -0,0 +1,23 @@
+# Yapstone::Deposit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_name** | **String** | The name on the account making a deposit.  | [optional] 
+**last4_account** | **String** | The last 4 digits of the account number.  | [optional] 
+**amount** | **String** | The dollar amount to be charged to the customer, expressed in ISO 4217 form. E.g. $10.50 USD would be expressed as 1050 with an exponent of 2.  | [optional] 
+**currency** | **String** | The currency the deposit is being made in. ISO 4217 currency code.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Deposit.new(account_name: null,
+                                 last4_account: null,
+                                 amount: null,
+                                 currency: USD)
+```
+
+

data/docs/DepositDetails.md

@@ -0,0 +1,17 @@
+# Yapstone::DepositDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deposits** | [**Array<Deposit>**](Deposit.md) | sample desc | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DepositDetails.new(deposits: null)
+```
+
+

data/docs/DisburseLineItemsReq.md

@@ -0,0 +1,19 @@
+# Yapstone::DisburseLineItemsReq
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**offering_id** | **String** | The unique identifier for the product offering.  | [optional] 
+**offering_name** | **String** | The name of the product offering.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DisburseLineItemsReq.new(offering_id: null,
+                                 offering_name: null)
+```
+
+