yapstone-so 1.0.0

data/docs/AssetResource.md

@@ -0,0 +1,29 @@
+# Yapstone::AssetResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**owner** | [**IndividualOwnerResource**](IndividualOwnerResource.md) |  | [optional] 
+**type** | **String** | The type of asset [PROPERTY] | 
+**external_id** | **String** | The partners externalId id for the Asset. | [optional] 
+**property** | [**PropertyResource**](PropertyResource.md) |  | 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+**id** | **String** | The resource identifier for the Asset. | [optional] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::AssetResource.new(owner: null,
+                                 type: null,
+                                 external_id: null,
+                                 property: null,
+                                 products: null,
+                                 id: null,
+                                 status: null)
+```
+
+

data/docs/AssetResourceAllOf.md

@@ -0,0 +1,19 @@
+# Yapstone::AssetResourceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The resource identifier for the Asset. | [optional] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::AssetResourceAllOf.new(id: null,
+                                 status: null)
+```
+
+

data/docs/AssetUpdateRequest.md

@@ -0,0 +1,27 @@
+# Yapstone::AssetUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**owner** | [**IndividualOwnerResource**](IndividualOwnerResource.md) |  | [optional] 
+**type** | **String** | The type of asset [PROPERTY] | 
+**external_id** | **String** | The partners externalId id for the Asset. | [optional] 
+**property** | [**PropertyResource**](PropertyResource.md) |  | 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::AssetUpdateRequest.new(owner: null,
+                                 type: null,
+                                 external_id: null,
+                                 property: null,
+                                 status: null,
+                                 products: null)
+```
+
+

data/docs/AssetUpdateRequestAllOf.md

@@ -0,0 +1,19 @@
+# Yapstone::AssetUpdateRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::AssetUpdateRequestAllOf.new(status: null,
+                                 products: null)
+```
+
+

data/docs/AssetsApi.md

