yapstone-so 1.0.0

data/docs/BusinessApplicantRequest.md

@@ -0,0 +1,39 @@
+# Yapstone::BusinessApplicantRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**primary_contact** | [**PrimaryContactResource**](PrimaryContactResource.md) |  | [optional] 
+**business_profile** | [**BusinessProfileResource**](BusinessProfileResource.md) |  | 
+**external_id** | **String** | The partners externalId id for the Business 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** | language used to communicate | [optional] 
+**brand** | **String** | brand id of market place | [optional] 
+**consents** | [**Array<ApplicantConsentRequest>**](ApplicantConsentRequest.md) |  | [optional] 
+**reporting_tag** | **String** | The reportingTag for the applicant. | [optional] 
+**principal_owner** | [**BeneficialOwnerRequest**](BeneficialOwnerRequest.md) |  | [optional] 
+**additional_owners** | [**Array<BeneficialOwnerRequest>**](BeneficialOwnerRequest.md) | A list of additional beneficial owners | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessApplicantRequest.new(primary_contact: null,
+                                 business_profile: null,
+                                 external_id: null,
+                                 mkt_place_applicant: null,
+                                 social_networks: null,
+                                 language: null,
+                                 brand: null,
+                                 consents: null,
+                                 reporting_tag: null,
+                                 principal_owner: null,
+                                 additional_owners: null,
+                                 products: null)
+```
+
+

data/docs/BusinessApplicantResource.md

@@ -0,0 +1,23 @@
+# Yapstone::BusinessApplicantResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessApplicantResource.new(primary_contact: null,
+                                 business_profile: null,
+                                 principal_owner: null,
+                                 additional_owners: null)
+```
+
+

data/docs/BusinessApplicantResourceAllOf.md

@@ -0,0 +1,23 @@
+# Yapstone::BusinessApplicantResourceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessApplicantResourceAllOf.new(primary_contact: null,
+                                 business_profile: null,
+                                 principal_owner: null,
+                                 additional_owners: null)
+```
+
+

data/docs/BusinessApplicantUpdateRequest.md

@@ -0,0 +1,41 @@
+# Yapstone::BusinessApplicantUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**primary_contact** | [**PrimaryContactResource**](PrimaryContactResource.md) |  | [optional] 
+**business_profile** | [**BusinessProfileResource**](BusinessProfileResource.md) |  | 
+**external_id** | **String** | The partners externalId id for the Business 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] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**consents** | [**Array<ApplicantConsentRequest>**](ApplicantConsentRequest.md) |  | [optional] 
+**principal_owner** | [**BeneficialOwnerResource**](BeneficialOwnerResource.md) |  | [optional] 
+**additional_owners_update** | [**Array<BeneficialOwnersPatch>**](BeneficialOwnersPatch.md) | List of edits to beneficial owners of the property. | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+**no_post_booking** | **Boolean** | value can be changed by only internal user. | [optional] 
+**language** | **String** | language used to communicate | [optional] 
+**brand** | **String** | brand id of market place | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessApplicantUpdateRequest.new(primary_contact: null,
+                                 business_profile: null,
+                                 external_id: null,
+                                 mkt_place_applicant: null,
+                                 social_networks: null,
+                                 status: null,
+                                 consents: null,
+                                 principal_owner: null,
+                                 additional_owners_update: null,
+                                 products: null,
+                                 no_post_booking: null,
+                                 language: null,
+                                 brand: null)
+```
+
+

data/docs/BusinessApplicantsApi.md

