DealMakerAPI 0.104.1 → 0.104.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c1de153c793d5a5ca8a5e6295679643d8d10292c390abd4cd9406ea7d6478cc
-  data.tar.gz: 7fb4740050b8cc726a4e124f7457201826ffda87aeec3db2e6cfd200ce96113d
+  metadata.gz: 3e14a95ecb4a896241b9303ae221757ef37dd0427b56bef4ccf9c92041cffdd4
+  data.tar.gz: 8e5e49486b4cf6aa00a25955e3170efa99f07814d03d47ead89137ad3c2badf8
 SHA512:
-  metadata.gz: a73c5f0cfaa4c2c1b754822b604c356af9d306a313266281ebb47499fce0a5dd721b5137c28fba7743a63e5b383ae2a08906b540116266e7986c71c01f2ea1cd
-  data.tar.gz: d244f8a4f16e8682ba15eb0a3c5c8ead76908186d74f8148a1904e208cf1ef1b8cf797f563f9cd38a1f9bae60078a87b3bb522bdcde0d1220214aa2896db081e
+  metadata.gz: 7de5580f28d5c5e41cef9217647432eaec0d842226d39f90323146f92ae95fe7e3cbe6b434746a694d6d605d3406fe49dc53dbb2a335916d59863a510b970c3b
+  data.tar.gz: 4d8f054e24cdbbbfc1928a33f4c88d3b4da38f4b9e94df827fdf3cc93b64396a1b78cc7eac5a2b1dd71904950a0d98156dea8b81fd072a7cc991c20cf91dc0ad

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.104.1
+- Package version: 0.104.2
 - Generator version: 7.7.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.104.1.gem
+gem install ./DealMakerAPI-0.104.2.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.104.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.104.2.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.104.1'
+    gem 'DealMakerAPI', '~> 0.104.2'
 
 ### Install from Git
 
