yapstone-so 1.0.0

data/docs/MarketplaceProductsApi.md

@@ -0,0 +1,116 @@
+# Yapstone::MarketplaceProductsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_marketplace_product**](MarketplaceProductsApi.md#get_marketplace_product) | **GET** /marketplace-products/{productId} | Retrieves a MarketPlace Product
+[**update_marketplace_product**](MarketplaceProductsApi.md#update_marketplace_product) | **PUT** /marketplace-products/{productId} | Update selctive MarketPlace Product details
+
+
+
+## get_marketplace_product
+
+> MarketplaceProductResource get_marketplace_product(product_id)
+
+Retrieves a MarketPlace Product
+
+Retrieves a MarketPlace Product
+
+### 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::MarketplaceProductsApi.new
+product_id = 'product_id_example' # String | The unique id of Product Resource.
+
+begin
+  #Retrieves a MarketPlace Product
+  result = api_instance.get_marketplace_product(product_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling MarketplaceProductsApi->get_marketplace_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| The unique id of Product Resource. | 
+
+### Return type
+
+[**MarketplaceProductResource**](MarketplaceProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_marketplace_product
+
+> MarketplaceProductResource update_marketplace_product(product_id, marketplace_product_resource)
+
+Update selctive MarketPlace Product details
+
+Update selctive MarketPlace Product details
+
+### 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::MarketplaceProductsApi.new
+product_id = 'product_id_example' # String | The unique id of Product Resource.
+marketplace_product_resource = Yapstone::MarketplaceProductResource.new # MarketplaceProductResource | The Marketplace product resource object with fields to be updated.
+
+begin
+  #Update selctive MarketPlace Product details
+  result = api_instance.update_marketplace_product(product_id, marketplace_product_resource)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling MarketplaceProductsApi->update_marketplace_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| The unique id of Product Resource. | 
+ **marketplace_product_resource** | [**MarketplaceProductResource**](MarketplaceProductResource.md)| The Marketplace product resource object with fields to be updated. | 
+
+### Return type
+
+[**MarketplaceProductResource**](MarketplaceProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/MarketplacesApi.md

@@ -0,0 +1,227 @@
+# Yapstone::MarketplacesApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_marketplace_product**](MarketplacesApi.md#add_marketplace_product) | **POST** /contracts/{contractId}/marketplaces | 
+[**deactivate_marketplace_product**](MarketplacesApi.md#deactivate_marketplace_product) | **DELETE** /contracts/{contractId}/marketplaces/{assetId} | 
+[**get_marketplace_product_by_asset_id**](MarketplacesApi.md#get_marketplace_product_by_asset_id) | **GET** /contracts/{contractId}/marketplaces/{assetId} | 
+[**update_marketplace_product_by_contract_id**](MarketplacesApi.md#update_marketplace_product_by_contract_id) | **PUT** /contracts/{contractId}/marketplaces/{assetId} | 
+
+
+
+## add_marketplace_product
+
+> MarketplaceProductResource add_marketplace_product(contract_id, marketplace_product_add)
+
+
+
+Add a new market place in a given contract.
+
+### 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::MarketplacesApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+marketplace_product_add = Yapstone::MarketplaceProductAdd.new # MarketplaceProductAdd | The market place details
+
+begin
+  result = api_instance.add_marketplace_product(contract_id, marketplace_product_add)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling MarketplacesApi->add_marketplace_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **marketplace_product_add** | [**MarketplaceProductAdd**](MarketplaceProductAdd.md)| The market place details | 
+
+### Return type
+
+[**MarketplaceProductResource**](MarketplaceProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_marketplace_product
+
+> deactivate_marketplace_product(contract_id, asset_id, deactivate_request)
+
+
+
+deactivate the Marketplace Product 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::MarketplacesApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+asset_id = 'asset_id_example' # String | The unique id of the Asset Resource.
+deactivate_request = Yapstone::DeactivateRequest.new # DeactivateRequest | The details of the deactivation process.
+
+begin
+  api_instance.deactivate_marketplace_product(contract_id, asset_id, deactivate_request)
+rescue Yapstone::ApiError => e
+  puts "Exception when calling MarketplacesApi->deactivate_marketplace_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **asset_id** | **String**| The unique id of the Asset Resource. | 
+ **deactivate_request** | [**DeactivateRequest**](DeactivateRequest.md)| The details of the deactivation process. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_marketplace_product_by_asset_id
+
+> MarketplaceProductResource get_marketplace_product_by_asset_id(contract_id, asset_id)
+
+
+
+Retrieves an Marketplace Resource from the system for the given contractId and assetId.
+
+### 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::MarketplacesApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+asset_id = 'asset_id_example' # String | The unique id of the Asset Resource.
+
+begin
+  result = api_instance.get_marketplace_product_by_asset_id(contract_id, asset_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling MarketplacesApi->get_marketplace_product_by_asset_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **asset_id** | **String**| The unique id of the Asset Resource. | 
+
+### Return type
+
+[**MarketplaceProductResource**](MarketplaceProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_marketplace_product_by_contract_id
+
+> MarketplaceProductResource update_marketplace_product_by_contract_id(contract_id, asset_id, marketplace_product_update)
+
+
+
+Updates the Marketplace Resource in a given 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::MarketplacesApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+asset_id = 'asset_id_example' # String | The unique id of the Asset Resource.
+marketplace_product_update = Yapstone::MarketplaceProductUpdate.new # MarketplaceProductUpdate | The Market Resource to be updated.
+
+begin
+  result = api_instance.update_marketplace_product_by_contract_id(contract_id, asset_id, marketplace_product_update)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling MarketplacesApi->update_marketplace_product_by_contract_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **asset_id** | **String**| The unique id of the Asset Resource. | 
+ **marketplace_product_update** | [**MarketplaceProductUpdate**](MarketplaceProductUpdate.md)| The Market Resource to be updated. | 
+
+### Return type
+
+[**MarketplaceProductResource**](MarketplaceProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/Meta.md

@@ -0,0 +1,21 @@
+# Yapstone::Meta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_count** | **Integer** |  | [optional] 
+**page** | **Integer** |  | 
+**size** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Meta.new(total_count: null,
+                                 page: null,
+                                 size: null)
+```
+
+

data/docs/MoneyResource.md

@@ -0,0 +1,19 @@
+# Yapstone::MoneyResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_code** | **String** | The ISO currency code for the moneyResource. | 
+**value** | **Integer** | The amount of the in cents. | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MoneyResource.new(currency_code: null,
+                                 value: null)
+```
+
+

data/docs/NameResource.md

@@ -0,0 +1,27 @@
+# Yapstone::NameResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**honorific_prefix** | **String** | The persons title. | [optional] 
+**first** | **String** | The persons first name. | 
+**middle** | **String** | The persons middle name or initial. | [optional] 
+**last** | **String** | The persons last name. | 
+**additional_last** | **String** | The 2nd last name of the person. | [optional] 
+**honorific_suffix** | **String** | The persons title. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::NameResource.new(honorific_prefix: null,
+                                 first: null,
+                                 middle: null,
+                                 last: null,
+                                 additional_last: null,
+                                 honorific_suffix: null)
+```
+
+

data/docs/OwnerRequest.md

@@ -0,0 +1,21 @@
+# Yapstone::OwnerRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first** | **String** | The persons first name. | 
+**last** | **String** | The persons last name. | 
+**address** | [**AddressResource**](AddressResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::OwnerRequest.new(first: null,
+                                 last: null,
+                                 address: null)
+```
+
+

data/docs/OwnerResource.md

@@ -0,0 +1,23 @@
+# Yapstone::OwnerResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | id of the applicant | [optional] 
+**first** | **String** | The persons first name. | 
+**last** | **String** | The persons last name. | 
+**address** | [**AddressResource**](AddressResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::OwnerResource.new(id: null,
+                                 first: null,
+                                 last: null,
+                                 address: null)
+```
+
+

data/docs/Pagination.md

@@ -0,0 +1,21 @@
+# Yapstone::Pagination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_count** | **Integer** |  | [optional] 
+**page** | **Integer** |  | 
+**size** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Pagination.new(total_count: null,
+                                 page: null,
+                                 size: null)
+```
+
+

data/docs/PatchOperation.md

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

data/docs/PayoutInstrumentRequest.md

@@ -0,0 +1,29 @@
+# Yapstone::PayoutInstrumentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for the Payout Instrument. | [optional] 
+**bank_account** | [**BankAccountResource**](BankAccountResource.md) |  | [optional] 
+**payment_card** | [**CardDataResource**](CardDataResource.md) |  | [optional] 
+**type** | **String** | The type of finanancial instrument [BANK_ACCOUNT] | 
+**owner** | [**OwnerResource**](OwnerResource.md) |  | [optional] 
+**consents** | [**Array<Consent>**](Consent.md) | list of consent requests | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutInstrumentRequest.new(external_id: null,
+                                 bank_account: null,
+                                 payment_card: null,
+                                 type: null,
+                                 owner: null,
+                                 consents: null,
+                                 products: null)
+```
+
+

data/docs/PayoutInstrumentResource.md

@@ -0,0 +1,35 @@
+# Yapstone::PayoutInstrumentResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for the Payout Instrument. | [optional] 
+**bank_account** | [**BankAccountResource**](BankAccountResource.md) |  | [optional] 
+**payment_card** | [**CardDataResource**](CardDataResource.md) |  | [optional] 
+**type** | **String** | The type of finanancial instrument [BANK_ACCOUNT] | 
+**id** | **String** | The resource identifier for the Payout Instrument. | [optional] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**owner** | [**OwnerResource**](OwnerResource.md) |  | [optional] 
+**consents** | [**Array<Consent>**](Consent.md) | list of consent responses | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+**capabilities** | [**Array<CapabilityResource>**](CapabilityResource.md) | Set of capabilities the instrument can perform. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutInstrumentResource.new(external_id: null,
+                                 bank_account: null,
+                                 payment_card: null,
+                                 type: null,
+                                 id: null,
+                                 status: null,
+                                 owner: null,
+                                 consents: null,
+                                 products: null,
+                                 capabilities: null)
+```
+
+

data/docs/PayoutInstrumentResourceCommonEntities.md

@@ -0,0 +1,23 @@
+# Yapstone::PayoutInstrumentResourceCommonEntities
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for the Payout Instrument. | [optional] 
+**bank_account** | [**BankAccountResource**](BankAccountResource.md) |  | [optional] 
+**payment_card** | [**CardDataResource**](CardDataResource.md) |  | [optional] 
+**type** | **String** | The type of finanancial instrument [BANK_ACCOUNT] | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutInstrumentResourceCommonEntities.new(external_id: null,
+                                 bank_account: null,
+                                 payment_card: null,
+                                 type: null)
+```
+
+

data/docs/PayoutInstrumentUpdateRequest.md

@@ -0,0 +1,31 @@
+# Yapstone::PayoutInstrumentUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for the Payout Instrument. | [optional] 
+**bank_account** | [**BankAccountResource**](BankAccountResource.md) |  | [optional] 
+**payment_card** | [**CardDataResource**](CardDataResource.md) |  | [optional] 
+**type** | **String** | The type of finanancial instrument [BANK_ACCOUNT] | 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**owner** | [**OwnerRequest**](OwnerRequest.md) |  | [optional] 
+**consents** | [**Array<Consent>**](Consent.md) | list of consent requests | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutInstrumentUpdateRequest.new(external_id: null,
+                                 bank_account: null,
+                                 payment_card: null,
+                                 type: null,
+                                 status: null,
+                                 owner: null,
+                                 consents: null,
+                                 products: null)
+```
+
+