yapstone-payments 1.0.0

data/docs/InlineResponse200.md

@@ -0,0 +1,25 @@
+# Yapstone::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**issued_at** | **String** |  | [optional] 
+**access_token** | **String** |  | [optional] 
+**scope** | **String** |  | [optional] 
+**expires_in** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::InlineResponse200.new(issued_at: 1552575073094,
+                                 access_token: null,
+                                 scope: marketplace,
+                                 expires_in: 3599,
+                                 status: approved)
+```
+
+

data/docs/InstallmentPlan.md

@@ -0,0 +1,19 @@
+# Yapstone::InstallmentPlan
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**installment_number** | **Integer** | The payment installment number represents the installment the customer is on. For example if you had a total of four payments, and the customer was on their third payment, the installmentNumber would be 3.  | [optional] 
+**total_installments** | **Integer** | This is the overall number of installments a customer will be paying. For example, if the customer was paying four installments total, this number would be 4.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::InstallmentPlan.new(installment_number: 3,
+                                 total_installments: 4)
+```
+
+

data/docs/Instrument.md

@@ -0,0 +1,21 @@
+# Yapstone::Instrument
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of payment instrument being used for the payment.  | [optional] 
+**bank** | [**BankAccount**](BankAccount.md) |  | [optional] 
+**card** | [**Card**](Card.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Instrument.new(type: null,
+                                 bank: null,
+                                 card: null)
+```
+
+

data/docs/InstrumentVerificationResponse.md

@@ -0,0 +1,31 @@
+# Yapstone::InstrumentVerificationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_correlation_id** | **String** |  | [optional] 
+**client_unique_transaction_id** | **String** |  | [optional] 
+**verification_id** | **String** |  | [optional] 
+**instrument_id** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**result** | **String** |  | [optional] 
+**token** | [**Token**](Token.md) |  | [optional] 
+**auth_response** | [**CreditCardAuthResponse**](CreditCardAuthResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::InstrumentVerificationResponse.new(client_correlation_id: null,
+                                 client_unique_transaction_id: null,
+                                 verification_id: null,
+                                 instrument_id: null,
+                                 status: null,
+                                 result: null,
+                                 token: null,
+                                 auth_response: null)
+```
+
+

data/docs/KYC.md

@@ -0,0 +1,21 @@
+# Yapstone::KYC
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mobile_phone** | [**Phone**](Phone.md) |  | [optional] 
+**gov_identification** | [**GovIdentification**](GovIdentification.md) |  | [optional] 
+**date_of_birth** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::KYC.new(mobile_phone: null,
+                                 gov_identification: null,
+                                 date_of_birth: null)
+```
+
+

data/docs/LeaseInfo.md

@@ -0,0 +1,21 @@
+# Yapstone::LeaseInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lease_duration** | **String** | The length of the lease.  | [optional] 
+**lease_end** | **String** | Lease end date  | [optional] 
+**lease_start** | **String** | Lease start date  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::LeaseInfo.new(lease_duration: null,
+                                 lease_end: null,
+                                 lease_start: null)
+```
+
+

data/docs/LineItemDetails.md

@@ -0,0 +1,25 @@
+# Yapstone::LineItemDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**line_item_id** | **String** | Each line item has its own unique identifier so you can call out a particular part of a transaction.  | [optional] 
+**offering_name** | **String** | This is the name of the product that appears in a line item. It is referred to as an offering.  | [optional] 
+**offering_id** | **String** | The unique identifier for the offering (product).  | [optional] 
+**settlement_status** | **String** | This parameter indicates whether the refund has been settled for this line item or not.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::LineItemDetails.new(amount: null,
+                                 line_item_id: null,
+                                 offering_name: null,
+                                 offering_id: null,
+                                 settlement_status: null)
+```
+
+

data/docs/MarketplaceData.md

@@ -0,0 +1,23 @@
+# Yapstone::MarketplaceData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_listing_id** | **String** | The ID of the asset that is being exchanged in relation to this payment, e.g. a vacation rental home or a long-term rental unit. This is used to determine what account the funds related to this payment should be disbursed to.  | [optional] 
+**marketplace_type** | **String** | The type of marketplace in Yapstone's system. If you're unsure what marketplace type applies to you, please contact your Yapstone representative.  | [optional] 
+**vacation_rental_info** | [**VacationRentalInfoRequest**](VacationRentalInfoRequest.md) |  | [optional] 
+**rental_info** | [**RentalInfo**](RentalInfo.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceData.new(asset_listing_id: UP:AST:tg4CrrmOSria3RNCpPFAIQ,
+                                 marketplace_type: VACATION_RENT,
+                                 vacation_rental_info: null,
+                                 rental_info: null)
+```
+
+

data/docs/Merketplace.md

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

data/docs/Money.md

@@ -0,0 +1,19 @@
+# Yapstone::Money
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Integer** | Amount | [optional] 
+**currency** | **String** | Currency represented in ISO 4217 format.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Money.new(value: null,
+                                 currency: null)
+```
+
+

data/docs/Name.md

@@ -0,0 +1,27 @@
+# Yapstone::Name
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**additional_last** | **String** | This can be used to store an additional last name for the payer if they have more than one.  | [optional] 
+**first** | **String** | Payer first name | [optional] 
+**honorific_prefix** | **String** | sample desc | [optional] 
+**honorific_suffix** | **String** | sample desc | [optional] 
+**last** | **String** | Payer last name | [optional] 
+**middle** | **String** | Payer middle name | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Name.new(additional_last: null,
+                                 first: null,
+                                 honorific_prefix: null,
+                                 honorific_suffix: null,
+                                 last: null,
+                                 middle: null)
+```
+
+

data/docs/OfferingDetails.md

@@ -0,0 +1,21 @@
+# Yapstone::OfferingDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**offering_name** | **String** | Optionally provide the name or ID of the offering being purchased in this line item. Name must match exactly with the Offering that has been previously onboarded in your marketplace.  | [optional] 
+**offering_id** | **String** | Optionally provide the name or ID of the offering being purchased in this line item. IDs must correspond with an Offering that has been previously onboarded in your marketplace.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::OfferingDetails.new(amount: null,
+                                 offering_name: null,
+                                 offering_id: null)
+```
+
+

data/docs/OrderTransactions.md

@@ -0,0 +1,25 @@
+# Yapstone::OrderTransactions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The unique identification number for a particular transaction.  | [optional] 
+**line_items** | [**Array<LineItemDetails>**](LineItemDetails.md) |  | [optional] 
+**transaction_status** | [**Status**](Status.md) |  | [optional] 
+**transaction_type** | **String** |  | [optional] 
+**auth_response** | [**CreditCardAuthResponse**](CreditCardAuthResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::OrderTransactions.new(transaction_id: null,
+                                 line_items: null,
+                                 transaction_status: null,
+                                 transaction_type: null,
+                                 auth_response: null)
+```
+
+

data/docs/Payment.md

@@ -0,0 +1,21 @@
+# Yapstone::Payment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**Status**](Status.md) |  | [optional] 
+**payment_instrument** | [**PaymentInstrumentResponse**](PaymentInstrumentResponse.md) |  | [optional] 
+**transactions** | [**Array<OrderTransactions>**](OrderTransactions.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Payment.new(status: null,
+                                 payment_instrument: null,
+                                 transactions: null)
+```
+
+

data/docs/PaymentCancelResponse.md

@@ -0,0 +1,23 @@
+# Yapstone::PaymentCancelResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | Unique identifier for a cancelled payment.  | [optional] 
+**client_unique_transaction_id** | **String** | clientUniqueTransactionId | [optional] 
+**status** | [**Status**](Status.md) |  | [optional] 
+**transactions** | [**Array<PaymentCancelTransactionResponse>**](PaymentCancelTransactionResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentCancelResponse.new(payment_id: null,
+                                 client_unique_transaction_id: null,
+                                 status: null,
+                                 transactions: null)
+```
+
+

data/docs/PaymentCancelTransactionResponse.md

@@ -0,0 +1,21 @@
+# Yapstone::PaymentCancelTransactionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | Transaction Id | [optional] 
+**response** | **String** | Response | [optional] 
+**refund_transactions** | [**Array<RefundTransactions>**](RefundTransactions.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentCancelTransactionResponse.new(transaction_id: null,
+                                 response: null,
+                                 refund_transactions: null)
+```
+
+

data/docs/PaymentDetails.md

@@ -0,0 +1,29 @@
+# Yapstone::PaymentDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line_items** | [**Array<OfferingDetails>**](OfferingDetails.md) | If your payment is for multiple line items, detail them here. The sum of your line item amounts must equal the amount given at the root of the request body.  | [optional] 
+**authorization_type** | **String** | Used to list the authorization type. If it is PRIORAUTH this is a pre-authorization that places a hold on your customer's credit card for a specified dollar amount based on a projected sale amount. FINALAUTH is when you have completed all work checking the card and the customer and you are ready to actually withdraw the payment.  | [optional] [default to 'FINALAUTH']
+**custom_soft_descriptor** | **String** | The descriptor that will be shown on the customer's bank statement after the transaction has been authorized.  | [optional] 
+**installment_plan** | [**InstallmentPlan**](InstallmentPlan.md) |  | [optional] 
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**payment_instrument** | [**PaymentInstrument**](PaymentInstrument.md) |  | [optional] 
+**instrument_owner** | **Boolean** | This indicates whether it is true that the payment method a customer wants to use belongs to the customer or not. | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentDetails.new(line_items: null,
+                                 authorization_type: null,
+                                 custom_soft_descriptor: MY COMPANY 800-555-1234,
+                                 installment_plan: null,
+                                 amount: null,
+                                 payment_instrument: null,
+                                 instrument_owner: null)
+```
+
+

data/docs/PaymentInstrument.md

@@ -0,0 +1,27 @@
+# Yapstone::PaymentInstrument
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apm** | [**APM**](APM.md) |  | [optional] 
+**bank** | [**BankAccount**](BankAccount.md) |  | [optional] 
+**card** | [**Card**](Card.md) |  | [optional] 
+**token** | [**TokenReq**](TokenReq.md) |  | [optional] 
+**kyc** | [**KYC**](KYC.md) |  | [optional] 
+**instrument_type** | **String** | Credit Card(includes Debit card) or ACH or APM or of Wallet Type with possible values = androidpay, masterpass ,apple pay, paywithgoogle ,samsungpay, visacheckout | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentInstrument.new(apm: null,
+                                 bank: null,
+                                 card: null,
+                                 token: null,
+                                 kyc: null,
+                                 instrument_type: null)
+```
+
+

data/docs/PaymentInstrumentCard.md

@@ -0,0 +1,19 @@
+# Yapstone::PaymentInstrumentCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card** | [**Card**](Card.md) |  | [optional] 
+**instrument_type** | **String** | Credit Card(includes Debit card) or ACH or APM or of Wallet Type with possible values = androidpay, masterpass ,apple pay, paywithgoogle ,samsungpay, visacheckout | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentInstrumentCard.new(card: null,
+                                 instrument_type: CARD)
+```
+
+