yapstone-so 1.0.0

data/docs/ConsentResource.md

@@ -0,0 +1,27 @@
+# Yapstone::ConsentResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_of_consent** | **DateTime** | The timestamp in ISO 8601 format when the user consentted. | [optional] 
+**type** | [**ConsentType**](ConsentType.md) |  | 
+**version** | **Integer** | The version of the consent if there is one. | 
+**accepted** | **Boolean** | Indicates the acceptance of the T&Cs. | 
+**ip_address** | **String** | The ipAddress origin of the incoming call. | 
+**device_fingerprint_id** | **String** | The device fingerprint identifier. | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ConsentResource.new(time_of_consent: null,
+                                 type: null,
+                                 version: null,
+                                 accepted: null,
+                                 ip_address: null,
+                                 device_fingerprint_id: null)
+```
+
+

data/docs/ConsentType.md

@@ -0,0 +1,16 @@
+# Yapstone::ConsentType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ConsentType.new()
+```
+
+

data/docs/ContractCreateRequest.md

@@ -0,0 +1,21 @@
+# Yapstone::ContractCreateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for entity. | [optional] 
+**applicant_id** | **String** | The unique id of the Applicant Resource. | [optional] 
+**products** | **Object** | Product catalog. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ContractCreateRequest.new(external_id: null,
+                                 applicant_id: null,
+                                 products: null)
+```
+
+

data/docs/ContractResource.md

@@ -0,0 +1,23 @@
+# Yapstone::ContractResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for entity. | [optional] 
+**id** | **String** | The resource identifier for the Contract. | [optional] 
+**applicant_id** | **String** | The unique id of the Applicant Resource. | [optional] 
+**products** | **Object** | Product catalog. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ContractResource.new(external_id: null,
+                                 id: null,
+                                 applicant_id: null,
+                                 products: null)
+```
+
+

data/docs/ContractResourceDTO.md

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

data/docs/ContractResourceDTOAllOf.md

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

data/docs/ContractUpdateRequest.md

@@ -0,0 +1,19 @@
+# Yapstone::ContractUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for entity. | [optional] 
+**applicant_id** | **String** | The unique id of the Applicant Resource. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ContractUpdateRequest.new(external_id: null,
+                                 applicant_id: null)
+```
+
+

data/docs/ContractsApi.md

@@ -0,0 +1,227 @@
+# Yapstone::ContractsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_contract**](ContractsApi.md#create_contract) | **POST** /contracts | 
+[**get_all_contracts**](ContractsApi.md#get_all_contracts) | **GET** /contracts | Retrieves all of contracts
+[**get_contract**](ContractsApi.md#get_contract) | **GET** /contracts/{contractId} | 
+[**update_contract**](ContractsApi.md#update_contract) | **PUT** /contracts/{contractId} | 
+
+
+
+## create_contract
+
+> ContractResource create_contract(contract_create_request)
+
+
+
+Creates an Contract Resource in the system.
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-so'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::ContractsApi.new
+contract_create_request = Yapstone::ContractCreateRequest.new # ContractCreateRequest | The Contract Request Resource to be created.
+
+begin
+  result = api_instance.create_contract(contract_create_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling ContractsApi->create_contract: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_create_request** | [**ContractCreateRequest**](ContractCreateRequest.md)| The Contract Request Resource to be created. | 
+
+### Return type
+
+[**ContractResource**](ContractResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_all_contracts
+
+> ContractResourceDTO get_all_contracts(opts)
+
+Retrieves all of contracts
+
+Retrieves all of the Contracts
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-so'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::ContractsApi.new
+opts = {
+  applicant_id: 'applicant_id_example', # String | applicantId
+  asset_id: 'asset_id_example', # String | assetId
+  payout_instrument_id: 'payout_instrument_id_example', # String | payoutInstrumentId
+  product: 'product_example' # String | filter by provided product
+}
+
+begin
+  #Retrieves all of contracts
+  result = api_instance.get_all_contracts(opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling ContractsApi->get_all_contracts: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| applicantId | [optional] 
+ **asset_id** | **String**| assetId | [optional] 
+ **payout_instrument_id** | **String**| payoutInstrumentId | [optional] 
+ **product** | **String**| filter by provided product | [optional] 
+
+### Return type
+
+[**ContractResourceDTO**](ContractResourceDTO.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_contract
+
+> ContractResource get_contract(contract_id)
+
+
+
+Retrieves an Contract Resource from the system for the given contractId.
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-so'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::ContractsApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+
+begin
+  result = api_instance.get_contract(contract_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling ContractsApi->get_contract: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+
+### Return type
+
+[**ContractResource**](ContractResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_contract
+
+> ContractResource update_contract(contract_id, contract_update_request)
+
+
+
+Updates the Contract Resource.
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-so'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::ContractsApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+contract_update_request = Yapstone::ContractUpdateRequest.new # ContractUpdateRequest | The Contract Resource to be created after updation.
+
+begin
+  result = api_instance.update_contract(contract_id, contract_update_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling ContractsApi->update_contract: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **contract_update_request** | [**ContractUpdateRequest**](ContractUpdateRequest.md)| The Contract Resource to be created after updation. | 
+
+### Return type
+
+[**ContractResource**](ContractResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/CustomerHistoryResource.md

@@ -0,0 +1,19 @@
+# Yapstone::CustomerHistoryResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_owner** | [**PropertyOwnerResource**](PropertyOwnerResource.md) |  | [optional] 
+**traveler** | [**TravelerResource**](TravelerResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CustomerHistoryResource.new(property_owner: null,
+                                 traveler: null)
+```
+
+