@@ -0,0 +1,276 @@
+# Yapstone::AssetsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_asset**](AssetsApi.md#create_asset) | **POST** /assets | 
+[**deactivate_asset**](AssetsApi.md#deactivate_asset) | **DELETE** /assets/{assetId} | 
+[**get_asset**](AssetsApi.md#get_asset) | **GET** /assets/{assetId} | 
+[**get_assets**](AssetsApi.md#get_assets) | **GET** /assets | 
+[**update_asset**](AssetsApi.md#update_asset) | **PUT** /assets/{assetId} | 
+
+
+
+## create_asset
+
+> AssetResource create_asset(asset_request)
+
+
+
+Creates an Asset 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::AssetsApi.new
+asset_request = Yapstone::AssetRequest.new # AssetRequest | The Asset Request Resource to be created.
+
+begin
+  result = api_instance.create_asset(asset_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AssetsApi->create_asset: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_request** | [**AssetRequest**](AssetRequest.md)| The Asset Request Resource to be created. | 
+
+### Return type
+
+[**AssetResource**](AssetResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_asset
+
+> DeactivateResponse deactivate_asset(asset_id)
+
+
+
+Deactivates the Asset 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::AssetsApi.new
+asset_id = 'asset_id_example' # String | The unique id of the Asset Resource.
+
+begin
+  result = api_instance.deactivate_asset(asset_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AssetsApi->deactivate_asset: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The unique id of the Asset Resource. | 
+
+### Return type
+
+[**DeactivateResponse**](DeactivateResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_asset
+
+> AssetResource get_asset(asset_id)
+
+
+
+Retrieves an Asset Resource from the system for the given 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::AssetsApi.new
+asset_id = 'asset_id_example' # String | The unique id of the Asset Resource.
+
+begin
+  result = api_instance.get_asset(asset_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AssetsApi->get_asset: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The unique id of the Asset Resource. | 
+
+### Return type
+
+[**AssetResource**](AssetResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_assets
+
+> AssetsResource get_assets(opts)
+
+
+
+Get Asset 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::AssetsApi.new
+opts = {
+  page: 56, # Integer | page number
+  size: 56, # Integer | Maximum number of records to return per page
+  external_id: 'external_id_example' # String | The identifier used by an external client.
+}
+
+begin
+  result = api_instance.get_assets(opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AssetsApi->get_assets: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| page number | [optional] 
+ **size** | **Integer**| Maximum number of records to return per page | [optional] 
+ **external_id** | **String**| The identifier used by an external client. | [optional] 
+
+### Return type
+
+[**AssetsResource**](AssetsResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_asset
+
+> AssetResource update_asset(asset_id, asset_update_request)
+
+
+
+Updates the Asset 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::AssetsApi.new
+asset_id = 'asset_id_example' # String | The unique id of the Asset Resource.
+asset_update_request = Yapstone::AssetUpdateRequest.new # AssetUpdateRequest | The Asset Request Resource to be created.
+
+begin
+  result = api_instance.update_asset(asset_id, asset_update_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AssetsApi->update_asset: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The unique id of the Asset Resource. | 
+ **asset_update_request** | [**AssetUpdateRequest**](AssetUpdateRequest.md)| The Asset Request Resource to be created. | 
+
+### Return type
+
+[**AssetResource**](AssetResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/AssetsResource.md

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

data/docs/AssetsResourceAllOf.md

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

data/docs/AuthenticationApi.md

@@ -0,0 +1,58 @@
+# Yapstone::AuthenticationApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**authenticate_partner**](AuthenticationApi.md#authenticate_partner) | **POST** /v1/oauth2/client_credential/accesstoken | Authenticate Partner
+
+
+
+## authenticate_partner
+
+> InlineResponse200 authenticate_partner(grant_type, authorization)
+
+Authenticate Partner
+
+Get an access token. It is OAuth2, and you must use the client credentials grant type. The token will allow you to authenticate with the other internal payments API endpoints. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-so'
+
+api_instance = Yapstone::AuthenticationApi.new
+grant_type = 'client_credentials' # String | To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user's resources. 
+authorization = 'Basic SGxkdU5OcU1xMzBUZ0djYUpDWVpIWVRsejJjQUJlSHo6YkdIeWNpWXVibzNVTXZLRA==' # String | Provide client_id:client_secret as base64 encoded basic auth. 
+
+begin
+  #Authenticate Partner
+  result = api_instance.authenticate_partner(grant_type, authorization)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling AuthenticationApi->authenticate_partner: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **grant_type** | **String**| To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user's resources.  | 
+ **authorization** | **String**| Provide client_id:client_secret as base64 encoded basic auth.  | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BankAccountDataResource.md

@@ -0,0 +1,23 @@
+# Yapstone::BankAccountDataResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bank_account_data_token** | **String** | The key to the vault that contains the sensitive bank data. | [optional] 
+**routing_code** | **String** | routing code for USA, bank/branch identification for rest of the world | [optional] 
+**account_number** | **String** | Bank account number. If this is iban, routing code (bank/branch identification code) can be empty | [optional] 
+**display_text** | **String** | The textual description of the account. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BankAccountDataResource.new(bank_account_data_token: null,
+                                 routing_code: null,
+                                 account_number: null,
+                                 display_text: null)
+```
+
+

data/docs/BankAccountResource.md

@@ -0,0 +1,25 @@
+# Yapstone::BankAccountResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of bank account [CHECKING] | 
+**name_on_account** | **String** | The name on the account. | [optional] 
+**currency** | **String** | The ISO currency code enum that the bank account will accept funds as. | 
+**bank_account_data** | [**BankAccountDataResource**](BankAccountDataResource.md) |  | 
+**bank_name** | **String** | The bank name. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BankAccountResource.new(type: null,
+                                 name_on_account: null,
+                                 currency: null,
+                                 bank_account_data: null,
+                                 bank_name: null)
+```
+
+

data/docs/BeneficialOwnerRequest.md

@@ -0,0 +1,27 @@
+# Yapstone::BeneficialOwnerRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The Mktplaces unique identifier for the Beneficial Owner. | [optional] 
+**name** | [**NameResource**](NameResource.md) |  | 
+**address** | [**AddressResource**](AddressResource.md) |  | 
+**email** | **String** | The email address. | 
+**gov_identification** | [**GovIdentificationResource**](GovIdentificationResource.md) |  | [optional] 
+**date_of_birth** | **Date** | The date of birth for the person. | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BeneficialOwnerRequest.new(external_id: null,
+                                 name: null,
+                                 address: null,
+                                 email: null,
+                                 gov_identification: null,
+                                 date_of_birth: null)
+```
+
+

data/docs/BeneficialOwnerResource.md

@@ -0,0 +1,31 @@
+# Yapstone::BeneficialOwnerResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The resource identifier for the Beneficial Owner | [optional] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**external_id** | **String** | The Mktplaces unique identifier for the Beneficial Owner. | [optional] 
+**name** | [**NameResource**](NameResource.md) |  | 
+**address** | [**AddressResource**](AddressResource.md) |  | 
+**email** | **String** | The email address. | 
+**gov_identification** | [**GovIdentificationResource**](GovIdentificationResource.md) |  | [optional] 
+**date_of_birth** | **Date** | The date of birth for the person. | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BeneficialOwnerResource.new(id: null,
+                                 status: null,
+                                 external_id: null,
+                                 name: null,
+                                 address: null,
+                                 email: null,
+                                 gov_identification: null,
+                                 date_of_birth: null)
+```
+
+

data/docs/BeneficialOwnersPatch.md

@@ -0,0 +1,21 @@
+# Yapstone::BeneficialOwnersPatch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**op** | [**PatchOperation**](PatchOperation.md) |  | 
+**beneficial_owner_id** | **String** | The identifier for the entity. | [optional] 
+**beneficial_owner_entity** | [**BeneficialOwnerRequest**](BeneficialOwnerRequest.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BeneficialOwnersPatch.new(op: null,
+                                 beneficial_owner_id: null,
+                                 beneficial_owner_entity: null)
+```
+
+

data/docs/BusinessApplicantAdminFieldsResource.md

@@ -0,0 +1,17 @@
+# Yapstone::BusinessApplicantAdminFieldsResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auto_graduated** | **Boolean** | value for graduation policy | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessApplicantAdminFieldsResource.new(auto_graduated: null)
+```
+
+

data/docs/BusinessApplicantAdminResource.md

@@ -0,0 +1,49 @@
+# Yapstone::BusinessApplicantAdminResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The resource identifier for the applicant. | [optional] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**type** | **String** |  | 
+**external_id** | **String** | The partners externalId id for the Applicant. | [optional] 
+**mkt_place_applicant** | [**MarketPlaceApplicantResource**](MarketPlaceApplicantResource.md) |  | [optional] 
+**social_networks** | [**Array<SocialNetworkResource>**](SocialNetworkResource.md) | A list of social networks the applicant belongs to. | [optional] 
+**language** | **String** | supported language | 
+**brand** | **String** | brand id | 
+**consents** | [**Array<ApplicantConsentResource>**](ApplicantConsentResource.md) |  | [optional] 
+**reporting_tag** | **String** | The reportingTag for the applicant. | [optional] 
+**no_post_booking** | **Boolean** | At the time of creation, value is defaulted to False. | [optional] [default to false]
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+**primary_contact** | [**ProfileResource**](ProfileResource.md) |  | [optional] 
+**business_profile** | [**BusinessProfileResource**](BusinessProfileResource.md) |  | [optional] 
+**principal_owner** | [**BeneficialOwnerResource**](BeneficialOwnerResource.md) |  | [optional] 
+**additional_owners** | [**Array<BeneficialOwnerResource>**](BeneficialOwnerResource.md) | A list of additional beneficial owners | [optional] 
+**auto_graduated** | **Boolean** | value for graduation policy | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessApplicantAdminResource.new(id: null,
+                                 status: null,
+                                 type: null,
+                                 external_id: null,
+                                 mkt_place_applicant: null,
+                                 social_networks: null,
+                                 language: null,
+                                 brand: null,
+                                 consents: null,
+                                 reporting_tag: null,
+                                 no_post_booking: null,
+                                 products: null,
+                                 primary_contact: null,
+                                 business_profile: null,
+                                 principal_owner: null,
+                                 additional_owners: null,
+                                 auto_graduated: null)
+```
+
+