yapstone-so 1.0.0

data/docs/PayoutInstrumentsApi.md

@@ -0,0 +1,274 @@
+# Yapstone::PayoutInstrumentsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_payout_instrument**](PayoutInstrumentsApi.md#create_payout_instrument) | **POST** /payout-instruments | 
+[**deactivate_payout_instrument**](PayoutInstrumentsApi.md#deactivate_payout_instrument) | **DELETE** /payout-instruments/{payoutInstrumentId} | 
+[**get_payout_instrument**](PayoutInstrumentsApi.md#get_payout_instrument) | **GET** /payout-instruments/{payoutInstrumentId} | 
+[**get_payout_instruments**](PayoutInstrumentsApi.md#get_payout_instruments) | **GET** /payout-instruments | 
+[**update_payout_instrument**](PayoutInstrumentsApi.md#update_payout_instrument) | **PUT** /payout-instruments/{payoutInstrumentId} | 
+
+
+
+## create_payout_instrument
+
+> PayoutInstrumentResource create_payout_instrument(payout_instrument_request)
+
+
+
+Creates an Payout Instrument 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::PayoutInstrumentsApi.new
+payout_instrument_request = Yapstone::PayoutInstrumentRequest.new # PayoutInstrumentRequest | The Payout Instrument Request Resource to be created.
+
+begin
+  result = api_instance.create_payout_instrument(payout_instrument_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutInstrumentsApi->create_payout_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_instrument_request** | [**PayoutInstrumentRequest**](PayoutInstrumentRequest.md)| The Payout Instrument Request Resource to be created. | 
+
+### Return type
+
+[**PayoutInstrumentResource**](PayoutInstrumentResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_payout_instrument
+
+> DeactivateResponse deactivate_payout_instrument(payout_instrument_id)
+
+
+
+Deactivates the Payout Instrument 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::PayoutInstrumentsApi.new
+payout_instrument_id = 'payout_instrument_id_example' # String | The unique id of the  Payout Instrument Resource.
+
+begin
+  result = api_instance.deactivate_payout_instrument(payout_instrument_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutInstrumentsApi->deactivate_payout_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_instrument_id** | **String**| The unique id of the  Payout Instrument Resource. | 
+
+### Return type
+
+[**DeactivateResponse**](DeactivateResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payout_instrument
+
+> PayoutInstrumentResource get_payout_instrument(payout_instrument_id)
+
+
+
+Retrieves an Payout Instrument Resource from the system for the given payoutInstrumentId.
+
+### 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::PayoutInstrumentsApi.new
+payout_instrument_id = 'payout_instrument_id_example' # String | The unique id of the  Payout Instrument Resource.
+
+begin
+  result = api_instance.get_payout_instrument(payout_instrument_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutInstrumentsApi->get_payout_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_instrument_id** | **String**| The unique id of the  Payout Instrument Resource. | 
+
+### Return type
+
+[**PayoutInstrumentResource**](PayoutInstrumentResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payout_instruments
+
+> PayoutInstrumentsResource get_payout_instruments(opts)
+
+
+
+Get all Payout Instrument Resources the actor has access to 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::PayoutInstrumentsApi.new
+opts = {
+  page: 56, # Integer | page number
+  size: 56 # Integer | Maximum number of records to return per page
+}
+
+begin
+  result = api_instance.get_payout_instruments(opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutInstrumentsApi->get_payout_instruments: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| page number | [optional] 
+ **size** | **Integer**| Maximum number of records to return per page | [optional] 
+
+### Return type
+
+[**PayoutInstrumentsResource**](PayoutInstrumentsResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_payout_instrument
+
+> PayoutInstrumentResource update_payout_instrument(payout_instrument_id, payout_instrument_update_request)
+
+
+
+Updates the PayoutInstrument 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::PayoutInstrumentsApi.new
+payout_instrument_id = 'payout_instrument_id_example' # String | The unique id of the  Payout Instrument Resource.
+payout_instrument_update_request = Yapstone::PayoutInstrumentUpdateRequest.new # PayoutInstrumentUpdateRequest | The PayoutInstrument Request Resource to be updated.
+
+begin
+  result = api_instance.update_payout_instrument(payout_instrument_id, payout_instrument_update_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutInstrumentsApi->update_payout_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_instrument_id** | **String**| The unique id of the  Payout Instrument Resource. | 
+ **payout_instrument_update_request** | [**PayoutInstrumentUpdateRequest**](PayoutInstrumentUpdateRequest.md)| The PayoutInstrument Request Resource to be updated. | 
+
+### Return type
+
+[**PayoutInstrumentResource**](PayoutInstrumentResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/PayoutInstrumentsResource.md

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

data/docs/PayoutInstrumentsResourceAllOf.md

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

data/docs/PayoutProductAdd.md

@@ -0,0 +1,19 @@
+# Yapstone::PayoutProductAdd
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consents** | [**Array<ConsentRequest>**](ConsentRequest.md) | An array of consents. | [optional] 
+**payout_instrument_id** | **String** | An unique id of Payout Instrument Resource | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutProductAdd.new(consents: null,
+                                 payout_instrument_id: null)
+```
+
+

data/docs/PayoutProductResource.md

@@ -0,0 +1,27 @@
+# Yapstone::PayoutProductResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique id of the resource | [optional] 
+**consents** | [**Array<ConsentResource>**](ConsentResource.md) | An array of consents. | [optional] 
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**payout_instrument_id** | **String** | payout instrumnet id | [optional] 
+**credit_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**debit_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutProductResource.new(id: null,
+                                 consents: null,
+                                 status: null,
+                                 payout_instrument_id: null,
+                                 credit_status: null,
+                                 debit_status: null)
+```
+
+

data/docs/PayoutProductSubResource.md

@@ -0,0 +1,25 @@
+# Yapstone::PayoutProductSubResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consents** | [**Array<ConsentResource>**](ConsentResource.md) | An array of consents. | [optional] 
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**payout_instrument_id** | **String** | payout instrumnet id | [optional] 
+**credit_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**debit_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutProductSubResource.new(consents: null,
+                                 status: null,
+                                 payout_instrument_id: null,
+                                 credit_status: null,
+                                 debit_status: null)
+```
+
+

data/docs/PayoutProductSubResourceAllOf.md

@@ -0,0 +1,23 @@
+# Yapstone::PayoutProductSubResourceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**payout_instrument_id** | **String** | payout instrumnet id | [optional] 
+**credit_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**debit_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PayoutProductSubResourceAllOf.new(status: null,
+                                 payout_instrument_id: null,
+                                 credit_status: null,
+                                 debit_status: null)
+```
+
+

data/docs/PayoutProductsApi.md

@@ -0,0 +1,61 @@
+# Yapstone::PayoutProductsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_payout_product**](PayoutProductsApi.md#get_payout_product) | **GET** /payout-products/{productId} | Retrieves a Payout Product
+
+
+
+## get_payout_product
+
+> PayoutProductResource get_payout_product(product_id)
+
+Retrieves a Payout Product
+
+Retrieves a Payout 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::PayoutProductsApi.new
+product_id = 'product_id_example' # String | The unique id of Product Resource.
+
+begin
+  #Retrieves a Payout Product
+  result = api_instance.get_payout_product(product_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutProductsApi->get_payout_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| The unique id of Product Resource. | 
+
+### Return type
+
+[**PayoutProductResource**](PayoutProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PayoutsApi.md

@@ -0,0 +1,227 @@
+# Yapstone::PayoutsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_payout_product**](PayoutsApi.md#add_payout_product) | **POST** /contracts/{contractId}/payouts | 
+[**deactivate_payout_product**](PayoutsApi.md#deactivate_payout_product) | **DELETE** /contracts/{contractId}/payouts/{payoutInstrumentId} | 
+[**get_payout_product_by_instrument_id**](PayoutsApi.md#get_payout_product_by_instrument_id) | **GET** /contracts/{contractId}/payouts/{payoutInstrumentId} | 
+[**update_payout_product**](PayoutsApi.md#update_payout_product) | **PUT** /contracts/{contractId}/payouts/{payoutInstrumentId} | 
+
+
+
+## add_payout_product
+
+> PayoutProductResource add_payout_product(contract_id, payout_product_add)
+
+
+
+Add a payout product 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::PayoutsApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+payout_product_add = Yapstone::PayoutProductAdd.new # PayoutProductAdd | The payout instruments list
+
+begin
+  result = api_instance.add_payout_product(contract_id, payout_product_add)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutsApi->add_payout_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **payout_product_add** | [**PayoutProductAdd**](PayoutProductAdd.md)| The payout instruments list | 
+
+### Return type
+
+[**PayoutProductResource**](PayoutProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_payout_product
+
+> deactivate_payout_product(contract_id, payout_instrument_id, deactivate_request)
+
+
+
+deactivate the Payout 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::PayoutsApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+payout_instrument_id = 'payout_instrument_id_example' # String | The unique id of the  Payout Instrument Resource.
+deactivate_request = Yapstone::DeactivateRequest.new # DeactivateRequest | The details of the deactivation process.
+
+begin
+  api_instance.deactivate_payout_product(contract_id, payout_instrument_id, deactivate_request)
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutsApi->deactivate_payout_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **payout_instrument_id** | **String**| The unique id of the  Payout Instrument 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_payout_product_by_instrument_id
+
+> PayoutProductResource get_payout_product_by_instrument_id(contract_id, payout_instrument_id)
+
+
+
+Retrieves an Payout Resource from the system for the given contractId and payoutInstrumentId.
+
+### 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::PayoutsApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+payout_instrument_id = 'payout_instrument_id_example' # String | The unique id of the  Payout Instrument Resource.
+
+begin
+  result = api_instance.get_payout_product_by_instrument_id(contract_id, payout_instrument_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutsApi->get_payout_product_by_instrument_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **payout_instrument_id** | **String**| The unique id of the  Payout Instrument Resource. | 
+
+### Return type
+
+[**PayoutProductResource**](PayoutProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_payout_product
+
+> PayoutProductResource update_payout_product(contract_id, payout_instrument_id, payout_product_resource)
+
+
+
+Updates the Payout product in 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::PayoutsApi.new
+contract_id = 'contract_id_example' # String | The unique id of the Contract Resource.
+payout_instrument_id = 'payout_instrument_id_example' # String | The unique id of the  Payout Instrument Resource.
+payout_product_resource = Yapstone::PayoutProductResource.new # PayoutProductResource | The Payout Resource to be updated.
+
+begin
+  result = api_instance.update_payout_product(contract_id, payout_instrument_id, payout_product_resource)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PayoutsApi->update_payout_product: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract_id** | **String**| The unique id of the Contract Resource. | 
+ **payout_instrument_id** | **String**| The unique id of the  Payout Instrument Resource. | 
+ **payout_product_resource** | [**PayoutProductResource**](PayoutProductResource.md)| The Payout Resource to be updated. | 
+
+### Return type
+
+[**PayoutProductResource**](PayoutProductResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+