DealMakerAPI 0.90.1 → 0.90.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eef65ab76c842d742b22d68316eb7bdc4f4547fd72203625cc9f65cbeb8979f8
-  data.tar.gz: 77067db4f04aa8e132c969c35b1155d17d22dc1617107a7b323b7b1222c48783
+  metadata.gz: 9041f06159eb8dce5aae3546e566dbb787657a3238b6bba9aa7f0f3c7f474316
+  data.tar.gz: 61b1c3be94cc830714b306f94fab1abd0b118b8febc17671f185bed80cf04f89
 SHA512:
-  metadata.gz: 6479f29c9548a1f6af6a1cafdca443d3448aee1f3f4b7606b5255d211684a06c8b66f4d6a5674ceb65337af3942fa3efbfc798762a0a4f28a131f5d574f4641f
-  data.tar.gz: 6c26dcc0eef7ec93d086fc1ca90f9c98bd21e7c76d29d78417b607f5efa112d9cf0be50e53593235a01baff820c1de8b5e68f12d6b39eae80fd6a6dfe6f258ce
+  metadata.gz: 981e96bb8b6a9aabeb6a5a4971b8750f1382ccc575f92af359c2edcfd99a262bf976e680678ea7cf96436a2225d69de170b95ae18bfc0acc5db7da88ca2a94cc
+  data.tar.gz: b2d26e7df3942e216b6f8097ec00df9ab8b65430090e787761325898fd83d73a19286ee5d30893f3a98e33c18bdf2c480207c8d7e803a0188c8eb5f31a468b8f

data/README.md

@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.75.0
-- Package version: 0.90.1
+- Package version: 0.90.3
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.90.1.gem
+gem install ./DealMakerAPI-0.90.3.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.90.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.90.3.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'DealMakerAPI', '~> 0.90.1'
+    gem 'DealMakerAPI', '~> 0.90.3'
 
 ### Install from Git
 