@@ -503,6 +503,8 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::UserApi* | [**disable_mfa**](docs/UserApi.md#disable_mfa) | **DELETE** /users/{id}/disable_mfa | Disable all the multi-factor authentication integrations for a user
 *DealMakerAPI::UserApi* | [**get_two_factor_channels**](docs/UserApi.md#get_two_factor_channels) | **GET** /users/{id}/two_factor_channels | Creates an API endpoint to return a list of existing TOTP factor
 *DealMakerAPI::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID
+*DealMakerAPI::UserApi* | [**get_verification_resources**](docs/UserApi.md#get_verification_resources) | **GET** /users/verification/resources | Gets the verification process resources
+*DealMakerAPI::UserApi* | [**send_verification_code**](docs/UserApi.md#send_verification_code) | **POST** /users/verification/send_code | Sends the verification code to the user
 *DealMakerAPI::UserApi* | [**setup_sms_verification**](docs/UserApi.md#setup_sms_verification) | **POST** /users/{id}/setup_sms_verification | Start a setup for a SMS Verification by creating a two factor channel of sms type
 *DealMakerAPI::UserApi* | [**update_user_password**](docs/UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password
 *DealMakerAPI::UserApi* | [**verify_factor**](docs/UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor
@@ -550,6 +552,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::RequestNewDocumentRequest](docs/RequestNewDocumentRequest.md)
  - [DealMakerAPI::RunBackgroundSearchRequest](docs/RunBackgroundSearchRequest.md)
  - [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
+ - [DealMakerAPI::SendVerificationCodeRequest](docs/SendVerificationCodeRequest.md)
  - [DealMakerAPI::SetupSmsVerificationRequest](docs/SetupSmsVerificationRequest.md)
  - [DealMakerAPI::TestDocumentUploadEmailRequest](docs/TestDocumentUploadEmailRequest.md)
  - [DealMakerAPI::UpdateUserPasswordRequest](docs/UpdateUserPasswordRequest.md)
@@ -584,6 +587,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesDealsProgressColumn](docs/V1EntitiesDealsProgressColumn.md)
  - [DealMakerAPI::V1EntitiesDealsProgressKinds](docs/V1EntitiesDealsProgressKinds.md)
  - [DealMakerAPI::V1EntitiesDealsProgressPageSummary](docs/V1EntitiesDealsProgressPageSummary.md)
+ - [DealMakerAPI::V1EntitiesDealsProgressPageSummaryItem](docs/V1EntitiesDealsProgressPageSummaryItem.md)
  - [DealMakerAPI::V1EntitiesDeleteResult](docs/V1EntitiesDeleteResult.md)
  - [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
  - [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
@@ -637,6 +641,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesUsersFactor](docs/V1EntitiesUsersFactor.md)
  - [DealMakerAPI::V1EntitiesUsersTwoFactorChannel](docs/V1EntitiesUsersTwoFactorChannel.md)
  - [DealMakerAPI::V1EntitiesUsersTwoFactorChannels](docs/V1EntitiesUsersTwoFactorChannels.md)
+ - [DealMakerAPI::V1EntitiesUsersVerificationResources](docs/V1EntitiesUsersVerificationResources.md)
  - [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
  - [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
  - [DealMakerAPI::V1EntitiesWebhooksSubscription](docs/V1EntitiesWebhooksSubscription.md)

data/docs/SendVerificationCodeRequest.md

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

data/docs/UserApi.md

@@ -9,6 +9,8 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**disable_mfa**](UserApi.md#disable_mfa) | **DELETE** /users/{id}/disable_mfa | Disable all the multi-factor authentication integrations for a user |
 | [**get_two_factor_channels**](UserApi.md#get_two_factor_channels) | **GET** /users/{id}/two_factor_channels | Creates an API endpoint to return a list of existing TOTP factor |
 | [**get_user**](UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID |
+| [**get_verification_resources**](UserApi.md#get_verification_resources) | **GET** /users/verification/resources | Gets the verification process resources |
+| [**send_verification_code**](UserApi.md#send_verification_code) | **POST** /users/verification/send_code | Sends the verification code to the user |
 | [**setup_sms_verification**](UserApi.md#setup_sms_verification) | **POST** /users/{id}/setup_sms_verification | Start a setup for a SMS Verification by creating a two factor channel of sms type |
 | [**update_user_password**](UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password |
 | [**verify_factor**](UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor |
@@ -346,6 +348,138 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_verification_resources
+
+> <V1EntitiesUsersVerificationResources> get_verification_resources(login_token)
+
+Gets the verification process resources
+
+Get verification process resources
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+login_token = 'login_token_example' # String | The token containing the user information.
+
+begin
+  # Gets the verification process resources
+  result = api_instance.get_verification_resources(login_token)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->get_verification_resources: #{e}"
+end
+```
+
+#### Using the get_verification_resources_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUsersVerificationResources>, Integer, Hash)> get_verification_resources_with_http_info(login_token)
+
+```ruby
+begin
+  # Gets the verification process resources
+  data, status_code, headers = api_instance.get_verification_resources_with_http_info(login_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUsersVerificationResources>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->get_verification_resources_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **login_token** | **String** | The token containing the user information. |  |
+
+### Return type
+
+[**V1EntitiesUsersVerificationResources**](V1EntitiesUsersVerificationResources.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## send_verification_code
+
+> <V1EntitiesDeleteResult> send_verification_code(send_verification_code_request)
+
+Sends the verification code to the user
+
+Send the verification code to the user
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+send_verification_code_request = DealMakerAPI::SendVerificationCodeRequest.new({login_token: 'login_token_example'}) # SendVerificationCodeRequest | 
+
+begin
+  # Sends the verification code to the user
+  result = api_instance.send_verification_code(send_verification_code_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->send_verification_code: #{e}"
+end
+```
+
+#### Using the send_verification_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesDeleteResult>, Integer, Hash)> send_verification_code_with_http_info(send_verification_code_request)
+
+```ruby
+begin
+  # Sends the verification code to the user
+  data, status_code, headers = api_instance.send_verification_code_with_http_info(send_verification_code_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesDeleteResult>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->send_verification_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_verification_code_request** | [**SendVerificationCodeRequest**](SendVerificationCodeRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesDeleteResult**](V1EntitiesDeleteResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## setup_sms_verification
 
 > setup_sms_verification(id, setup_sms_verification_request)

data/docs/V1EntitiesDealsProgressPageSummary.md

@@ -4,14 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **investment_proceeds** | **Float** | Investment Proceeds | [optional] |
-| **fees_and_adjustments** | **Float** | Fees and Adjustments | [optional] |
-| **total_proceeds** | **Float** | Total Proceeds | [optional] |
-| **processing_fees** | **Float** | Processing Fees | [optional] |
-| **invoice_deductions** | **Float** | Invoice Deductions | [optional] |
-| **holdback** | **Float** | Holdback | [optional] |
-| **paid_out** | **Float** | Paid Out | [optional] |
-| **available_for_payout** | **Float** | Available for Payout | [optional] |
+| **investment_proceeds** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **fees_and_adjustments** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **total_proceeds** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **processing_fees** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **invoice_deductions** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **holdback** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **paid_out** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
+| **available_for_payout** | [**V1EntitiesDealsProgressPageSummaryItem**](V1EntitiesDealsProgressPageSummaryItem.md) |  | [optional] |
 
 ## Example
 

data/docs/V1EntitiesDealsProgressPageSummaryItem.md

@@ -0,0 +1,28 @@
+# DealMakerAPI::V1EntitiesDealsProgressPageSummaryItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Label | [optional] |
+| **highlighted** | **Boolean** | Highlighted | [optional] |
+| **negative** | **Boolean** | Negative | [optional] |
+| **value** | **Float** | Value | [optional] |
+| **link** | **String** | Link | [optional] |
+| **description** | **String** | Description | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDealsProgressPageSummaryItem.new(
+  label: null,
+  highlighted: null,
+  negative: null,
+  value: null,
+  link: null,
+  description: null
+)
+```
+

data/docs/V1EntitiesUsersVerificationResources.md

@@ -0,0 +1,22 @@
+# DealMakerAPI::V1EntitiesUsersVerificationResources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **totp_enabled** | **Boolean** | Check if on the authenticator app is set for the user. | [optional] |
+| **sms_enabled** | **Boolean** | Check if on the sms verification is set for the user. | [optional] |
+| **phone** | **String** | The last 4 digits of the users phone number. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesUsersVerificationResources.new(
+  totp_enabled: null,
+  sms_enabled: null,
+  phone: null
+)
+```
+

data/lib/DealMakerAPI/api/user_api.rb

@@ -338,6 +338,138 @@ module DealMakerAPI
       return data, status_code, headers
     end
 
+    # Gets the verification process resources
+    # Get verification process resources
+    # @param login_token [String] The token containing the user information.
+    # @param [Hash] opts the optional parameters
+    # @return [V1EntitiesUsersVerificationResources]
+    def get_verification_resources(login_token, opts = {})
+      data, _status_code, _headers = get_verification_resources_with_http_info(login_token, opts)
+      data
+    end
+
+    # Gets the verification process resources
+    # Get verification process resources
+    # @param login_token [String] The token containing the user information.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EntitiesUsersVerificationResources, Integer, Hash)>] V1EntitiesUsersVerificationResources data, response status code and response headers
+    def get_verification_resources_with_http_info(login_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.get_verification_resources ...'
+      end
+      # verify the required parameter 'login_token' is set
+      if @api_client.config.client_side_validation && login_token.nil?
+        fail ArgumentError, "Missing the required parameter 'login_token' when calling UserApi.get_verification_resources"
+      end
+      # resource path
+      local_var_path = '/users/verification/resources'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'login_token'] = login_token
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesUsersVerificationResources'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UserApi.get_verification_resources",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserApi#get_verification_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Sends the verification code to the user
+    # Send the verification code to the user
+    # @param send_verification_code_request [SendVerificationCodeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [V1EntitiesDeleteResult]
+    def send_verification_code(send_verification_code_request, opts = {})
+      data, _status_code, _headers = send_verification_code_with_http_info(send_verification_code_request, opts)
+      data
+    end
+
+    # Sends the verification code to the user
+    # Send the verification code to the user
+    # @param send_verification_code_request [SendVerificationCodeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EntitiesDeleteResult, Integer, Hash)>] V1EntitiesDeleteResult data, response status code and response headers
+    def send_verification_code_with_http_info(send_verification_code_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserApi.send_verification_code ...'
+      end
+      # verify the required parameter 'send_verification_code_request' is set
+      if @api_client.config.client_side_validation && send_verification_code_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_verification_code_request' when calling UserApi.send_verification_code"
+      end
+      # resource path
+      local_var_path = '/users/verification/send_code'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(send_verification_code_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesDeleteResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UserApi.send_verification_code",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserApi#send_verification_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Start a setup for a SMS Verification by creating a two factor channel of sms type
     # Start a setup for a SMS Verification by creating a two factor channel of sms type
     # @param id [Integer]