yapstone-so 1.0.0

data/docs/GovIdentificationResource.md

@@ -0,0 +1,29 @@
+# Yapstone::GovIdentificationResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**GovernmentIdType**](GovernmentIdType.md) |  | 
+**display_text** | **String** | The display info for the identification. | [optional] 
+**gov_id_data_token** | **String** | The key to vault that contains the data associated with the government id. This key will be generated when the identification is created at YapStone. | [optional] 
+**number** | **String** | The number associated with the identification. | 
+**expiration** | **Date** | The expiration date of the identication. | [optional] 
+**country** | **String** | The 3-letter ISO country code of the identification issuer. | [optional] 
+**state** | **String** | The state or province of the identification issuer. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::GovIdentificationResource.new(type: null,
+                                 display_text: null,
+                                 gov_id_data_token: null,
+                                 number: null,
+                                 expiration: null,
+                                 country: null,
+                                 state: null)
+```
+
+

data/docs/GovIdentificationUpdateResource.md

@@ -0,0 +1,29 @@
+# Yapstone::GovIdentificationUpdateResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**GovernmentIdType**](GovernmentIdType.md) |  | [optional] 
+**display_text** | **String** | The display info for the identification. | [optional] 
+**gov_id_data_token** | **String** | The key to vault that contains the data associated with the government id. This key will be generated when the identification is created at YapStone. | [optional] 
+**number** | **String** | The number associated with the identification. | [optional] 
+**expiration** | **Date** | The expiration date of the identication. | [optional] 
+**country** | **String** | The 3-letter ISO country code of the identification issuer. | [optional] 
+**state** | **String** | The state or province of the identification issuer. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::GovIdentificationUpdateResource.new(type: null,
+                                 display_text: null,
+                                 gov_id_data_token: null,
+                                 number: null,
+                                 expiration: null,
+                                 country: null,
+                                 state: null)
+```
+
+

data/docs/GovernmentIdType.md

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

data/docs/IndividualApplicantAdminFieldsResource.md

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

data/docs/IndividualApplicantAdminResource.md

@@ -0,0 +1,43 @@
+# Yapstone::IndividualApplicantAdminResource
+
+## 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] 
+**individual_profile** | [**ProfileResource**](ProfileResource.md) |  | [optional] 
+**auto_graduated** | **Boolean** | value for graduation policy | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::IndividualApplicantAdminResource.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,
+                                 individual_profile: null,
+                                 auto_graduated: null)
+```
+
+

data/docs/IndividualApplicantRequest.md

@@ -0,0 +1,33 @@
+# Yapstone::IndividualApplicantRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for the Applicant. | [optional] 
+**individual_profile** | [**ProfileResource**](ProfileResource.md) |  | 
+**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] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::IndividualApplicantRequest.new(external_id: null,
+                                 individual_profile: null,
+                                 mkt_place_applicant: null,
+                                 social_networks: null,
+                                 language: null,
+                                 brand: null,
+                                 consents: null,
+                                 reporting_tag: null,
+                                 products: null)
+```
+
+

data/docs/IndividualApplicantResource.md

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

data/docs/IndividualApplicantUpdateRequest.md