@@ -421,12 +421,14 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
 *DealMakerAPI::CompanyApi* | [**get_details_errors_grouped**](docs/CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status
 *DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
+*DealMakerAPI::CompanyApi* | [**get_user_accessible_companies**](docs/CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user
 *DealMakerAPI::CompanyApi* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
 *DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
 *DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
 *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
 *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
 *DealMakerAPI::DealsApi* | [**put_deals_id_script_tag_environment**](docs/DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal.
+*DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage
 *DealMakerAPI::DefaultApi* | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal
 *DealMakerAPI::DefaultApi* | [**get_deals_id_investors_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal
 *DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
@@ -446,6 +448,7 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
 *DealMakerAPI::InvestorApi* | [**edit_investor_tags**](docs/InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor
 *DealMakerAPI::InvestorApi* | [**get_enforcements**](docs/InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search
+*DealMakerAPI::InvestorApi* | [**get_incentive_plan**](docs/InvestorApi.md#get_incentive_plan) | **GET** /deals/{id}/investors/{investor_id}/incentive_plan | Get investor incentive plan by investor id
 *DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
 *DealMakerAPI::InvestorApi* | [**get_investor_otp_link**](docs/InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor
 *DealMakerAPI::InvestorApi* | [**list_investors**](docs/InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors
@@ -466,6 +469,8 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
 *DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
 *DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
+*DealMakerAPI::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID
+*DealMakerAPI::UserApi* | [**update_user_password**](docs/UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password
 *DealMakerAPI::UsersApi* | [**get_users_investments**](docs/UsersApi.md#get_users_investments) | **GET** /users/investments | Gets the investments for a specific user.
 
 
@@ -500,6 +505,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
  - [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
+ - [DealMakerAPI::UpdateUserPasswordRequest](docs/UpdateUserPasswordRequest.md)
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -527,7 +533,10 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
  - [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
  - [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
+ - [DealMakerAPI::V1EntitiesInvestorIncentivePlan](docs/V1EntitiesInvestorIncentivePlan.md)
+ - [DealMakerAPI::V1EntitiesInvestorIncentiveTier](docs/V1EntitiesInvestorIncentiveTier.md)
  - [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
+ - [DealMakerAPI::V1EntitiesInvestorPriceDetails](docs/V1EntitiesInvestorPriceDetails.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileCorporation](docs/V1EntitiesInvestorProfileCorporation.md)
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsAccountHolder](docs/V1EntitiesInvestorProfileFieldsAccountHolder.md)
@@ -545,6 +554,8 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
  - [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
+ - [DealMakerAPI::V1EntitiesMoneyEntity](docs/V1EntitiesMoneyEntity.md)
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult](docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
  - [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
@@ -553,6 +564,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesShareholdersTags](docs/V1EntitiesShareholdersTags.md)
  - [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
  - [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
+ - [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
  - [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
  - [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
  - [DealMakerAPI::V1EntitiesWebhooksSubscription](docs/V1EntitiesWebhooksSubscription.md)

data/docs/CompanyApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
 | [**get_details_errors_grouped**](CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status |
 | [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
+| [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
 | [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
 
 
@@ -782,6 +783,78 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_user_accessible_companies
+
+> <V1EntitiesCompany> get_user_accessible_companies(opts)
+
+Get list of all Companies accessible by the user
+
+Get user accessible companies
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+opts = {
+  page: 56, # Integer | Page offset to fetch.
+  per_page: 56, # Integer | Number of results to return per page.
+  offset: 56 # Integer | Pad a number of results.
+}
+
+begin
+  # Get list of all Companies accessible by the user
+  result = api_instance.get_user_accessible_companies(opts)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_user_accessible_companies: #{e}"
+end
+```
+
+#### Using the get_user_accessible_companies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesCompany>, Integer, Hash)> get_user_accessible_companies_with_http_info(opts)
+
+```ruby
+begin
+  # Get list of all Companies accessible by the user
+  data, status_code, headers = api_instance.get_user_accessible_companies_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesCompany>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_user_accessible_companies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
+| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
+| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
+
+### Return type
+
+[**V1EntitiesCompany**](V1EntitiesCompany.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## send_portal_invite
 
 > send_portal_invite(id, shareholder_id, opts)

data/docs/DefaultApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage |
 | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal |
 | [**get_deals_id_investors_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal |
 | [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
@@ -17,6 +18,72 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**put_webhooks_id**](DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals |
 
 
+## get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data
+
+> <V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData> get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id)
+
+Load data for the digital payments connection stage
+
+Load data for the digital payments connection stage
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+deal_id = 56 # Integer | 
+
+begin
+  # Load data for the digital payments connection stage
+  result = api_instance.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data: #{e}"
+end
+```
+
+#### Using the get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData>, Integer, Hash)> get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id)
+
+```ruby
+begin
+  # Load data for the digital payments connection stage
+  data, status_code, headers = api_instance.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deal_id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData**](V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_deals_id_investors_investor_id_payments_express_wire_instructions
 
 > <V1EntitiesExpressWireInstruction> get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id)

data/docs/InvestorApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
 | [**edit_investor_tags**](InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor |
 | [**get_enforcements**](InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search |
+| [**get_incentive_plan**](InvestorApi.md#get_incentive_plan) | **GET** /deals/{id}/investors/{investor_id}/incentive_plan | Get investor incentive plan by investor id |
 | [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
 | [**get_investor_otp_link**](InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor |
 | [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
@@ -572,6 +573,74 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_incentive_plan
+
+> <V1EntitiesInvestorPriceDetails> get_incentive_plan(id, investor_id)
+
+Get investor incentive plan by investor id
+
+Gets a single investor incentive plan by the investor id.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::InvestorApi.new
+id = 56 # Integer | The deal id.
+investor_id = 56 # Integer | The investor id.
+
+begin
+  # Get investor incentive plan by investor id
+  result = api_instance.get_incentive_plan(id, investor_id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling InvestorApi->get_incentive_plan: #{e}"
+end
+```
+
+#### Using the get_incentive_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesInvestorPriceDetails>, Integer, Hash)> get_incentive_plan_with_http_info(id, investor_id)
+
+```ruby
+begin
+  # Get investor incentive plan by investor id
+  data, status_code, headers = api_instance.get_incentive_plan_with_http_info(id, investor_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesInvestorPriceDetails>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling InvestorApi->get_incentive_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **investor_id** | **Integer** | The investor id. |  |
+
+### Return type
+
+[**V1EntitiesInvestorPriceDetails**](V1EntitiesInvestorPriceDetails.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_investor
 
 > <V1EntitiesInvestor> get_investor(id, investor_id)

data/docs/UpdateUserPasswordRequest.md

@@ -0,0 +1,18 @@
+# DealMakerAPI::UpdateUserPasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **password** | **String** | The user password. |  |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::UpdateUserPasswordRequest.new(
+  password: null
+)
+```
+

data/docs/UserApi.md

@@ -0,0 +1,143 @@
+# DealMakerAPI::UserApi
+
+All URIs are relative to *http://api.dealmaker.tech*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_user**](UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID |
+| [**update_user_password**](UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password |
+
+
+## get_user
+
+> <V1EntitiesUser> get_user(id)
+
+Get user by User ID
+
+Get a single user using the User ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+
+begin
+  # Get user by User ID
+  result = api_instance.get_user(id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->get_user: #{e}"
+end
+```
+
+#### Using the get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUser>, Integer, Hash)> get_user_with_http_info(id)
+
+```ruby
+begin
+  # Get user by User ID
+  data, status_code, headers = api_instance.get_user_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUser>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesUser**](V1EntitiesUser.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_user_password
+
+> <V1EntitiesUser> update_user_password(id, update_user_password_request)
+
+Update user password
+
+Update user password
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+update_user_password_request = DealMakerAPI::UpdateUserPasswordRequest.new({password: 'password_example'}) # UpdateUserPasswordRequest | 
+
+begin
+  # Update user password
+  result = api_instance.update_user_password(id, update_user_password_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->update_user_password: #{e}"
+end
+```
+
+#### Using the update_user_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUser>, Integer, Hash)> update_user_password_with_http_info(id, update_user_password_request)
+
+```ruby
+begin
+  # Update user password
+  data, status_code, headers = api_instance.update_user_password_with_http_info(id, update_user_password_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUser>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->update_user_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **update_user_password_request** | [**UpdateUserPasswordRequest**](UpdateUserPasswordRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesUser**](V1EntitiesUser.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/V1EntitiesInvestor.md

@@ -30,7 +30,7 @@
 | **ranking_score** | **Float** | A value `[0, 1]` that represents the propensity for the investor to complete payment for the investment. A larger value indicates a higher likelihood of payment, as predicted by DealMaker’s machine learning algorithm. This field will only populate if DealMaker Compass is enabled for a deal and the investor `funds_state` value is not `funded` or `overfunded` | [optional] |
 | **investor_profile** | **String** |  | [optional] |
 | **investor_profile_id** | **Integer** | The investor profile id. | [optional] |
-| **checkout_state** | **String** | Current state on checkout page. | [optional] |
+| **checkout_state** | **String** | Current state on the checkout page. | [optional] |
 | **legacy_flow_link** | **String** | The legacy link for the investor. If the investor is already on the legacy flow, this link will be null. | [optional] |
 
 ## Example

data/docs/V1EntitiesInvestorIncentivePlan.md

@@ -0,0 +1,30 @@
+# DealMakerAPI::V1EntitiesInvestorIncentivePlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The incentive plan id. | [optional] |
+| **deal_id** | **Integer** | The deal id. | [optional] |
+| **plan_type** | **String** | The incentive plan type. | [optional] |
+| **funded_by_offset** | **Integer** | The incentive plan funded by offset. | [optional] |
+| **active_at** | **Time** | The incentive plan active date. | [optional] |
+| **created_at** | **Time** | The creation time. | [optional] |
+| **updated_at** | **Time** | The last update time. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesInvestorIncentivePlan.new(
+  id: null,
+  deal_id: null,
+  plan_type: null,
+  funded_by_offset: null,
+  active_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/V1EntitiesInvestorIncentiveTier.md

@@ -0,0 +1,26 @@
+# DealMakerAPI::V1EntitiesInvestorIncentiveTier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The incentive tier id. | [optional] |
+| **incentive_percentage** | **Float** | The incentive tier percentage. | [optional] |
+| **end_at** | **Time** | The incentive tier end date. | [optional] |
+| **created_at** | **Time** | The creation time. | [optional] |
+| **updated_at** | **Time** | The last update time. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesInvestorIncentiveTier.new(
+  id: null,
+  incentive_percentage: null,
+  end_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/V1EntitiesInvestorPriceDetails.md

@@ -0,0 +1,24 @@
+# DealMakerAPI::V1EntitiesInvestorPriceDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_price** | [**V1EntitiesMoneyEntity**](V1EntitiesMoneyEntity.md) |  | [optional] |
+| **final_price** | [**V1EntitiesMoneyEntity**](V1EntitiesMoneyEntity.md) |  | [optional] |
+| **effective_tier** | [**V1EntitiesInvestorIncentiveTier**](V1EntitiesInvestorIncentiveTier.md) |  | [optional] |
+| **incentive_plan** | [**V1EntitiesInvestorIncentivePlan**](V1EntitiesInvestorIncentivePlan.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesInvestorPriceDetails.new(
+  full_price: null,
+  final_price: null,
+  effective_tier: null,
+  incentive_plan: null
+)
+```
+

data/docs/V1EntitiesMoneyEntity.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::V1EntitiesMoneyEntity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | The amount of money. | [optional] |
+| **currency** | **String** | The currency of the money. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesMoneyEntity.new(
+  amount: null,
+  currency: null
+)
+```
+

data/docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md

@@ -0,0 +1,18 @@
+# DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connect_account_link** | **String** | A link to complete the setup for a Stripe connect account | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.new(
+  connect_account_link: null
+)
+```
+