@@ -0,0 +1,276 @@
+# Yapstone::BusinessApplicantsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_business_applicant**](BusinessApplicantsApi.md#create_business_applicant) | **POST** /business-applicants | 
+[**deactivate_business_applicant**](BusinessApplicantsApi.md#deactivate_business_applicant) | **DELETE** /business-applicants/{applicantId} | 
+[**get_business_applicant**](BusinessApplicantsApi.md#get_business_applicant) | **GET** /business-applicants/{applicantId} | 
+[**get_business_applicants**](BusinessApplicantsApi.md#get_business_applicants) | **GET** /business-applicants | 
+[**update_business_applicant**](BusinessApplicantsApi.md#update_business_applicant) | **PUT** /business-applicants/{applicantId} | 
+
+
+
+## create_business_applicant
+
+> BusinessApplicantResource create_business_applicant(business_applicant_request)
+
+
+
+Creates a Business Applicant 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::BusinessApplicantsApi.new
+business_applicant_request = Yapstone::BusinessApplicantRequest.new # BusinessApplicantRequest | The Business Applicant Resource to be created.
+
+begin
+  result = api_instance.create_business_applicant(business_applicant_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling BusinessApplicantsApi->create_business_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **business_applicant_request** | [**BusinessApplicantRequest**](BusinessApplicantRequest.md)| The Business Applicant Resource to be created. | 
+
+### Return type
+
+[**BusinessApplicantResource**](BusinessApplicantResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_business_applicant
+
+> DeactivateResponse deactivate_business_applicant(applicant_id)
+
+
+
+Deactivates the Business Applicant 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::BusinessApplicantsApi.new
+applicant_id = 'applicant_id_example' # String | The unique id of the Applicant Resource.
+
+begin
+  result = api_instance.deactivate_business_applicant(applicant_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling BusinessApplicantsApi->deactivate_business_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| The unique id of the Applicant Resource. | 
+
+### Return type
+
+[**DeactivateResponse**](DeactivateResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_business_applicant
+
+> BusinessApplicantResource get_business_applicant(applicant_id)
+
+
+
+Retrieves an Business Applicant Resource from the system for the given applicantId.
+
+### 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::BusinessApplicantsApi.new
+applicant_id = 'applicant_id_example' # String | The unique id of the Business Applicant Resource.
+
+begin
+  result = api_instance.get_business_applicant(applicant_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling BusinessApplicantsApi->get_business_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| The unique id of the Business Applicant Resource. | 
+
+### Return type
+
+[**BusinessApplicantResource**](BusinessApplicantResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_business_applicants
+
+> BusinessApplicantsResource get_business_applicants(external_id, opts)
+
+
+
+Get all Business Applicant 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::BusinessApplicantsApi.new
+external_id = 'external_id_example' # String | The identifier used by an external client.
+opts = {
+  page: 56, # Integer | page number
+  size: 56 # Integer | Maximum number of records to return per page
+}
+
+begin
+  result = api_instance.get_business_applicants(external_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling BusinessApplicantsApi->get_business_applicants: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **external_id** | **String**| The identifier used by an external client. | 
+ **page** | **Integer**| page number | [optional] 
+ **size** | **Integer**| Maximum number of records to return per page | [optional] 
+
+### Return type
+
+[**BusinessApplicantsResource**](BusinessApplicantsResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_business_applicant
+
+> BusinessApplicantResource update_business_applicant(applicant_id, business_applicant_update_request)
+
+
+
+Updates the Business Applicant 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::BusinessApplicantsApi.new
+applicant_id = 'applicant_id_example' # String | The unique id of the BusinessApplicant Resource.
+business_applicant_update_request = Yapstone::BusinessApplicantUpdateRequest.new # BusinessApplicantUpdateRequest | The Business Applicant Resource to be created after updation.
+
+begin
+  result = api_instance.update_business_applicant(applicant_id, business_applicant_update_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling BusinessApplicantsApi->update_business_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| The unique id of the BusinessApplicant Resource. | 
+ **business_applicant_update_request** | [**BusinessApplicantUpdateRequest**](BusinessApplicantUpdateRequest.md)| The Business Applicant Resource to be created after updation. | 
+
+### Return type
+
+[**BusinessApplicantResource**](BusinessApplicantResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/BusinessApplicantsResource.md

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

data/docs/BusinessApplicantsResourceAllOf.md

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

data/docs/BusinessIdType.md

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

data/docs/BusinessIdentificationResource.md

@@ -0,0 +1,25 @@
+# Yapstone::BusinessIdentificationResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**BusinessIdType**](BusinessIdType.md) |  | 
+**display_text** | **String** | The display info for the identification. | [optional] 
+**business_id_data_token** | **String** | The key to vault that contains the data associated with the EIN, VAT or CRN id. This key will be generated when the identification is created at YapStone. | [optional] 
+**number** | **String** | The number associated with the identification. | 
+**issuer** | [**IssuerScope**](IssuerScope.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessIdentificationResource.new(type: null,
+                                 display_text: null,
+                                 business_id_data_token: null,
+                                 number: null,
+                                 issuer: null)
+```
+
+

data/docs/BusinessOwnerResource.md

@@ -0,0 +1,17 @@
+# Yapstone::BusinessOwnerResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the business. | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessOwnerResource.new(name: null)
+```
+
+

data/docs/BusinessProfileResource.md

@@ -0,0 +1,33 @@
+# Yapstone::BusinessProfileResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the business. | 
+**type** | **String** | The type of business unit (sole_prop, corp, llc) | [optional] 
+**dba** | **Array<String>** | Doing business as name list. | [optional] 
+**email** | **String** | The email address. | 
+**address** | [**AddressResource**](AddressResource.md) |  | 
+**phone** | [**PhoneResource**](PhoneResource.md) |  | [optional] 
+**business_identification** | [**BusinessIdentificationResource**](BusinessIdentificationResource.md) |  | [optional] 
+**registration** | [**RegistrationResource**](RegistrationResource.md) |  | [optional] 
+**website_url** | **String** | The website hostname. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessProfileResource.new(name: null,
+                                 type: null,
+                                 dba: null,
+                                 email: null,
+                                 address: null,
+                                 phone: null,
+                                 business_identification: null,
+                                 registration: null,
+                                 website_url: null)
+```
+
+

data/docs/BusinessUpdateIdentificationResource.md

@@ -0,0 +1,25 @@
+# Yapstone::BusinessUpdateIdentificationResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**BusinessIdType**](BusinessIdType.md) |  | [optional] 
+**display_text** | **String** | The display info for the identification. | [optional] 
+**business_id_data_token** | **String** | The key to vault that contains the data associated with the EIN, VAT or CRN id. This key will be generated when the identification is created at YapStone. | [optional] 
+**number** | **String** | The number associated with the identification. | [optional] 
+**issuer** | [**IssuerScope**](IssuerScope.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::BusinessUpdateIdentificationResource.new(type: null,
+                                 display_text: null,
+                                 business_id_data_token: null,
+                                 number: null,
+                                 issuer: null)
+```
+
+

data/docs/CapabilityResource.md

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

data/docs/CardDataResource.md

@@ -0,0 +1,35 @@
+# Yapstone::CardDataResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_type** | **String** | Type of the card ( DEBIT, CREDIT) | [optional] 
+**brand** | **String** | Issuing authority | [optional] 
+**card_token_source** | **String** |  | [optional] 
+**expiration_date** | [**ExpirationDateResource**](ExpirationDateResource.md) |  | [optional] 
+**billing_address** | [**AddressResource**](AddressResource.md) |  | [optional] 
+**card_holder_name** | **String** | Name on the card | [optional] 
+**card_token_data** | **String** | The token to get the card details from vault. | [optional] 
+**card_number** | **String** | The card number. | [optional] 
+**cvv** | **String** | CVV number. | [optional] 
+**currency** | **String** | Currency. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::CardDataResource.new(card_type: null,
+                                 brand: null,
+                                 card_token_source: null,
+                                 expiration_date: null,
+                                 billing_address: null,
+                                 card_holder_name: null,
+                                 card_token_data: null,
+                                 card_number: null,
+                                 cvv: null,
+                                 currency: null)
+```
+
+

data/docs/Consent.md

@@ -0,0 +1,25 @@
+# Yapstone::Consent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Type of the consent | 
+**accepted** | **Boolean** | Indicates the acceptance of the T&Cs. | 
+**time_of_consent** | **DateTime** | Time of the consent | 
+**version** | **Integer** | Version of the consent | 
+**ip_address** | **String** | IP Address of machine from which consent was given | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Consent.new(type: null,
+                                 accepted: null,
+                                 time_of_consent: null,
+                                 version: null,
+                                 ip_address: null)
+```
+
+

data/docs/ConsentRequest.md

@@ -0,0 +1,25 @@
+# Yapstone::ConsentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | 
+**type** | [**ConsentType**](ConsentType.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ConsentRequest.new(version: null,
+                                 accepted: null,
+                                 ip_address: null,
+                                 device_fingerprint_id: null,
+                                 type: null)
+```
+
+