data/docs/DeactivateRequest.md

@@ -0,0 +1,19 @@
+# Yapstone::DeactivateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | reason for de-activation | 
+**note** | **String** | Reason Notes for why the deactivation is requested | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DeactivateRequest.new(reason: null,
+                                 note: null)
+```
+
+

data/docs/DeactivateResponse.md

@@ -0,0 +1,21 @@
+# Yapstone::DeactivateResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**cascaded_contracts** | **Array<String>** | List of contracts successfully de-activated due to cascade, otherwise empty | [optional] 
+**failed_contracts** | **Array<String>** | List of contracts failed to de-activate while cascade, otherwise empty | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DeactivateResponse.new(message: null,
+                                 cascaded_contracts: null,
+                                 failed_contracts: null)
+```
+
+

data/docs/DirectDebitConsentResource.md

@@ -0,0 +1,19 @@
+# Yapstone::DirectDebitConsentResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The reference number that client has for the mandate | [optional] 
+**creditor_id** | **String** | The creditor Id | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DirectDebitConsentResource.new(external_id: null,
+                                 creditor_id: null)
+```
+
+

data/docs/DirectDebitFrequencyType.md

@@ -0,0 +1,16 @@
+# Yapstone::DirectDebitFrequencyType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DirectDebitFrequencyType.new()
+```
+
+

data/docs/DirectDebitSchemeType.md

@@ -0,0 +1,16 @@
+# Yapstone::DirectDebitSchemeType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DirectDebitSchemeType.new()
+```
+
+

data/docs/DirectDebtCapabilityResource.md

@@ -0,0 +1,23 @@
+# Yapstone::DirectDebtCapabilityResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the mandate maintained internally by yapstone | [optional] 
+**scheme** | [**DirectDebitSchemeType**](DirectDebitSchemeType.md) |  | [optional] 
+**status** | **String** | The status of the capability | [optional] 
+**creditor_id** | **String** | The creditor Id | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::DirectDebtCapabilityResource.new(id: null,
+                                 scheme: null,
+                                 status: null,
+                                 creditor_id: null)
+```
+
+

data/docs/EntitiesResource.md

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

data/docs/EntityHistoryResource.md

@@ -0,0 +1,17 @@
+# Yapstone::EntityHistoryResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<EntityUpdateEvent>**](EntityUpdateEvent.md) | A list of entity update events. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::EntityHistoryResource.new(results: null)
+```
+
+

data/docs/EntityProductStatusResource.md

@@ -0,0 +1,19 @@
+# Yapstone::EntityProductStatusResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**marketplace** | [**StatusResource**](StatusResource.md) |  | [optional] 
+**payout** | [**StatusResource**](StatusResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::EntityProductStatusResource.new(marketplace: null,
+                                 payout: null)
+```
+
+

data/docs/EntityUpdateEvent.md

@@ -0,0 +1,23 @@
+# Yapstone::EntityUpdateEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_id** | **String** | Unique Id of entity. | [optional] 
+**updated_attributes** | [**Array<EntityUpdatedAttribute>**](EntityUpdatedAttribute.md) | List of updated attributes. | [optional] 
+**user_name** | **String** | Name of user. | [optional] 
+**last_updated** | **DateTime** | The timestamp in ISO 8601 format when the entity last updated. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::EntityUpdateEvent.new(entity_id: null,
+                                 updated_attributes: null,
+                                 user_name: null,
+                                 last_updated: null)
+```
+
+

data/docs/EntityUpdatedAttribute.md

@@ -0,0 +1,21 @@
+# Yapstone::EntityUpdatedAttribute
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of attribute. | [optional] 
+**new_value** | [**Object**](.md) | New value of attribute. | [optional] 
+**old_value** | [**Object**](.md) | Old value of attribute. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::EntityUpdatedAttribute.new(name: null,
+                                 new_value: null,
+                                 old_value: null)
+```
+
+

data/docs/Errors.md

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

data/docs/ExpirationDateResource.md

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

data/docs/Gender.md

@@ -0,0 +1,16 @@
+# Yapstone::Gender
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Gender.new()
+```
+
+