@@ -0,0 +1,35 @@
+# Yapstone::IndividualApplicantUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | The partners externalId id for the Applicant. | [optional] 
+**individual_profile** | [**ProfileResource**](ProfileResource.md) |  | 
+**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] 
+**status** | [**EntityProductStatusResource**](EntityProductStatusResource.md) |  | [optional] 
+**consents** | [**Array<ApplicantConsentRequest>**](ApplicantConsentRequest.md) |  | [optional] 
+**products** | [**Array<Product>**](Product.md) | Products requested by marketplace. | [optional] 
+**no_post_booking** | **Boolean** | value can be changed by only internal user. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::IndividualApplicantUpdateRequest.new(external_id: null,
+                                 individual_profile: null,
+                                 mkt_place_applicant: null,
+                                 social_networks: null,
+                                 language: null,
+                                 brand: null,
+                                 status: null,
+                                 consents: null,
+                                 products: null,
+                                 no_post_booking: null)
+```
+
+

data/docs/IndividualApplicantsApi.md

@@ -0,0 +1,276 @@
+# Yapstone::IndividualApplicantsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com/v2/onboarding*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_individual_applicant**](IndividualApplicantsApi.md#create_individual_applicant) | **POST** /individual-applicants | 
+[**deactivate_applicant**](IndividualApplicantsApi.md#deactivate_applicant) | **DELETE** /individual-applicants/{applicantId} | 
+[**get_individual_applicant**](IndividualApplicantsApi.md#get_individual_applicant) | **GET** /individual-applicants/{applicantId} | 
+[**get_individual_applicants**](IndividualApplicantsApi.md#get_individual_applicants) | **GET** /individual-applicants | 
+[**update_individual_applicant**](IndividualApplicantsApi.md#update_individual_applicant) | **PUT** /individual-applicants/{applicantId} | 
+
+
+
+## create_individual_applicant
+
+> IndividualApplicantResource create_individual_applicant(individual_applicant_request)
+
+
+
+Creates an 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::IndividualApplicantsApi.new
+individual_applicant_request = Yapstone::IndividualApplicantRequest.new # IndividualApplicantRequest | The Applicant Resource to be created.
+
+begin
+  result = api_instance.create_individual_applicant(individual_applicant_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling IndividualApplicantsApi->create_individual_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **individual_applicant_request** | [**IndividualApplicantRequest**](IndividualApplicantRequest.md)| The Applicant Resource to be created. | 
+
+### Return type
+
+[**IndividualApplicantResource**](IndividualApplicantResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_applicant
+
+> DeactivateResponse deactivate_applicant(applicant_id)
+
+
+
+Deactivates the Individual 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::IndividualApplicantsApi.new
+applicant_id = 'applicant_id_example' # String | The unique id of the Individual Applicant Resource.
+
+begin
+  result = api_instance.deactivate_applicant(applicant_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling IndividualApplicantsApi->deactivate_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| The unique id of the Individual Applicant Resource. | 
+
+### Return type
+
+[**DeactivateResponse**](DeactivateResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_individual_applicant
+
+> IndividualApplicantResource get_individual_applicant(applicant_id)
+
+
+
+Retrieves an Individual 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::IndividualApplicantsApi.new
+applicant_id = 'applicant_id_example' # String | The unique id of the Individual Applicant Resource.
+
+begin
+  result = api_instance.get_individual_applicant(applicant_id)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling IndividualApplicantsApi->get_individual_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| The unique id of the Individual Applicant Resource. | 
+
+### Return type
+
+[**IndividualApplicantResource**](IndividualApplicantResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_individual_applicants
+
+> IndividualApplicantsResource get_individual_applicants(external_id, opts)
+
+
+
+Get all Individual 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::IndividualApplicantsApi.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_individual_applicants(external_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling IndividualApplicantsApi->get_individual_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
+
+[**IndividualApplicantsResource**](IndividualApplicantsResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_individual_applicant
+
+> IndividualApplicantResource update_individual_applicant(applicant_id, individual_applicant_update_request)
+
+
+
+Updates the Individual 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::IndividualApplicantsApi.new
+applicant_id = 'applicant_id_example' # String | The unique id of the Individual Applicant Resource.
+individual_applicant_update_request = Yapstone::IndividualApplicantUpdateRequest.new # IndividualApplicantUpdateRequest | The Applicant Request Resource to be updated.
+
+begin
+  result = api_instance.update_individual_applicant(applicant_id, individual_applicant_update_request)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling IndividualApplicantsApi->update_individual_applicant: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **applicant_id** | **String**| The unique id of the Individual Applicant Resource. | 
+ **individual_applicant_update_request** | [**IndividualApplicantUpdateRequest**](IndividualApplicantUpdateRequest.md)| The Applicant Request Resource to be updated. | 
+
+### Return type
+
+[**IndividualApplicantResource**](IndividualApplicantResource.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json
+- **Accept**: application/json
+

data/docs/IndividualApplicantsResource.md

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

data/docs/IndividualApplicantsResourceAllOf.md

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

data/docs/IndividualOwnerResource.md

@@ -0,0 +1,19 @@
+# Yapstone::IndividualOwnerResource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first** | **String** | The persons first name. | 
+**last** | **String** | The persons last name. | 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::IndividualOwnerResource.new(first: null,
+                                 last: null)
+```
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,25 @@
+# Yapstone::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**issued_at** | **String** |  | [optional] 
+**access_token** | **String** |  | [optional] 
+**scope** | **String** |  | [optional] 
+**expires_in** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::InlineResponse200.new(issued_at: 1552575073094,
+                                 access_token: null,
+                                 scope: marketplace,
+                                 expires_in: 3599,
+                                 status: approved)
+```
+
+