DealMakerAPI 0.102.1 → 0.103.6

data/docs/UserApi.md

@@ -4,8 +4,145 @@ All URIs are relative to *http://api.dealmaker.tech*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_factor**](UserApi.md#create_factor) | **POST** /users/{id}/create_factor | Creates an API endpoint for creating a new TOTP factor |
+| [**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 |
+| [**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 |
+| [**verify_sms_verification**](UserApi.md#verify_sms_verification) | **POST** /users/{id}/verify_sms_verification | Verify a SMS Verification by creating a two factor channel of sms type |
+
+
+## create_factor
+
+> <V1EntitiesUsersFactor> create_factor(id)
+
+Creates an API endpoint for creating a new TOTP factor
+
+Create an API endpoint for creating a new TOTP factor
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+
+begin
+  # Creates an API endpoint for creating a new TOTP factor
+  result = api_instance.create_factor(id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->create_factor: #{e}"
+end
+```
+
+#### Using the create_factor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUsersFactor>, Integer, Hash)> create_factor_with_http_info(id)
+
+```ruby
+begin
+  # Creates an API endpoint for creating a new TOTP factor
+  data, status_code, headers = api_instance.create_factor_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUsersFactor>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->create_factor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesUsersFactor**](V1EntitiesUsersFactor.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_two_factor_channels
+
+> <V1EntitiesUsersTwoFactorChannels> get_two_factor_channels(id)
+
+Creates an API endpoint to return a list of existing TOTP factor
+
+Create an API endpoint to return a list of existing TOTP factor
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+
+begin
+  # Creates an API endpoint to return a list of existing TOTP factor
+  result = api_instance.get_two_factor_channels(id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->get_two_factor_channels: #{e}"
+end
+```
+
+#### Using the get_two_factor_channels_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUsersTwoFactorChannels>, Integer, Hash)> get_two_factor_channels_with_http_info(id)
+
+```ruby
+begin
+  # Creates an API endpoint to return a list of existing TOTP factor
+  data, status_code, headers = api_instance.get_two_factor_channels_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUsersTwoFactorChannels>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->get_two_factor_channels_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesUsersTwoFactorChannels**](V1EntitiesUsersTwoFactorChannels.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
 ## get_user
@@ -74,6 +211,73 @@ No authorization required
 - **Accept**: application/json
 
 
+## setup_sms_verification
+
+> setup_sms_verification(id, setup_sms_verification_request)
+
+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
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+setup_sms_verification_request = DealMakerAPI::SetupSmsVerificationRequest.new({phone_number: 'phone_number_example'}) # SetupSmsVerificationRequest | 
+
+begin
+  # Start a setup for a SMS Verification by creating a two factor channel of sms type
+  api_instance.setup_sms_verification(id, setup_sms_verification_request)
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->setup_sms_verification: #{e}"
+end
+```
+
+#### Using the setup_sms_verification_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> setup_sms_verification_with_http_info(id, setup_sms_verification_request)
+
+```ruby
+begin
+  # Start a setup for a SMS Verification by creating a two factor channel of sms type
+  data, status_code, headers = api_instance.setup_sms_verification_with_http_info(id, setup_sms_verification_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->setup_sms_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **setup_sms_verification_request** | [**SetupSmsVerificationRequest**](SetupSmsVerificationRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
 ## update_user_password
 
 > <V1EntitiesUser> update_user_password(id, update_user_password_request)
@@ -141,3 +345,139 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## verify_factor
+
+> <V1EntitiesUsersTwoFactorChannel> verify_factor(id, verify_factor_request)
+
+Creates an API endpoint to verify an existing TOTP factor
+
+Create an API endpoint to verify an existing TOTP factor
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+verify_factor_request = DealMakerAPI::VerifyFactorRequest.new({code: 'code_example'}) # VerifyFactorRequest | 
+
+begin
+  # Creates an API endpoint to verify an existing TOTP factor
+  result = api_instance.verify_factor(id, verify_factor_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->verify_factor: #{e}"
+end
+```
+
+#### Using the verify_factor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUsersTwoFactorChannel>, Integer, Hash)> verify_factor_with_http_info(id, verify_factor_request)
+
+```ruby
+begin
+  # Creates an API endpoint to verify an existing TOTP factor
+  data, status_code, headers = api_instance.verify_factor_with_http_info(id, verify_factor_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUsersTwoFactorChannel>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->verify_factor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **verify_factor_request** | [**VerifyFactorRequest**](VerifyFactorRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesUsersTwoFactorChannel**](V1EntitiesUsersTwoFactorChannel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_sms_verification
+
+> <V1EntitiesUsersTwoFactorChannel> verify_sms_verification(id, verify_sms_verification_request)
+
+Verify a SMS Verification by creating a two factor channel of sms type
+
+Verify a SMS Verification by creating a two factor channel of sms type
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::UserApi.new
+id = 56 # Integer | 
+verify_sms_verification_request = DealMakerAPI::VerifySmsVerificationRequest.new({phone_number: 'phone_number_example', code: 'code_example'}) # VerifySmsVerificationRequest | 
+
+begin
+  # Verify a SMS Verification by creating a two factor channel of sms type
+  result = api_instance.verify_sms_verification(id, verify_sms_verification_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->verify_sms_verification: #{e}"
+end
+```
+
+#### Using the verify_sms_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesUsersTwoFactorChannel>, Integer, Hash)> verify_sms_verification_with_http_info(id, verify_sms_verification_request)
+
+```ruby
+begin
+  # Verify a SMS Verification by creating a two factor channel of sms type
+  data, status_code, headers = api_instance.verify_sms_verification_with_http_info(id, verify_sms_verification_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesUsersTwoFactorChannel>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling UserApi->verify_sms_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **verify_sms_verification_request** | [**VerifySmsVerificationRequest**](VerifySmsVerificationRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesUsersTwoFactorChannel**](V1EntitiesUsersTwoFactorChannel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/V1EntitiesAttachment.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The attachment id. | [optional] |
 | **url** | **String** | The attachment url. | [optional] |
+| **status** | **String** | The attachment status. | [optional] |
 | **file_name** | **String** | The attachment file name. | [optional] |
 | **original_file_name** | **String** | The attachment original file name. | [optional] |
 | **file_size** | **Integer** | The size of the file in bytes. | [optional] |
@@ -20,6 +21,7 @@ require 'DealMakerAPI'
 instance = DealMakerAPI::V1EntitiesAttachment.new(
   id: null,
   url: null,
+  status: null,
   file_name: null,
   original_file_name: null,
   file_size: null,

data/docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_secret** | **String** | The client secret for the payment | [optional] |
+| **name** | **String** | The name of the investor | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.new(
+  client_secret: null,
+  name: null
+)
+```
+

data/docs/V1EntitiesDealsProgress.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::V1EntitiesDealsProgress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **investor_funnel** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) |  | [optional] |
+| **incoming_payments** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDealsProgress.new(
+  investor_funnel: null,
+  incoming_payments: null
+)
+```
+

data/docs/V1EntitiesDealsProgressColumn.md

@@ -0,0 +1,22 @@
+# DealMakerAPI::V1EntitiesDealsProgressColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label of the column. | [optional] |
+| **value** | **Integer** | The value for the column. | [optional] |
+| **description** | **Integer** | The description of the column. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDealsProgressColumn.new(
+  label: null,
+  value: null,
+  description: null
+)
+```
+

data/docs/V1EntitiesDealsProgressPageSummary.md

@@ -0,0 +1,32 @@
+# DealMakerAPI::V1EntitiesDealsProgressPageSummary
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDealsProgressPageSummary.new(
+  investment_proceeds: null,
+  fees_and_adjustments: null,
+  total_proceeds: null,
+  processing_fees: null,
+  invoice_deductions: null,
+  holdback: null,
+  paid_out: null,
+  available_for_payout: null
+)
+```
+

data/docs/V1EntitiesUsersBinding.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::V1EntitiesUsersBinding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **secret** | **String** | The secret. | [optional] |
+| **uri** | **String** | The URI. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesUsersBinding.new(
+  secret: null,
+  uri: null
+)
+```
+

data/docs/V1EntitiesUsersFactor.md

@@ -0,0 +1,22 @@
+# DealMakerAPI::V1EntitiesUsersFactor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sid** | **String** | The sid for the factor. | [optional] |
+| **identity** | **String** | The identity of the factor. | [optional] |
+| **binding** | [**V1EntitiesUsersBinding**](V1EntitiesUsersBinding.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesUsersFactor.new(
+  sid: null,
+  identity: null,
+  binding: null
+)
+```
+

data/docs/V1EntitiesUsersTwoFactorChannel.md

@@ -0,0 +1,32 @@
+# DealMakerAPI::V1EntitiesUsersTwoFactorChannel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The id for the two factor channel. | [optional] |
+| **factor_sid** | **String** | The unique string for the resource | [optional] |
+| **user_id** | **Integer** | The user id for the two factor channel. | [optional] |
+| **identity** | **String** | The identity for the two factor channel. | [optional] |
+| **phone_number** | **String** | The phone number of the user. | [optional] |
+| **channel** | **String** | The channel for the two factor channel. | [optional] |
+| **verified** | **Boolean** | The verification status for the two factor channel. | [optional] |
+| **updated_at** | **String** | The time since the two factor channel was last updated/verified. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesUsersTwoFactorChannel.new(
+  id: null,
+  factor_sid: null,
+  user_id: null,
+  identity: null,
+  phone_number: null,
+  channel: null,
+  verified: null,
+  updated_at: null
+)
+```
+

data/docs/V1EntitiesUsersTwoFactorChannels.md

@@ -0,0 +1,18 @@
+# DealMakerAPI::V1EntitiesUsersTwoFactorChannels
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**V1EntitiesUsersTwoFactorChannel**](V1EntitiesUsersTwoFactorChannel.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesUsersTwoFactorChannels.new(
+  items: null
+)
+```
+

data/docs/VerifyFactorRequest.md

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

data/docs/VerifySmsVerificationRequest.md

@@ -0,0 +1,20 @@
+# DealMakerAPI::VerifySmsVerificationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | The phone number of the given user |  |
+| **code** | **String** | The verification code |  |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::VerifySmsVerificationRequest.new(
+  phone_number: null,
+  code: null
+)
+```
+

data/lib/DealMakerAPI/api/company_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.75.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0-SNAPSHOT
+Generator version: 7.7.0-SNAPSHOT
 
 =end
 
@@ -1554,5 +1554,77 @@ module DealMakerAPI
       end
       return data, status_code, headers
     end
+
+    # Send document upload test email to given user
+    # Send document upload test email to given user
+    # @param id [Integer] 
+    # @param test_document_upload_email_request [TestDocumentUploadEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def test_document_upload_email(id, test_document_upload_email_request, opts = {})
+      test_document_upload_email_with_http_info(id, test_document_upload_email_request, opts)
+      nil
+    end
+
+    # Send document upload test email to given user
+    # Send document upload test email to given user
+    # @param id [Integer] 
+    # @param test_document_upload_email_request [TestDocumentUploadEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def test_document_upload_email_with_http_info(id, test_document_upload_email_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompanyApi.test_document_upload_email ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.test_document_upload_email"
+      end
+      # verify the required parameter 'test_document_upload_email_request' is set
+      if @api_client.config.client_side_validation && test_document_upload_email_request.nil?
+        fail ArgumentError, "Missing the required parameter 'test_document_upload_email_request' when calling CompanyApi.test_document_upload_email"
+      end
+      # resource path
+      local_var_path = '/companies/{id}/documents/test_upload_email'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(test_document_upload_email_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CompanyApi.test_document_upload_email",
+        :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: CompanyApi#test_document_upload_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end