yapstone-so 1.0.0

data/docs/InstrumentsApi.md

@@ -0,0 +1,274 @@
+# Yapstone::InstrumentsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_instrument**](InstrumentsApi.md#create_instrument) | **POST** /instruments | 
+[**deactivate_instrument**](InstrumentsApi.md#deactivate_instrument) | **DELETE** /instruments/{instrumentId} | 
+[**get_instrument**](InstrumentsApi.md#get_instrument) | **GET** /instruments/{instrumentId} | 
+[**get_instruments**](InstrumentsApi.md#get_instruments) | **GET** /instruments | 
+[**update_instrument**](InstrumentsApi.md#update_instrument) | **PUT** /instruments/{instrumentId} | 
+
+
+
+## create_instrument
+
+> PayoutInstrumentResource create_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::InstrumentsApi.new
+payout_instrument_request = Yapstone::PayoutInstrumentRequest.new # PayoutInstrumentRequest | The Payout Instrument Request Resource to be created.
+
+begin
+  result = api_instance.create_instrument(payout_instrument_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling InstrumentsApi->create_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_instrument
+
+> DeactivateResponse deactivate_instrument(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::InstrumentsApi.new
+instrument_id = 'instrument_id_example' # String | The unique id of the Instrument Resource.
+
+begin
+  result = api_instance.deactivate_instrument(instrument_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling InstrumentsApi->deactivate_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **instrument_id** | **String**| The unique id of the Instrument Resource. | 
+
+### Return type
+
+[**DeactivateResponse**](DeactivateResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_instrument
+
+> PayoutInstrumentResource get_instrument(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::InstrumentsApi.new
+instrument_id = 'instrument_id_example' # String | The unique id of the Instrument Resource.
+
+begin
+  result = api_instance.get_instrument(instrument_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling InstrumentsApi->get_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **instrument_id** | **String**| The unique id of the Instrument Resource. | 
+
+### Return type
+
+[**PayoutInstrumentResource**](PayoutInstrumentResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_instruments
+
+> PayoutInstrumentsResource get_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::InstrumentsApi.new
+opts = {
+  page: 56, # Integer | page number
+  size: 56 # Integer | Maximum number of records to return per page
+}
+
+begin
+  result = api_instance.get_instruments(opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling InstrumentsApi->get_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_instrument
+
+> PayoutInstrumentResource update_instrument(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::InstrumentsApi.new
+instrument_id = 'instrument_id_example' # String | The unique id of the Instrument Resource.
+payout_instrument_update_request = Yapstone::PayoutInstrumentUpdateRequest.new # PayoutInstrumentUpdateRequest | The PayoutInstrument Request Resource to be updated.
+
+begin
+  result = api_instance.update_instrument(instrument_id, payout_instrument_update_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling InstrumentsApi->update_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **instrument_id** | **String**| The unique id of the 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/IssuerScope.md

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

data/docs/MarketPlaceApplicantResource.md

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

data/docs/MarketPlacePropertyResource.md

@@ -0,0 +1,27 @@
+# Yapstone::MarketPlacePropertyResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**score** | **Float** | The marketplace score property. | [optional] 
+**reservation_setting** | [**ReservationSettingResource**](ReservationSettingResource.md) |  | [optional] 
+**check_in** | **String** | The checkin time. | [optional] 
+**check_out** | **String** | The checkout time. | [optional] 
+**cancellation_policy** | **String** | The cancellation policy for the property. | [optional] 
+**property_tracker** | [**PropertyTrackerResource**](PropertyTrackerResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketPlacePropertyResource.new(score: null,
+                                 reservation_setting: null,
+                                 check_in: null,
+                                 check_out: null,
+                                 cancellation_policy: null,
+                                 property_tracker: null)
+```
+
+

data/docs/MarketplaceProductAdd.md

@@ -0,0 +1,27 @@
+# Yapstone::MarketplaceProductAdd
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consents** | [**Array<ConsentRequest>**](ConsentRequest.md) | An array of consents. | [optional] 
+**asset_id** | **String** | The unique id of the Asset Resource. | [optional] 
+**payout_mode** | **String** | The type of Payout Mode | [optional] 
+**settlement_currency** | **String** | The ISO currency code enum for settlements. | [optional] 
+**subscription_type** | **String** | Subscription Type | [optional] 
+**payout_instruments** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductAdd.new(consents: null,
+                                 asset_id: null,
+                                 payout_mode: null,
+                                 settlement_currency: null,
+                                 subscription_type: null,
+                                 payout_instruments: null)
+```
+
+

data/docs/MarketplaceProductBasic.md

@@ -0,0 +1,23 @@
+# Yapstone::MarketplaceProductBasic
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_id** | **String** | The unique id of the Asset Resource. | [optional] 
+**payout_mode** | **String** | The type of Payout Mode | [optional] 
+**settlement_currency** | **String** | The ISO currency code enum for settlements. | [optional] 
+**subscription_type** | **String** | Subscription Type | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductBasic.new(asset_id: null,
+                                 payout_mode: null,
+                                 settlement_currency: null,
+                                 subscription_type: null)
+```
+
+

data/docs/MarketplaceProductExtra.md

@@ -0,0 +1,33 @@
+# Yapstone::MarketplaceProductExtra
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_id** | **String** | The unique id of the Asset Resource. | [optional] 
+**payout_mode** | **String** | The type of Payout Mode | [optional] 
+**settlement_currency** | **String** | The ISO currency code enum for settlements. | [optional] 
+**subscription_type** | **String** | Subscription Type | [optional] 
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**charges_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**refund_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**token_for_processing** | **String** | The token to use when making payments. | [optional] 
+**payment_platform** | **String** | The platform to initiate payments on. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductExtra.new(asset_id: null,
+                                 payout_mode: null,
+                                 settlement_currency: null,
+                                 subscription_type: null,
+                                 status: null,
+                                 charges_status: null,
+                                 refund_status: null,
+                                 token_for_processing: null,
+                                 payment_platform: null)
+```
+
+

data/docs/MarketplaceProductExtraAllOf.md

@@ -0,0 +1,25 @@
+# Yapstone::MarketplaceProductExtraAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**charges_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**refund_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**token_for_processing** | **String** | The token to use when making payments. | [optional] 
+**payment_platform** | **String** | The platform to initiate payments on. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductExtraAllOf.new(status: null,
+                                 charges_status: null,
+                                 refund_status: null,
+                                 token_for_processing: null,
+                                 payment_platform: null)
+```
+
+

data/docs/MarketplaceProductPayoutInstrumentResource.md

@@ -0,0 +1,19 @@
+# Yapstone::MarketplaceProductPayoutInstrumentResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | payout instrument id | 
+**payout_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductPayoutInstrumentResource.new(id: null,
+                                 payout_status: null)
+```
+
+

data/docs/MarketplaceProductPayoutInstrumentUpdate.md

@@ -0,0 +1,21 @@
+# Yapstone::MarketplaceProductPayoutInstrumentUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | payout instrument id | 
+**payout_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | 
+**op** | [**PatchOperation**](PatchOperation.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductPayoutInstrumentUpdate.new(id: null,
+                                 payout_status: null,
+                                 op: null)
+```
+
+

data/docs/MarketplaceProductResource.md

@@ -0,0 +1,39 @@
+# Yapstone::MarketplaceProductResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique id of the resource | [optional] 
+**consents** | [**Array<ConsentResource>**](ConsentResource.md) | An array of consents. | [optional] 
+**asset_id** | **String** | The unique id of the Asset Resource. | [optional] 
+**payout_mode** | **String** | The type of Payout Mode | [optional] 
+**settlement_currency** | **String** | The ISO currency code enum for settlements. | [optional] 
+**subscription_type** | **String** | Subscription Type | [optional] 
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**charges_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**refund_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**token_for_processing** | **String** | The token to use when making payments. | [optional] 
+**payment_platform** | **String** | The platform to initiate payments on. | [optional] 
+**payout_instruments** | [**Array<MarketplaceProductPayoutInstrumentResource>**](MarketplaceProductPayoutInstrumentResource.md) | An array of payout instruments. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductResource.new(id: null,
+                                 consents: null,
+                                 asset_id: null,
+                                 payout_mode: null,
+                                 settlement_currency: null,
+                                 subscription_type: null,
+                                 status: null,
+                                 charges_status: null,
+                                 refund_status: null,
+                                 token_for_processing: null,
+                                 payment_platform: null,
+                                 payout_instruments: null)
+```
+
+

data/docs/MarketplaceProductSubResource.md

@@ -0,0 +1,37 @@
+# Yapstone::MarketplaceProductSubResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consents** | [**Array<ConsentResource>**](ConsentResource.md) | An array of consents. | [optional] 
+**asset_id** | **String** | The unique id of the Asset Resource. | [optional] 
+**payout_mode** | **String** | The type of Payout Mode | [optional] 
+**settlement_currency** | **String** | The ISO currency code enum for settlements. | [optional] 
+**subscription_type** | **String** | Subscription Type | [optional] 
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**charges_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**refund_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**token_for_processing** | **String** | The token to use when making payments. | [optional] 
+**payment_platform** | **String** | The platform to initiate payments on. | [optional] 
+**payout_instruments** | [**Array<MarketplaceProductPayoutInstrumentResource>**](MarketplaceProductPayoutInstrumentResource.md) | An array of payout instruments. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductSubResource.new(consents: null,
+                                 asset_id: null,
+                                 payout_mode: null,
+                                 settlement_currency: null,
+                                 subscription_type: null,
+                                 status: null,
+                                 charges_status: null,
+                                 refund_status: null,
+                                 token_for_processing: null,
+                                 payment_platform: null,
+                                 payout_instruments: null)
+```
+
+

data/docs/MarketplaceProductUpdate.md

@@ -0,0 +1,37 @@
+# Yapstone::MarketplaceProductUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consents** | [**Array<ConsentRequest>**](ConsentRequest.md) | An array of consents. | [optional] 
+**asset_id** | **String** | The unique id of the Asset Resource. | [optional] 
+**payout_mode** | **String** | The type of Payout Mode | [optional] 
+**settlement_currency** | **String** | The ISO currency code enum for settlements. | [optional] 
+**subscription_type** | **String** | Subscription Type | [optional] 
+**status** | [**StatusReasonResource**](StatusReasonResource.md) |  | [optional] 
+**charges_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**refund_status** | [**ActionStatusResource**](ActionStatusResource.md) |  | [optional] 
+**token_for_processing** | **String** | The token to use when making payments. | [optional] 
+**payment_platform** | **String** | The platform to initiate payments on. | [optional] 
+**payout_instruments** | [**Array<MarketplaceProductPayoutInstrumentUpdate>**](MarketplaceProductPayoutInstrumentUpdate.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::MarketplaceProductUpdate.new(consents: null,
+                                 asset_id: null,
+                                 payout_mode: null,
+                                 settlement_currency: null,
+                                 subscription_type: null,
+                                 status: null,
+                                 charges_status: null,
+                                 refund_status: null,
+                                 token_for_processing: null,
+                                 payment_platform: null,
+                                 payout_instruments: null)
+```
+
+