DealMakerAPI 0.105.4 → 0.106.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dc8a11386f87c55f53dfc87285302a9359e210d690a9cdf0bcf68034580f0fad
4
- data.tar.gz: b37546eb0461a64e0d8738489379b06a673c21e222fb1d13067163e36c8d2d4e
3
+ metadata.gz: 2cb5e7fa22612142eda0a8dcf0dcf279df603c93f4dde967c68cc02fb88edac4
4
+ data.tar.gz: 0a9fa749a45485cc12a366980de8e38834bb2a3e4dc034fcbb4de7ed632fc37f
5
5
  SHA512:
6
- metadata.gz: 126f1d8305e13915fdac37ce7fd1a073e5a0a7c0477191ca183e2ea853e842cc90bebf921200238a475ec9282d2f4fe52098c2a40b55220031f606b6ce1cbd6f
7
- data.tar.gz: 1accd1d5d3e4c98b527bd535e78c04afa0b95469470ecc919b9bcc37d691dcfc9573a161ce72aa4e2e571f36306481bc057bcc13914606f7a143c1107052d089
6
+ metadata.gz: cdc95b642bded7445b288ed5dea72c26a9f6367a3fe3a9fadf9cc203625655a89c634c48971d8870e71b73308bd2c285c77317347c92d951f07e6145fc296db5
7
+ data.tar.gz: 4af539f38b4f814d09d263c00c231ad5e7384fb35b582041c0c38c4c7c13c7014d6a474e92216770ba1cb2c836ba6edb201637da175f66dfbc8fa8dd2e78cfb9
data/README.md CHANGED
@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
338
338
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
339
339
 
340
340
  - API version: 1.75.0
341
- - Package version: 0.105.4
341
+ - Package version: 0.106.0
342
342
  - Generator version: 7.7.0-SNAPSHOT
343
343
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
344
344
 
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
355
355
  Then either install the gem locally:
356
356
 
357
357
  ```shell
358
- gem install ./DealMakerAPI-0.105.4.gem
358
+ gem install ./DealMakerAPI-0.106.0.gem
359
359
  ```
360
360
 
361
- (for development, run `gem install --dev ./DealMakerAPI-0.105.4.gem` to install the development dependencies)
361
+ (for development, run `gem install --dev ./DealMakerAPI-0.106.0.gem` to install the development dependencies)
362
362
 
363
363
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
364
364
 
365
365
  Finally add this to the Gemfile:
366
366
 
367
- gem 'DealMakerAPI', '~> 0.105.4'
367
+ gem 'DealMakerAPI', '~> 0.106.0'
368
368
 
369
369
  ### Install from Git
370
370
 
@@ -457,6 +457,7 @@ Class | Method | HTTP request | Description
457
457
  *DealMakerAPI::DefaultApi* | [**get_webhooks_deal_id**](docs/DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id
458
458
  *DealMakerAPI::DefaultApi* | [**get_webhooks_deals_search**](docs/DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user
459
459
  *DealMakerAPI::DefaultApi* | [**get_webhooks_security_token**](docs/DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription
460
+ *DealMakerAPI::DefaultApi* | [**patch_deals_id_platform_emails_domain**](docs/DefaultApi.md#patch_deals_id_platform_emails_domain) | **PATCH** /deals/{id}/platform_emails/domain | Update the email domain settings for the deal
460
461
  *DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit | Submit a payout account details form
461
462
  *DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit | Submit a qualification questionnaire response
462
463
  *DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit | Submit a qualification questionnaire form
@@ -532,6 +533,7 @@ Class | Method | HTTP request | Description
532
533
  - [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
533
534
  - [DealMakerAPI::GetAccessTokenRequest](docs/GetAccessTokenRequest.md)
534
535
  - [DealMakerAPI::PatchDealIncentivePlanRequest](docs/PatchDealIncentivePlanRequest.md)
536
+ - [DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest](docs/PatchDealsIdPlatformEmailsDomainRequest.md)
535
537
  - [DealMakerAPI::PatchInvestorProfilesCorporations](docs/PatchInvestorProfilesCorporations.md)
536
538
  - [DealMakerAPI::PatchInvestorProfilesCorporationsBeneficialOwnersInner](docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md)
537
539
  - [DealMakerAPI::PatchInvestorProfilesIndividuals](docs/PatchInvestorProfilesIndividuals.md)
data/docs/DefaultApi.md CHANGED
@@ -17,6 +17,7 @@ All URIs are relative to *http://api.dealmaker.tech*
17
17
  | [**get_webhooks_deal_id**](DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id |
18
18
  | [**get_webhooks_deals_search**](DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user |
19
19
  | [**get_webhooks_security_token**](DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription |
20
+ | [**patch_deals_id_platform_emails_domain**](DefaultApi.md#patch_deals_id_platform_emails_domain) | **PATCH** /deals/{id}/platform_emails/domain | Update the email domain settings for the deal |
20
21
  | [**post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit | Submit a payout account details form |
21
22
  | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit | Submit a qualification questionnaire response |
22
23
  | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit | Submit a qualification questionnaire form |
@@ -878,6 +879,73 @@ No authorization required
878
879
  - **Accept**: application/json
879
880
 
880
881
 
882
+ ## patch_deals_id_platform_emails_domain
883
+
884
+ > patch_deals_id_platform_emails_domain(id, patch_deals_id_platform_emails_domain_request)
885
+
886
+ Update the email domain settings for the deal
887
+
888
+ Update the email domain settings for the deal
889
+
890
+ ### Examples
891
+
892
+ ```ruby
893
+ require 'time'
894
+ require 'DealMakerAPI'
895
+ # setup authorization
896
+ DealMakerAPI.configure do |config|end
897
+
898
+ api_instance = DealMakerAPI::DefaultApi.new
899
+ id = 56 # Integer | The deal id.
900
+ patch_deals_id_platform_emails_domain_request = DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest.new({sender_name: 'sender_name_example', sender_email: 'sender_email_example'}) # PatchDealsIdPlatformEmailsDomainRequest |
901
+
902
+ begin
903
+ # Update the email domain settings for the deal
904
+ api_instance.patch_deals_id_platform_emails_domain(id, patch_deals_id_platform_emails_domain_request)
905
+ rescue DealMakerAPI::ApiError => e
906
+ puts "Error when calling DefaultApi->patch_deals_id_platform_emails_domain: #{e}"
907
+ end
908
+ ```
909
+
910
+ #### Using the patch_deals_id_platform_emails_domain_with_http_info variant
911
+
912
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
913
+
914
+ > <Array(nil, Integer, Hash)> patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request)
915
+
916
+ ```ruby
917
+ begin
918
+ # Update the email domain settings for the deal
919
+ data, status_code, headers = api_instance.patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request)
920
+ p status_code # => 2xx
921
+ p headers # => { ... }
922
+ p data # => nil
923
+ rescue DealMakerAPI::ApiError => e
924
+ puts "Error when calling DefaultApi->patch_deals_id_platform_emails_domain_with_http_info: #{e}"
925
+ end
926
+ ```
927
+
928
+ ### Parameters
929
+
930
+ | Name | Type | Description | Notes |
931
+ | ---- | ---- | ----------- | ----- |
932
+ | **id** | **Integer** | The deal id. | |
933
+ | **patch_deals_id_platform_emails_domain_request** | [**PatchDealsIdPlatformEmailsDomainRequest**](PatchDealsIdPlatformEmailsDomainRequest.md) | | |
934
+
935
+ ### Return type
936
+
937
+ nil (empty response body)
938
+
939
+ ### Authorization
940
+
941
+ No authorization required
942
+
943
+ ### HTTP request headers
944
+
945
+ - **Content-Type**: application/json
946
+ - **Accept**: Not defined
947
+
948
+
881
949
  ## post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit
882
950
 
883
951
  > <V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult> post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit(deal_id)
@@ -0,0 +1,20 @@
1
+ # DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sender_name** | **String** | The sender name. | |
8
+ | **sender_email** | **String** | The sender email. It must match an authenticated domain. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'DealMakerAPI'
14
+
15
+ instance = DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest.new(
16
+ sender_name: null,
17
+ sender_email: null
18
+ )
19
+ ```
20
+
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **email** | **String** | The investor email address. | |
8
+ | **email_confirmation** | **String** | The investor confirmation email address. | [optional] |
8
9
  | **investor_profile_id** | **Integer** | The Investor Profile id. | [optional] |
9
10
  | **tags** | **Array&lt;String&gt;** | | [optional] |
10
11
  | **first_name** | **String** | The first name of the investor. | [optional] |
@@ -24,6 +25,7 @@ require 'DealMakerAPI'
24
25
 
25
26
  instance = DealMakerAPI::PostDealsIdInvestors.new(
26
27
  email: null,
28
+ email_confirmation: null,
27
29
  investor_profile_id: null,
28
30
  tags: null,
29
31
  first_name: null,
@@ -825,6 +825,78 @@ module DealMakerAPI
825
825
  return data, status_code, headers
826
826
  end
827
827
 
828
+ # Update the email domain settings for the deal
829
+ # Update the email domain settings for the deal
830
+ # @param id [Integer] The deal id.
831
+ # @param patch_deals_id_platform_emails_domain_request [PatchDealsIdPlatformEmailsDomainRequest]
832
+ # @param [Hash] opts the optional parameters
833
+ # @return [nil]
834
+ def patch_deals_id_platform_emails_domain(id, patch_deals_id_platform_emails_domain_request, opts = {})
835
+ patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request, opts)
836
+ nil
837
+ end
838
+
839
+ # Update the email domain settings for the deal
840
+ # Update the email domain settings for the deal
841
+ # @param id [Integer] The deal id.
842
+ # @param patch_deals_id_platform_emails_domain_request [PatchDealsIdPlatformEmailsDomainRequest]
843
+ # @param [Hash] opts the optional parameters
844
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
845
+ def patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request, opts = {})
846
+ if @api_client.config.debugging
847
+ @api_client.config.logger.debug 'Calling API: DefaultApi.patch_deals_id_platform_emails_domain ...'
848
+ end
849
+ # verify the required parameter 'id' is set
850
+ if @api_client.config.client_side_validation && id.nil?
851
+ fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.patch_deals_id_platform_emails_domain"
852
+ end
853
+ # verify the required parameter 'patch_deals_id_platform_emails_domain_request' is set
854
+ if @api_client.config.client_side_validation && patch_deals_id_platform_emails_domain_request.nil?
855
+ fail ArgumentError, "Missing the required parameter 'patch_deals_id_platform_emails_domain_request' when calling DefaultApi.patch_deals_id_platform_emails_domain"
856
+ end
857
+ # resource path
858
+ local_var_path = '/deals/{id}/platform_emails/domain'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
859
+
860
+ # query parameters
861
+ query_params = opts[:query_params] || {}
862
+
863
+ # header parameters
864
+ header_params = opts[:header_params] || {}
865
+ # HTTP header 'Content-Type'
866
+ content_type = @api_client.select_header_content_type(['application/json'])
867
+ if !content_type.nil?
868
+ header_params['Content-Type'] = content_type
869
+ end
870
+
871
+ # form parameters
872
+ form_params = opts[:form_params] || {}
873
+
874
+ # http body (model)
875
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_deals_id_platform_emails_domain_request)
876
+
877
+ # return_type
878
+ return_type = opts[:debug_return_type]
879
+
880
+ # auth_names
881
+ auth_names = opts[:debug_auth_names] || []
882
+
883
+ new_options = opts.merge(
884
+ :operation => :"DefaultApi.patch_deals_id_platform_emails_domain",
885
+ :header_params => header_params,
886
+ :query_params => query_params,
887
+ :form_params => form_params,
888
+ :body => post_body,
889
+ :auth_names => auth_names,
890
+ :return_type => return_type
891
+ )
892
+
893
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
894
+ if @api_client.config.debugging
895
+ @api_client.config.logger.debug "API called: DefaultApi#patch_deals_id_platform_emails_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
896
+ end
897
+ return data, status_code, headers
898
+ end
899
+
828
900
  # Submit a payout account details form
829
901
  # Submit a payout account details form
830
902
  # @param deal_id [Integer]
@@ -0,0 +1,239 @@
1
+ =begin
2
+ #DealMaker API
3
+
4
+ ## Introduction Welcome to DealMaker’s Web API v1! This API is RESTful, easy to integrate with, and offers support in 2 different languages. This is the technical documentation for our API. There are tutorials and examples of integrations with our API available on our [knowledge centre](https://help.dealmaker.tech/training-centre) as well. # Libraries - Javascript - Ruby # Authentication To authenticate, add an Authorization header to your API request that contains an access token. Before you [generate an access token](#how-to-generate-an-access-token) your must first [create an application](#create-an-application) on your portal and retrieve the your client ID and secret ## Create an Application DealMaker’s Web API v1 supports the use of OAuth applications. Applications can be generated in your [account](https://app.dealmaker.tech/developer/applications). To create an API Application, click on your user name in the top right corner to open a dropdown menu, and select \"Integrations\". Under the API settings tab, click the `Create New Application` button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-1.png) Name your application and assign the level of permissions for this application ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-2.png) Once your application is created, save in a secure space your client ID and secret. **WARNING**: The secret key will not be visible after you click the close button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-3.png) From the developer tab, you will be able to view and manage all the available applications ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-4.png) Each Application consists of a client id, secret and set of scopes. The scopes define what resources you want to have access to. The client ID and secret are used to generate an access token. You will need to create an application to use API endpoints. ## How to generate an access token After creating an application, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters: `token endpoint` - https://app.dealmaker.tech/oauth/token `grant_type` - must be set to `client_credentials` `client_id` - the Client ID displayed when you created the OAuth application in the previous step `client_secret` - the Client Secret displayed when you created the OAuth application in the previous step `scope` - the scope is established when you created the OAuth application in the previous step Note: The Generate an OAuth token response specifies how long the bearer token is valid for. You should reuse the bearer token until it is expired. When the token is expired, call Generate an OAuth token again to generate a new one. To use the access token, you must set a plain text header named `Authorization` with the contents of the header being “Bearer XXX” where XXX is your generated access token. ### Example #### Postman Here's an example on how to generate the access token with Postman, where `{{CLIENT_ID}}` and `{{CLIENT_SECRET}}` are the values generated after following the steps on [Create an Application](#create-an-application) ![Get access token postman example](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/token-postman.png) # Status Codes ## Content-Type Header All responses are returned in JSON format. We specify this by sending the Content-Type header. ## Status Codes Below is a table containing descriptions of the various status codes we currently support against various resources. Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request. | Status Code | Description | | ----------- | ----------- | | `200` | Success | | `403` | Forbidden | | `404` | Not found | # Pagination Pagination is used to divide large responses is smaller portions (pages). By default, all endpoints return a maximum of 25 records per page. You can change the number of records on a per request basis by passing a `per_page` parameter in the request header parameters. The largest supported `per_page` parameter is 100. When the response exceeds the `per_page` parameter, you can paginate through the records by increasing the `offset` parameter. Example: `offset=25` will return 25 records starting from 26th record. You may also paginate using the `page` parameter to indicate the page number you would like to show on the response. Please review the table below for the input parameters ## Inputs | Parameter | Description | | ---------- | ------------------------------------------------------------------------------- | | `per_page` | Amount of records included on each page (Default is 25) | | `page` | Page number | | `offset` | Amount of records offset on the API request where 0 represents the first record | ## Response Headers | Response Header | Description | | --------------- | -------------------------------------------- | | `X-Total` | Total number of records of response | | `X-Total-Pages` | Total number of pages of response | | `X-Per-Page` | Total number of records per page of response | | `X-Page` | Number of current page | | `X-Next-Page` | Number of next page | | `X-Prev-Page` | Number of previous page | | `X-Offset` | Total number of records offset | # Search and Filtering (The q parameter) The q optional parameter accepts a string as input and allows you to filter the request based on that string. Please note that search strings must be encoded according to ASCII. For example, \"john+investor&#64;dealmaker.tech\" should be passed as “john%2Binvestor%40dealmaker.tech”. There are two main ways to filter with it. ## Keyword filtering Some keywords allow you to filter investors based on a specific “scope” of the investors, for example using the string “Invited” will filter all investors with the status invited, and the keyword “Has attachments” will filter investors with attachments. Here’s a list of possible keywords and the “scope” each one of the keywords filters by: | Keywords | Scope | Decoded Example | Encoded Example | | ---------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Signed on \\(date range\\) | Investors who signed in the provided date range | Signed on (date range) [2020-07-01:2020-07-31] | `Signed%20on%20%28date%20range%29%20%5B2020-07-01%3A2020-07-31%5D` | | Enabled for countersignature on \\(date range\\) | Investors who were enabled for counter signature in the provided date range | Enabled for countersignature on (date range) [2022-05-24:2022-05-25] | `Enabled%20for%20countersignature%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Accepted on \\(date range\\) | Investors accepted in the provided date rage | Accepted on (date range) [2022-05-24:2022-05-25] | `Accepted%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Offline | Investors added to the deal offline | Offline | `Offline` | | Online | Investors added to the deal online | Online | `Online` | | Signed | Investors who signed their agreement | Signed | `Signed` | | Waiting for countersignature | Investors who have signed and are waiting for counter signature | Waiting for countersignature | `Waiting%20for%20countersignature` | | Invited | Investors on the Invited Status | Invited | `Invited` | | Accepted | Investors in the Accepted Status | Accepted | `Accepted` | | Questionnaire in progress | All Investors who have not finished completing the questionnaire | Questionnaire in progress | `Questionnaire%20in%20progress` | | Has attachments | All Investors with attachments | Has attachments | `Has%20attachments` | | Has notes | All Investors with notes | Has notes | `Has%20notes` | | Waiting for co-signature | Investors who have signed and are waiting for co-signature | Waiting for co-signature | `Waiting%20for%20co-signature` | | Background Check Approved | Investors with approved background check | Background Check Approved | `Background%20Check%20Approved` | | Document Review Pending | Investors with pending review | Document Review Pending | `Document%20Review%20Pending` | | Document Upload Pending | Investors with pending documents to upload | Document Upload Pending | `Document%20Upload%20Pending` | | Required adjudicator review | Investors who are required to be review by the adjudicator | Required adjudicator review | `Required%20adjudicator%20review` | --- **NOTE** Filtering keywords are case sensitive and need to be encoded --- ## Search String Any value for the parameter which does not match one of the keywords listed above, will use fields like `first name`, `last name`, `email`, `tags` to search for the investor. For example, if you search “Robert”, because this does not match one of the keywords listed above, it will then return any investors who have the string “Robert” in their name, email, or tags fields. # Versioning The latest version is v1. The version can be updated on the `Accept` header, just set the version as stated on the following example: ``` Accept:application/vnd.dealmaker-v1+json ``` | Version | Accept Header | | ------- | ----------------------------------- | | `v1` | application/vnd.dealmaker-`v1`+json | # SDK’s For instruction on installing SDKs, please view the following links - [Javascript](https://github.com/DealMakerTech/api/tree/main/v1/clients/javascript) - [Ruby](https://github.com/DealMakerTech/api/tree/main/v1/clients/ruby) # Webhooks Our webhooks functionality allows clients to automatically receive updates on a deal's investor data. Some of the data that the webhooks include: - Investor Name - Date created - Email - Phone - Allocation - Attachments - Accredited investor status - Accredited investor category - State (Draft, Invited, Signed, Accepted, Waiting, Inactive) Via webhooks clients can subscribe to the following events as they happen on Dealmaker: - Investor is created - Investor details are updated (any of the investor details above change or are updated) - Investor has signed their agreement - Invertor fully funded their investment - Investor has been accepted - Investor is deleted A URL supplied by the client will receive all the events with the information as part of the payload. Clients are able to add and update the URL within DealMaker. ## Configuration For a comprehensive guide on how to configure Webhooks please visit our support article: [Configuring Webhooks on DealMaker – DealMaker Support](https://help.dealmaker.tech/configuring-webhooks-on-dealmaker). As a developer user on DealMaker, you are able to configure webhooks by following the steps below: 1. Sign into Dealmaker 2. Go to **“Your profile”** in the top right corner 3. Access an **“Integrations”** configuration via the left menu 4. The developer configures webhooks by including: - The HTTPS URL where the request will be sent - Optionally, a security token that we would use to build a SHA1 hash that would be included in the request headers. The name of the header is `X-DealMaker-Signature`. If the secret is not specified, the hash won’t be included in the headers. - The Deal(s) to include in the webhook subscription - An email address that will be used to notify about errors. 5. The developers can disable webhooks temporarily if needed ## Specification ### Events The initial set of events will be related to the investor. The events are: 1. `investor.created` - Triggers every time a new investor is added to a deal 2. `investor.updated` - Triggers on updates to any of the following fields: - Status - Name - Email - (this is a user field so we trigger event for all investors with webhook subscription) - Allocated Amount - Investment Amount - Accredited investor fields - Adding or removing attachments - Tags - When the investor status is signed, the payload also includes a link to the signed document; the link expires after 30 minutes 3. `investor.signed` - Triggers when the investor signs their subscription agreement (terms and conditions) - When this happens the investor.state becomes `signed` - This event includes the same fields as the `investor.updated` event 4. `investor.funded` - Triggers when the investor becomes fully funded - This happens when the investor.funded_state becomes `funded` - This event includes the same fields as the `investor.updated` event 5. `investor.accepted` - Triggers when the investor is countersigned - When this happens the investor.state becomes `accepted` - This event includes the same fields as the `investor.updated` event 6. `investor.deleted` - Triggers when the investor is removed from the deal - The investor key of the payload only includes investor ID - The deal is not included in the payload. Due to our implementation it’s impossible to retrieve the deal the investor was part of ### Requests - The request is a `POST` - The payload’s `content-type` is `application/json` - Only `2XX` responses are considered successful. In the event of a different response, we consider it failed and queue the event for retry - We retry the request five times, after the initial attempt. Doubling the waiting time between intervals with each try. The first retry happens after 30 seconds, then 60 seconds, 2 mins, 4 minutes, and 8 minutes. This timing scheme gives the receiver about 1 hour if all the requests fail - If an event fails all the attempts to be delivered, we send an email to the address that the user configured ### Payload #### Common Properties There will be some properties that are common to all the events on the system. | Key | Type | Description | | ----------------- | ------ | -------------------------------------------------------------------------------------- | | event | String | The event that triggered the call | | event_id | String | A unique identifier for the event | | deal<sup>\\*</sup> | Object | The deal in which the event occurred. please see below for an example on the deal object<sup>\\*\\*</sup> | <sup>\\*</sup>This field is not included when deleting a resource <sup>\\*\\*</sup> Sample Deal Object in the webhook payload ```json \"deal\": { \"id\": 0, \"title\": \"string\", \"created_at\": \"2022-12-06T18:14:44.000Z\", \"updated_at\": \"2022-12-08T12:46:48.000Z\", \"state\": \"string\", \"currency\": \"string\", \"security_type\": \"string\", \"price_per_security\": 0.00, \"deal_type\": \"string\", \"minimum_investment\": 0, \"maximum_investment\": 0, \"issuer\": { \"id\": 0, \"name\": \"string\" }, \"enterprise\": { \"id\": 0, \"name\": \"string\" } } ``` #### Common Properties (investor scope) By design, we have incorporated on the webhooks payload the same investor-related fields included in the Investor model, for reference on the included fields, their types and values please click [here](https://docs.dealmaker.tech/#tag/investor_model). This will allow you to get all the necessary information you need about a particular investor without having to call the Get Investor by ID endpoint. | #### Investor State Here is a brief description of each investor state: - **Draft:** the investor is added to the platform but hasn't been invited yet and cannot access the portal - **Invited:** the investor was added to the platform but hasn’t completed the questionnaire - **Signed:** the investor signed the document (needs approval from Lawyer or Reviewer before countersignature) - **Waiting:** the investor was approved for countersignature by any of the Lawyers or Reviewers in the deal - **Accepted:** the investor's agreement was countersigned by the Signatory - **Inactive** the investor is no longer eligible to participate in the offering. This may be because their warrant expired, they requested a refund, or they opted out of the offering #### Update Delay Given the high number of updates our platform performs on any investor, we’ve added a cool down period on update events that allows us to “group” updates and trigger only one every minute. In consequence, update events will be delivered 1 minute after the initial request was made and will include the latest version of the investor data at delivery time.
5
+
6
+ The version of the OpenAPI document: 1.75.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.7.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DealMakerAPI
17
+ class PatchDealsIdPlatformEmailsDomainRequest
18
+ # The sender name.
19
+ attr_accessor :sender_name
20
+
21
+ # The sender email. It must match an authenticated domain.
22
+ attr_accessor :sender_email
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'sender_name' => :'sender_name',
28
+ :'sender_email' => :'sender_email'
29
+ }
30
+ end
31
+
32
+ # Returns all the JSON keys this model knows about
33
+ def self.acceptable_attributes
34
+ attribute_map.values
35
+ end
36
+
37
+ # Attribute type mapping.
38
+ def self.openapi_types
39
+ {
40
+ :'sender_name' => :'String',
41
+ :'sender_email' => :'String'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h|
60
+ if (!self.class.attribute_map.key?(k.to_sym))
61
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
+ end
63
+ h[k.to_sym] = v
64
+ }
65
+
66
+ if attributes.key?(:'sender_name')
67
+ self.sender_name = attributes[:'sender_name']
68
+ else
69
+ self.sender_name = nil
70
+ end
71
+
72
+ if attributes.key?(:'sender_email')
73
+ self.sender_email = attributes[:'sender_email']
74
+ else
75
+ self.sender_email = nil
76
+ end
77
+ end
78
+
79
+ # Show invalid properties with the reasons. Usually used together with valid?
80
+ # @return Array for valid properties with the reasons
81
+ def list_invalid_properties
82
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
83
+ invalid_properties = Array.new
84
+ if @sender_name.nil?
85
+ invalid_properties.push('invalid value for "sender_name", sender_name cannot be nil.')
86
+ end
87
+
88
+ if @sender_email.nil?
89
+ invalid_properties.push('invalid value for "sender_email", sender_email cannot be nil.')
90
+ end
91
+
92
+ invalid_properties
93
+ end
94
+
95
+ # Check to see if the all the properties in the model are valid
96
+ # @return true if the model is valid
97
+ def valid?
98
+ warn '[DEPRECATED] the `valid?` method is obsolete'
99
+ return false if @sender_name.nil?
100
+ return false if @sender_email.nil?
101
+ true
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ sender_name == o.sender_name &&
110
+ sender_email == o.sender_email
111
+ end
112
+
113
+ # @see the `==` method
114
+ # @param [Object] Object to be compared
115
+ def eql?(o)
116
+ self == o
117
+ end
118
+
119
+ # Calculates hash code according to all attributes.
120
+ # @return [Integer] Hash code
121
+ def hash
122
+ [sender_name, sender_email].hash
123
+ end
124
+
125
+ # Builds the object from hash
126
+ # @param [Hash] attributes Model attributes in the form of hash
127
+ # @return [Object] Returns the model itself
128
+ def self.build_from_hash(attributes)
129
+ return nil unless attributes.is_a?(Hash)
130
+ attributes = attributes.transform_keys(&:to_sym)
131
+ transformed_hash = {}
132
+ openapi_types.each_pair do |key, type|
133
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = nil
135
+ elsif type =~ /\AArray<(.*)>/i
136
+ # check to ensure the input is an array given that the attribute
137
+ # is documented as an array but the input is not
138
+ if attributes[attribute_map[key]].is_a?(Array)
139
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
140
+ end
141
+ elsif !attributes[attribute_map[key]].nil?
142
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
143
+ end
144
+ end
145
+ new(transformed_hash)
146
+ end
147
+
148
+ # Deserializes the data based on type
149
+ # @param string type Data type
150
+ # @param string value Value to be deserialized
151
+ # @return [Object] Deserialized data
152
+ def self._deserialize(type, value)
153
+ case type.to_sym
154
+ when :Time
155
+ Time.parse(value)
156
+ when :Date
157
+ Date.parse(value)
158
+ when :String
159
+ value.to_s
160
+ when :Integer
161
+ value.to_i
162
+ when :Float
163
+ value.to_f
164
+ when :Boolean
165
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
166
+ true
167
+ else
168
+ false
169
+ end
170
+ when :Object
171
+ # generic object (usually a Hash), return directly
172
+ value
173
+ when /\AArray<(?<inner_type>.+)>\z/
174
+ inner_type = Regexp.last_match[:inner_type]
175
+ value.map { |v| _deserialize(inner_type, v) }
176
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
177
+ k_type = Regexp.last_match[:k_type]
178
+ v_type = Regexp.last_match[:v_type]
179
+ {}.tap do |hash|
180
+ value.each do |k, v|
181
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
182
+ end
183
+ end
184
+ else # model
185
+ # models (e.g. Pet) or oneOf
186
+ klass = DealMakerAPI.const_get(type)
187
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ if value.nil?
210
+ is_nullable = self.class.openapi_nullable.include?(attr)
211
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
212
+ end
213
+
214
+ hash[param] = _to_hash(value)
215
+ end
216
+ hash
217
+ end
218
+
219
+ # Outputs non-array value in the form of hash
220
+ # For object, use to_hash. Otherwise, just return the value
221
+ # @param [Object] value Any valid value
222
+ # @return [Hash] Returns the value in the form of hash
223
+ def _to_hash(value)
224
+ if value.is_a?(Array)
225
+ value.compact.map { |v| _to_hash(v) }
226
+ elsif value.is_a?(Hash)
227
+ {}.tap do |hash|
228
+ value.each { |k, v| hash[k] = _to_hash(v) }
229
+ end
230
+ elsif value.respond_to? :to_hash
231
+ value.to_hash
232
+ else
233
+ value
234
+ end
235
+ end
236
+
237
+ end
238
+
239
+ end
@@ -19,6 +19,9 @@ module DealMakerAPI
19
19
  # The investor email address.
20
20
  attr_accessor :email
21
21
 
22
+ # The investor confirmation email address.
23
+ attr_accessor :email_confirmation
24
+
22
25
  # The Investor Profile id.
23
26
  attr_accessor :investor_profile_id
24
27
 
@@ -77,6 +80,7 @@ module DealMakerAPI
77
80
  def self.attribute_map
78
81
  {
79
82
  :'email' => :'email',
83
+ :'email_confirmation' => :'email_confirmation',
80
84
  :'investor_profile_id' => :'investor_profile_id',
81
85
  :'tags' => :'tags',
82
86
  :'first_name' => :'first_name',
@@ -100,6 +104,7 @@ module DealMakerAPI
100
104
  def self.openapi_types
101
105
  {
102
106
  :'email' => :'String',
107
+ :'email_confirmation' => :'String',
103
108
  :'investor_profile_id' => :'Integer',
104
109
  :'tags' => :'Array<String>',
105
110
  :'first_name' => :'String',
@@ -141,6 +146,10 @@ module DealMakerAPI
141
146
  self.email = nil
142
147
  end
143
148
 
149
+ if attributes.key?(:'email_confirmation')
150
+ self.email_confirmation = attributes[:'email_confirmation']
151
+ end
152
+
144
153
  if attributes.key?(:'investor_profile_id')
145
154
  self.investor_profile_id = attributes[:'investor_profile_id']
146
155
  end
@@ -242,6 +251,7 @@ module DealMakerAPI
242
251
  return true if self.equal?(o)
243
252
  self.class == o.class &&
244
253
  email == o.email &&
254
+ email_confirmation == o.email_confirmation &&
245
255
  investor_profile_id == o.investor_profile_id &&
246
256
  tags == o.tags &&
247
257
  first_name == o.first_name &&
@@ -264,7 +274,7 @@ module DealMakerAPI
264
274
  # Calculates hash code according to all attributes.
265
275
  # @return [Integer] Hash code
266
276
  def hash
267
- [email, investor_profile_id, tags, first_name, last_name, phone_number, message, warrant_expiry_date, warrant_certificate_number, allocated_amount, allocation_unit, state].hash
277
+ [email, email_confirmation, investor_profile_id, tags, first_name, last_name, phone_number, message, warrant_expiry_date, warrant_certificate_number, allocated_amount, allocation_unit, state].hash
268
278
  end
269
279
 
270
280
  # Builds the object from hash
@@ -11,5 +11,5 @@ Generator version: 7.7.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module DealMakerAPI
14
- VERSION = '0.105.4'
14
+ VERSION = '0.106.0'
15
15
  end
data/lib/DealMakerAPI.rb CHANGED
@@ -32,6 +32,7 @@ require 'DealMakerAPI/models/edit_investor_tags_request'
32
32
  require 'DealMakerAPI/models/generate_url_request'
33
33
  require 'DealMakerAPI/models/get_access_token_request'
34
34
  require 'DealMakerAPI/models/patch_deal_incentive_plan_request'
35
+ require 'DealMakerAPI/models/patch_deals_id_platform_emails_domain_request'
35
36
  require 'DealMakerAPI/models/patch_investor_profiles_corporations'
36
37
  require 'DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner'
37
38
  require 'DealMakerAPI/models/patch_investor_profiles_individuals'
@@ -188,6 +188,19 @@ describe 'DefaultApi' do
188
188
  end
189
189
  end
190
190
 
191
+ # unit tests for patch_deals_id_platform_emails_domain
192
+ # Update the email domain settings for the deal
193
+ # Update the email domain settings for the deal
194
+ # @param id The deal id.
195
+ # @param patch_deals_id_platform_emails_domain_request
196
+ # @param [Hash] opts the optional parameters
197
+ # @return [nil]
198
+ describe 'patch_deals_id_platform_emails_domain test' do
199
+ it 'should work' do
200
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
201
+ end
202
+ end
203
+
191
204
  # unit tests for post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit
192
205
  # Submit a payout account details form
193
206
  # Submit a payout account details form
@@ -0,0 +1,42 @@
1
+ =begin
2
+ #DealMaker API
3
+
4
+ ## Introduction Welcome to DealMaker’s Web API v1! This API is RESTful, easy to integrate with, and offers support in 2 different languages. This is the technical documentation for our API. There are tutorials and examples of integrations with our API available on our [knowledge centre](https://help.dealmaker.tech/training-centre) as well. # Libraries - Javascript - Ruby # Authentication To authenticate, add an Authorization header to your API request that contains an access token. Before you [generate an access token](#how-to-generate-an-access-token) your must first [create an application](#create-an-application) on your portal and retrieve the your client ID and secret ## Create an Application DealMaker’s Web API v1 supports the use of OAuth applications. Applications can be generated in your [account](https://app.dealmaker.tech/developer/applications). To create an API Application, click on your user name in the top right corner to open a dropdown menu, and select \"Integrations\". Under the API settings tab, click the `Create New Application` button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-1.png) Name your application and assign the level of permissions for this application ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-2.png) Once your application is created, save in a secure space your client ID and secret. **WARNING**: The secret key will not be visible after you click the close button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-3.png) From the developer tab, you will be able to view and manage all the available applications ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-4.png) Each Application consists of a client id, secret and set of scopes. The scopes define what resources you want to have access to. The client ID and secret are used to generate an access token. You will need to create an application to use API endpoints. ## How to generate an access token After creating an application, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters: `token endpoint` - https://app.dealmaker.tech/oauth/token `grant_type` - must be set to `client_credentials` `client_id` - the Client ID displayed when you created the OAuth application in the previous step `client_secret` - the Client Secret displayed when you created the OAuth application in the previous step `scope` - the scope is established when you created the OAuth application in the previous step Note: The Generate an OAuth token response specifies how long the bearer token is valid for. You should reuse the bearer token until it is expired. When the token is expired, call Generate an OAuth token again to generate a new one. To use the access token, you must set a plain text header named `Authorization` with the contents of the header being “Bearer XXX” where XXX is your generated access token. ### Example #### Postman Here's an example on how to generate the access token with Postman, where `{{CLIENT_ID}}` and `{{CLIENT_SECRET}}` are the values generated after following the steps on [Create an Application](#create-an-application) ![Get access token postman example](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/token-postman.png) # Status Codes ## Content-Type Header All responses are returned in JSON format. We specify this by sending the Content-Type header. ## Status Codes Below is a table containing descriptions of the various status codes we currently support against various resources. Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request. | Status Code | Description | | ----------- | ----------- | | `200` | Success | | `403` | Forbidden | | `404` | Not found | # Pagination Pagination is used to divide large responses is smaller portions (pages). By default, all endpoints return a maximum of 25 records per page. You can change the number of records on a per request basis by passing a `per_page` parameter in the request header parameters. The largest supported `per_page` parameter is 100. When the response exceeds the `per_page` parameter, you can paginate through the records by increasing the `offset` parameter. Example: `offset=25` will return 25 records starting from 26th record. You may also paginate using the `page` parameter to indicate the page number you would like to show on the response. Please review the table below for the input parameters ## Inputs | Parameter | Description | | ---------- | ------------------------------------------------------------------------------- | | `per_page` | Amount of records included on each page (Default is 25) | | `page` | Page number | | `offset` | Amount of records offset on the API request where 0 represents the first record | ## Response Headers | Response Header | Description | | --------------- | -------------------------------------------- | | `X-Total` | Total number of records of response | | `X-Total-Pages` | Total number of pages of response | | `X-Per-Page` | Total number of records per page of response | | `X-Page` | Number of current page | | `X-Next-Page` | Number of next page | | `X-Prev-Page` | Number of previous page | | `X-Offset` | Total number of records offset | # Search and Filtering (The q parameter) The q optional parameter accepts a string as input and allows you to filter the request based on that string. Please note that search strings must be encoded according to ASCII. For example, \"john+investor&#64;dealmaker.tech\" should be passed as “john%2Binvestor%40dealmaker.tech”. There are two main ways to filter with it. ## Keyword filtering Some keywords allow you to filter investors based on a specific “scope” of the investors, for example using the string “Invited” will filter all investors with the status invited, and the keyword “Has attachments” will filter investors with attachments. Here’s a list of possible keywords and the “scope” each one of the keywords filters by: | Keywords | Scope | Decoded Example | Encoded Example | | ---------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Signed on \\(date range\\) | Investors who signed in the provided date range | Signed on (date range) [2020-07-01:2020-07-31] | `Signed%20on%20%28date%20range%29%20%5B2020-07-01%3A2020-07-31%5D` | | Enabled for countersignature on \\(date range\\) | Investors who were enabled for counter signature in the provided date range | Enabled for countersignature on (date range) [2022-05-24:2022-05-25] | `Enabled%20for%20countersignature%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Accepted on \\(date range\\) | Investors accepted in the provided date rage | Accepted on (date range) [2022-05-24:2022-05-25] | `Accepted%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Offline | Investors added to the deal offline | Offline | `Offline` | | Online | Investors added to the deal online | Online | `Online` | | Signed | Investors who signed their agreement | Signed | `Signed` | | Waiting for countersignature | Investors who have signed and are waiting for counter signature | Waiting for countersignature | `Waiting%20for%20countersignature` | | Invited | Investors on the Invited Status | Invited | `Invited` | | Accepted | Investors in the Accepted Status | Accepted | `Accepted` | | Questionnaire in progress | All Investors who have not finished completing the questionnaire | Questionnaire in progress | `Questionnaire%20in%20progress` | | Has attachments | All Investors with attachments | Has attachments | `Has%20attachments` | | Has notes | All Investors with notes | Has notes | `Has%20notes` | | Waiting for co-signature | Investors who have signed and are waiting for co-signature | Waiting for co-signature | `Waiting%20for%20co-signature` | | Background Check Approved | Investors with approved background check | Background Check Approved | `Background%20Check%20Approved` | | Document Review Pending | Investors with pending review | Document Review Pending | `Document%20Review%20Pending` | | Document Upload Pending | Investors with pending documents to upload | Document Upload Pending | `Document%20Upload%20Pending` | | Required adjudicator review | Investors who are required to be review by the adjudicator | Required adjudicator review | `Required%20adjudicator%20review` | --- **NOTE** Filtering keywords are case sensitive and need to be encoded --- ## Search String Any value for the parameter which does not match one of the keywords listed above, will use fields like `first name`, `last name`, `email`, `tags` to search for the investor. For example, if you search “Robert”, because this does not match one of the keywords listed above, it will then return any investors who have the string “Robert” in their name, email, or tags fields. # Versioning The latest version is v1. The version can be updated on the `Accept` header, just set the version as stated on the following example: ``` Accept:application/vnd.dealmaker-v1+json ``` | Version | Accept Header | | ------- | ----------------------------------- | | `v1` | application/vnd.dealmaker-`v1`+json | # SDK’s For instruction on installing SDKs, please view the following links - [Javascript](https://github.com/DealMakerTech/api/tree/main/v1/clients/javascript) - [Ruby](https://github.com/DealMakerTech/api/tree/main/v1/clients/ruby) # Webhooks Our webhooks functionality allows clients to automatically receive updates on a deal's investor data. Some of the data that the webhooks include: - Investor Name - Date created - Email - Phone - Allocation - Attachments - Accredited investor status - Accredited investor category - State (Draft, Invited, Signed, Accepted, Waiting, Inactive) Via webhooks clients can subscribe to the following events as they happen on Dealmaker: - Investor is created - Investor details are updated (any of the investor details above change or are updated) - Investor has signed their agreement - Invertor fully funded their investment - Investor has been accepted - Investor is deleted A URL supplied by the client will receive all the events with the information as part of the payload. Clients are able to add and update the URL within DealMaker. ## Configuration For a comprehensive guide on how to configure Webhooks please visit our support article: [Configuring Webhooks on DealMaker – DealMaker Support](https://help.dealmaker.tech/configuring-webhooks-on-dealmaker). As a developer user on DealMaker, you are able to configure webhooks by following the steps below: 1. Sign into Dealmaker 2. Go to **“Your profile”** in the top right corner 3. Access an **“Integrations”** configuration via the left menu 4. The developer configures webhooks by including: - The HTTPS URL where the request will be sent - Optionally, a security token that we would use to build a SHA1 hash that would be included in the request headers. The name of the header is `X-DealMaker-Signature`. If the secret is not specified, the hash won’t be included in the headers. - The Deal(s) to include in the webhook subscription - An email address that will be used to notify about errors. 5. The developers can disable webhooks temporarily if needed ## Specification ### Events The initial set of events will be related to the investor. The events are: 1. `investor.created` - Triggers every time a new investor is added to a deal 2. `investor.updated` - Triggers on updates to any of the following fields: - Status - Name - Email - (this is a user field so we trigger event for all investors with webhook subscription) - Allocated Amount - Investment Amount - Accredited investor fields - Adding or removing attachments - Tags - When the investor status is signed, the payload also includes a link to the signed document; the link expires after 30 minutes 3. `investor.signed` - Triggers when the investor signs their subscription agreement (terms and conditions) - When this happens the investor.state becomes `signed` - This event includes the same fields as the `investor.updated` event 4. `investor.funded` - Triggers when the investor becomes fully funded - This happens when the investor.funded_state becomes `funded` - This event includes the same fields as the `investor.updated` event 5. `investor.accepted` - Triggers when the investor is countersigned - When this happens the investor.state becomes `accepted` - This event includes the same fields as the `investor.updated` event 6. `investor.deleted` - Triggers when the investor is removed from the deal - The investor key of the payload only includes investor ID - The deal is not included in the payload. Due to our implementation it’s impossible to retrieve the deal the investor was part of ### Requests - The request is a `POST` - The payload’s `content-type` is `application/json` - Only `2XX` responses are considered successful. In the event of a different response, we consider it failed and queue the event for retry - We retry the request five times, after the initial attempt. Doubling the waiting time between intervals with each try. The first retry happens after 30 seconds, then 60 seconds, 2 mins, 4 minutes, and 8 minutes. This timing scheme gives the receiver about 1 hour if all the requests fail - If an event fails all the attempts to be delivered, we send an email to the address that the user configured ### Payload #### Common Properties There will be some properties that are common to all the events on the system. | Key | Type | Description | | ----------------- | ------ | -------------------------------------------------------------------------------------- | | event | String | The event that triggered the call | | event_id | String | A unique identifier for the event | | deal<sup>\\*</sup> | Object | The deal in which the event occurred. please see below for an example on the deal object<sup>\\*\\*</sup> | <sup>\\*</sup>This field is not included when deleting a resource <sup>\\*\\*</sup> Sample Deal Object in the webhook payload ```json \"deal\": { \"id\": 0, \"title\": \"string\", \"created_at\": \"2022-12-06T18:14:44.000Z\", \"updated_at\": \"2022-12-08T12:46:48.000Z\", \"state\": \"string\", \"currency\": \"string\", \"security_type\": \"string\", \"price_per_security\": 0.00, \"deal_type\": \"string\", \"minimum_investment\": 0, \"maximum_investment\": 0, \"issuer\": { \"id\": 0, \"name\": \"string\" }, \"enterprise\": { \"id\": 0, \"name\": \"string\" } } ``` #### Common Properties (investor scope) By design, we have incorporated on the webhooks payload the same investor-related fields included in the Investor model, for reference on the included fields, their types and values please click [here](https://docs.dealmaker.tech/#tag/investor_model). This will allow you to get all the necessary information you need about a particular investor without having to call the Get Investor by ID endpoint. | #### Investor State Here is a brief description of each investor state: - **Draft:** the investor is added to the platform but hasn't been invited yet and cannot access the portal - **Invited:** the investor was added to the platform but hasn’t completed the questionnaire - **Signed:** the investor signed the document (needs approval from Lawyer or Reviewer before countersignature) - **Waiting:** the investor was approved for countersignature by any of the Lawyers or Reviewers in the deal - **Accepted:** the investor's agreement was countersigned by the Signatory - **Inactive** the investor is no longer eligible to participate in the offering. This may be because their warrant expired, they requested a refund, or they opted out of the offering #### Update Delay Given the high number of updates our platform performs on any investor, we’ve added a cool down period on update events that allows us to “group” updates and trigger only one every minute. In consequence, update events will be delivered 1 minute after the initial request was made and will include the latest version of the investor data at delivery time.
5
+
6
+ The version of the OpenAPI document: 1.75.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.7.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest do
21
+ let(:instance) { DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest.new }
22
+
23
+ describe 'test an instance of PatchDealsIdPlatformEmailsDomainRequest' do
24
+ it 'should create an instance of PatchDealsIdPlatformEmailsDomainRequest' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "sender_name"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ describe 'test attribute "sender_email"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ end
@@ -33,6 +33,12 @@ describe DealMakerAPI::PostDealsIdInvestors do
33
33
  end
34
34
  end
35
35
 
36
+ describe 'test attribute "email_confirmation"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
36
42
  describe 'test attribute "investor_profile_id"' do
37
43
  it 'should work' do
38
44
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: DealMakerAPI
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.105.4
4
+ version: 0.106.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - DealMaker
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-06-17 00:00:00.000000000 Z
11
+ date: 2024-06-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -86,6 +86,7 @@ files:
86
86
  - docs/InvestorApi.md
87
87
  - docs/InvestorProfileApi.md
88
88
  - docs/PatchDealIncentivePlanRequest.md
89
+ - docs/PatchDealsIdPlatformEmailsDomainRequest.md
89
90
  - docs/PatchInvestorProfilesCorporations.md
90
91
  - docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md
91
92
  - docs/PatchInvestorProfilesIndividuals.md
@@ -252,6 +253,7 @@ files:
252
253
  - lib/DealMakerAPI/models/generate_url_request.rb
253
254
  - lib/DealMakerAPI/models/get_access_token_request.rb
254
255
  - lib/DealMakerAPI/models/patch_deal_incentive_plan_request.rb
256
+ - lib/DealMakerAPI/models/patch_deals_id_platform_emails_domain_request.rb
255
257
  - lib/DealMakerAPI/models/patch_investor_profiles_corporations.rb
256
258
  - lib/DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner.rb
257
259
  - lib/DealMakerAPI/models/patch_investor_profiles_individuals.rb
@@ -408,6 +410,7 @@ files:
408
410
  - spec/models/generate_url_request_spec.rb
409
411
  - spec/models/get_access_token_request_spec.rb
410
412
  - spec/models/patch_deal_incentive_plan_request_spec.rb
413
+ - spec/models/patch_deals_id_platform_emails_domain_request_spec.rb
411
414
  - spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb
412
415
  - spec/models/patch_investor_profiles_corporations_spec.rb
413
416
  - spec/models/patch_investor_profiles_individuals_spec.rb
@@ -557,159 +560,160 @@ signing_key:
557
560
  specification_version: 4
558
561
  summary: A ruby wrapper for the DealMaker API
559
562
  test_files:
560
- - spec/api/country_api_spec.rb
561
- - spec/api/deals_api_spec.rb
562
- - spec/api/investor_api_spec.rb
563
+ - spec/api/reservation_api_spec.rb
564
+ - spec/api/users_api_spec.rb
565
+ - spec/api/deal_api_spec.rb
563
566
  - spec/api/campaign_api_spec.rb
564
- - spec/api/user_api_spec.rb
565
- - spec/api/shareholder_api_spec.rb
566
- - spec/api/company_api_spec.rb
567
- - spec/api/default_api_spec.rb
568
567
  - spec/api/payments_api_spec.rb
569
568
  - spec/api/custom_emails_api_spec.rb
569
+ - spec/api/investor_api_spec.rb
570
+ - spec/api/country_api_spec.rb
571
+ - spec/api/deals_api_spec.rb
572
+ - spec/api/company_api_spec.rb
570
573
  - spec/api/upload_api_spec.rb
571
- - spec/api/investor_profile_api_spec.rb
572
- - spec/api/deal_api_spec.rb
573
574
  - spec/api/incentive_plan_api_spec.rb
574
- - spec/api/reservation_api_spec.rb
575
- - spec/api/users_api_spec.rb
576
- - spec/models/v1_entities_deal_investor_metrics_spec.rb
577
- - spec/models/v1_entities_presigned_url_result_spec.rb
578
- - spec/models/v1_entities_members_bulk_upload_spec.rb
579
- - spec/models/v1_entities_investor_profile_fields_provider_spec.rb
580
- - spec/models/v1_entities_deals_progress_page_summary_item_spec.rb
581
- - spec/models/v1_entities_webhooks_subscription_deals_spec.rb
575
+ - spec/api/default_api_spec.rb
576
+ - spec/api/investor_profile_api_spec.rb
577
+ - spec/api/user_api_spec.rb
578
+ - spec/api/shareholder_api_spec.rb
579
+ - spec/models/v1_entities_deals_incentive_plan_spec.rb
580
+ - spec/models/put_deals_id_investors_spec.rb
581
+ - spec/models/setup_sms_verification_request_spec.rb
582
+ - spec/models/add_document_request_spec.rb
582
583
  - spec/models/v1_entities_investor_profile_item_spec.rb
583
- - spec/models/create_company_request_spec.rb
584
- - spec/models/v1_entities_investor_profile_corporation_spec.rb
585
- - spec/models/v1_entities_investor_profile_fields_trustee_spec.rb
586
- - spec/models/v1_entities_investor_otp_access_link_spec.rb
587
- - spec/models/v1_entities_email_events_spec.rb
588
- - spec/models/v1_entities_deals_investors_payment_ach_bank_account_setup_intent_spec.rb
589
- - spec/models/v1_entities_investor_search_entities_spec.rb
590
- - spec/models/v1_entities_investor_user_spec.rb
591
- - spec/models/v1_entities_email_template_spec.rb
592
- - spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb
593
- - spec/models/v1_entities_money_entity_spec.rb
594
- - spec/models/v1_entities_addresses_spec.rb
595
- - spec/models/v1_entities_deal_setup_user_spec.rb
596
- - spec/models/patch_investor_request_spec.rb
597
- - spec/models/bulk_upload_investors_request_spec.rb
598
- - spec/models/post_webhooks_request_spec.rb
599
- - spec/models/v1_entities_users_two_factor_channel_spec.rb
584
+ - spec/models/v1_entities_state_spec.rb
585
+ - spec/models/v1_entities_dividends_spec.rb
586
+ - spec/models/send_verification_code_request_spec.rb
587
+ - spec/models/create_reservation_request_spec.rb
600
588
  - spec/models/v1_entities_dividend_spec.rb
589
+ - spec/models/v1_entities_deals_investors_payment_acss_bank_account_setup_intent_spec.rb
590
+ - spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb
591
+ - spec/models/v1_entities_investor_profile_fields_provider_spec.rb
592
+ - spec/models/v1_entities_presigned_url_result_spec.rb
593
+ - spec/models/create_bulk_upload_detail_request_spec.rb
594
+ - spec/models/v1_entities_shareholders_tags_spec.rb
595
+ - spec/models/v1_entities_background_check_search_spec.rb
596
+ - spec/models/v1_entities_deals_progress_spec.rb
597
+ - spec/models/v1_entities_investor_profiles_spec.rb
598
+ - spec/models/v1_entities_webhooks_subscription_spec.rb
599
+ - spec/models/v1_entities_email_events_spec.rb
600
+ - spec/models/v1_entities_user_spec.rb
601
+ - spec/models/send_portal_invite_request_spec.rb
602
+ - spec/models/patch_deals_id_platform_emails_domain_request_spec.rb
601
603
  - spec/models/v1_entities_investor_profile_joint_spec.rb
602
- - spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb
604
+ - spec/models/v1_entities_webhooks_security_token_spec.rb
605
+ - spec/models/v1_entities_webhooks_subscription_deal_spec.rb
606
+ - spec/models/patch_investor_profiles_managed_spec.rb
607
+ - spec/models/v1_entities_country_spec.rb
608
+ - spec/models/v1_entities_express_wire_instructions_spec.rb
609
+ - spec/models/v1_entities_bulk_uploads_spec.rb
610
+ - spec/models/v1_entities_subscription_agreement_spec.rb
603
611
  - spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb
604
- - spec/models/v1_entities_webhooks_subscription_spec.rb
605
- - spec/models/v1_entities_deals_platform_emails_domain_settings_spec.rb
606
- - spec/models/generate_url_request_spec.rb
607
- - spec/models/v1_entities_shareholder_spec.rb
608
- - spec/models/v1_entities_deals_incentive_plan_spec.rb
609
- - spec/models/v1_entities_deal_funding_metrics_spec.rb
610
- - spec/models/update_user_password_request_spec.rb
611
- - spec/models/v1_entities_users_two_factor_channels_spec.rb
612
- - spec/models/v1_entities_investor_profile_trust_spec.rb
613
- - spec/models/v1_entities_attachment_spec.rb
614
- - spec/models/edit_investor_tags_request_spec.rb
615
- - spec/models/get_access_token_request_spec.rb
616
- - spec/models/v1_entities_deals_progress_spec.rb
617
- - spec/models/v1_entities_state_spec.rb
618
- - spec/models/v1_entities_company_spec.rb
619
- - spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb
620
- - spec/models/v1_entities_investor_spec.rb
621
612
  - spec/models/v1_entities_investor_profile_fields_corporation_spec.rb
622
- - spec/models/v1_entities_deals_progress_kinds_spec.rb
623
- - spec/models/v1_entities_users_factor_spec.rb
624
- - spec/models/v1_entities_members_bulk_uploads_spec.rb
625
- - spec/models/send_portal_invite_request_spec.rb
626
- - spec/models/put_deals_id_investors_spec.rb
627
- - spec/models/add_document_request_spec.rb
628
- - spec/models/create_deal_setup_request_spec.rb
629
- - spec/models/v1_entities_beefree_access_token_spec.rb
630
- - spec/models/v1_entities_company_deal_spec.rb
631
- - spec/models/v1_entities_ttw_campaign_response_spec.rb
632
- - spec/models/v1_entities_shareholders_tags_spec.rb
633
- - spec/models/add506c_document_request_spec.rb
634
- - spec/models/v1_entities_investor_profile_fields_trust_spec.rb
635
- - spec/models/v1_entities_investor_profile_managed_spec.rb
636
- - spec/models/test_document_upload_email_request_spec.rb
637
- - spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb
638
- - spec/models/create_bulk_upload_request_spec.rb
639
- - spec/models/v1_entities_investor_profile_individual_spec.rb
613
+ - spec/models/patch_investor_profiles_individuals_spec.rb
614
+ - spec/models/post_investor_profiles_trusts_spec.rb
615
+ - spec/models/v1_entities_webhooks_deal_spec.rb
640
616
  - spec/models/post_deals_id_investors_spec.rb
641
- - spec/models/post_deal_incentive_plan_request_spec.rb
642
- - spec/models/send_verification_code_request_spec.rb
643
- - spec/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result_spec.rb
644
- - spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb
645
- - spec/models/v1_entities_subscription_agreement_spec.rb
617
+ - spec/models/v1_entities_deals_spec.rb
618
+ - spec/models/v1_entities_deal_setup_spec.rb
646
619
  - spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb
647
- - spec/models/v1_entities_bulk_upload_detail_spec.rb
648
- - spec/models/v1_entities_deals_progress_page_summary_spec.rb
649
- - spec/models/v1_entities_dividends_spec.rb
650
- - spec/models/create_members_bulk_upload_request_spec.rb
651
- - spec/models/patch_investor_profiles_joints_spec.rb
652
- - spec/models/v1_entities_bulk_upload_details_spec.rb
653
- - spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb
654
- - spec/models/v1_entities_investor_profile_address_spec.rb
620
+ - spec/models/create_shareholder_action_request_spec.rb
621
+ - spec/models/put_deals_id_script_tag_environment_request_spec.rb
622
+ - spec/models/v1_entities_investor_spec.rb
655
623
  - spec/models/request_new_document_request_spec.rb
656
- - spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb
657
- - spec/models/v1_entities_email_event_spec.rb
658
- - spec/models/patch_deal_incentive_plan_request_spec.rb
659
- - spec/models/v1_entities_generic_response_spec.rb
660
- - spec/models/v1_entities_users_binding_spec.rb
661
- - spec/models/v1_entities_background_check_search_spec.rb
624
+ - spec/models/v1_entities_investor_profile_managed_spec.rb
625
+ - spec/models/v1_entities_users_factor_spec.rb
626
+ - spec/models/v1_entities_deals_price_details_spec.rb
627
+ - spec/models/v1_entities_deals_progress_page_summary_item_spec.rb
628
+ - spec/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result_spec.rb
629
+ - spec/models/v1_entities_bulk_upload_detail_spec.rb
630
+ - spec/models/v1_entities_company_spec.rb
631
+ - spec/models/add506c_document_request_spec.rb
632
+ - spec/models/create_email_template_request_spec.rb
662
633
  - spec/models/v1_entities_investor_profile_id_spec.rb
663
- - spec/models/v1_entities_delete_result_spec.rb
664
- - spec/models/v1_entities_webhooks_subscription_deal_spec.rb
634
+ - spec/models/put_webhooks_id_request_spec.rb
665
635
  - spec/models/v1_entities_shareholder_ledger_spec.rb
666
- - spec/models/v1_entities_deal_setup_spec.rb
667
- - spec/models/v1_entities_deal_spec.rb
668
- - spec/models/v1_entities_deals_progress_column_spec.rb
669
- - spec/models/v1_entities_deal_issuer_spec.rb
670
- - spec/models/v1_entities_deals_incentive_plans_incentive_tier_spec.rb
671
- - spec/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data_spec.rb
672
- - spec/models/create_reservation_request_spec.rb
636
+ - spec/models/v1_entities_deal_funding_metrics_spec.rb
637
+ - spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb
638
+ - spec/models/v1_entities_ttw_reservation_spec.rb
673
639
  - spec/models/v1_entities_investor_profile_owner_spec.rb
674
- - spec/models/v1_entities_investors_spec.rb
640
+ - spec/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data_spec.rb
641
+ - spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb
642
+ - spec/models/post_investor_profiles_managed_spec.rb
643
+ - spec/models/v1_entities_investor_profile_trust_spec.rb
644
+ - spec/models/v1_entities_investor_profile_address_spec.rb
675
645
  - spec/models/v1_entities_countries_spec.rb
676
- - spec/models/v1_entities_country_spec.rb
677
- - spec/models/v1_entities_express_wire_instructions_spec.rb
678
- - spec/models/v1_entities_investor_search_entities_required_fields_spec.rb
679
- - spec/models/post_investor_profiles_corporations_spec.rb
680
- - spec/models/v1_entities_investor_profiles_spec.rb
681
- - spec/models/v1_entities_webhooks_deal_spec.rb
646
+ - spec/models/v1_entities_shareholder_spec.rb
647
+ - spec/models/v1_entities_deal_issuer_spec.rb
648
+ - spec/models/verify_sms_verification_request_spec.rb
649
+ - spec/models/v1_entities_deal_spec.rb
650
+ - spec/models/v1_entities_users_binding_spec.rb
651
+ - spec/models/v1_entities_deals_incentive_plans_incentive_tier_spec.rb
652
+ - spec/models/v1_entities_generic_response_spec.rb
653
+ - spec/models/patch_investor_request_spec.rb
654
+ - spec/models/patch_investor_profiles_trusts_spec.rb
655
+ - spec/models/patch_deal_incentive_plan_request_spec.rb
656
+ - spec/models/generate_url_request_spec.rb
657
+ - spec/models/v1_entities_bulk_upload_details_spec.rb
682
658
  - spec/models/post_investor_profiles_joints_spec.rb
683
659
  - spec/models/v1_entities_deal_enterprise_spec.rb
684
- - spec/models/v1_entities_shareholders_spec.rb
660
+ - spec/models/v1_entities_email_template_spec.rb
661
+ - spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb
662
+ - spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb
663
+ - spec/models/v1_entities_investor_profile_individual_spec.rb
664
+ - spec/models/post_investor_profiles_corporations_spec.rb
665
+ - spec/models/post_deal_incentive_plan_request_spec.rb
666
+ - spec/models/update_user_password_request_spec.rb
667
+ - spec/models/v1_entities_address_spec.rb
668
+ - spec/models/v1_entities_company_deals_spec.rb
669
+ - spec/models/v1_entities_members_bulk_uploads_spec.rb
670
+ - spec/models/v1_entities_deals_progress_column_spec.rb
671
+ - spec/models/v1_entities_addresses_spec.rb
672
+ - spec/models/v1_entities_attachment_spec.rb
673
+ - spec/models/v1_entities_email_event_spec.rb
685
674
  - spec/models/patch_investor_profiles_corporations_spec.rb
686
- - spec/models/patch_investor_profiles_trusts_spec.rb
687
- - spec/models/v1_entities_ttw_reservation_spec.rb
688
- - spec/models/verify_factor_request_spec.rb
689
- - spec/models/setup_sms_verification_request_spec.rb
690
- - spec/models/put_deals_id_script_tag_environment_request_spec.rb
691
- - spec/models/v1_entities_bulk_uploads_spec.rb
692
- - spec/models/v1_entities_user_spec.rb
675
+ - spec/models/v1_entities_users_two_factor_channels_spec.rb
676
+ - spec/models/v1_entities_investor_search_entities_spec.rb
677
+ - spec/models/v1_entities_deals_progress_page_summary_spec.rb
678
+ - spec/models/v1_entities_ttw_campaign_response_spec.rb
679
+ - spec/models/create_members_bulk_upload_request_spec.rb
680
+ - spec/models/v1_entities_webhooks_subscription_deals_spec.rb
681
+ - spec/models/v1_entities_money_entity_spec.rb
682
+ - spec/models/create_deal_setup_request_spec.rb
683
+ - spec/models/v1_entities_investor_profile_fields_trust_spec.rb
684
+ - spec/models/v1_entities_investor_otp_access_link_spec.rb
685
+ - spec/models/v1_entities_deals_platform_emails_domain_settings_spec.rb
686
+ - spec/models/bulk_upload_investors_request_spec.rb
687
+ - spec/models/post_webhooks_request_spec.rb
693
688
  - spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb
694
- - spec/models/create_shareholder_action_request_spec.rb
695
- - spec/models/post_investor_profiles_trusts_spec.rb
689
+ - spec/models/v1_entities_members_bulk_upload_spec.rb
690
+ - spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb
691
+ - spec/models/create_company_request_spec.rb
692
+ - spec/models/v1_entities_deal_investor_metrics_spec.rb
696
693
  - spec/models/post_investor_profiles_individuals_spec.rb
697
- - spec/models/patch_investor_profiles_managed_spec.rb
698
- - spec/models/v1_entities_deals_price_details_spec.rb
699
- - spec/models/put_webhooks_id_request_spec.rb
700
- - spec/models/create_bulk_upload_detail_request_spec.rb
701
- - spec/models/post_investor_profiles_managed_spec.rb
702
- - spec/models/v1_entities_company_deals_spec.rb
703
- - spec/models/verify_sms_verification_request_spec.rb
704
- - spec/models/v1_entities_address_spec.rb
705
- - spec/models/v1_entities_bulk_upload_spec.rb
694
+ - spec/models/v1_entities_investors_spec.rb
695
+ - spec/models/test_document_upload_email_request_spec.rb
696
+ - spec/models/v1_entities_deal_setup_user_spec.rb
697
+ - spec/models/v1_entities_investor_profile_corporation_spec.rb
698
+ - spec/models/v1_entities_investor_user_spec.rb
699
+ - spec/models/v1_entities_shareholders_spec.rb
700
+ - spec/models/patch_investor_profiles_joints_spec.rb
701
+ - spec/models/v1_entities_investor_search_entities_required_fields_spec.rb
702
+ - spec/models/verify_factor_request_spec.rb
703
+ - spec/models/v1_entities_users_two_factor_channel_spec.rb
706
704
  - spec/models/v1_entities_express_wire_instruction_spec.rb
707
- - spec/models/v1_entities_users_verification_resources_spec.rb
708
- - spec/models/v1_entities_deals_investors_payment_acss_bank_account_setup_intent_spec.rb
709
- - spec/models/patch_investor_profiles_individuals_spec.rb
705
+ - spec/models/v1_entities_beefree_access_token_spec.rb
710
706
  - spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result_spec.rb
711
- - spec/models/v1_entities_deals_spec.rb
712
- - spec/models/create_email_template_request_spec.rb
713
- - spec/models/v1_entities_webhooks_security_token_spec.rb
707
+ - spec/models/v1_entities_bulk_upload_spec.rb
708
+ - spec/models/v1_entities_delete_result_spec.rb
709
+ - spec/models/edit_investor_tags_request_spec.rb
710
+ - spec/models/create_bulk_upload_request_spec.rb
711
+ - spec/models/v1_entities_investor_profile_fields_trustee_spec.rb
712
+ - spec/models/v1_entities_deals_progress_kinds_spec.rb
714
713
  - spec/models/run_background_search_request_spec.rb
714
+ - spec/models/v1_entities_deals_investors_payment_ach_bank_account_setup_intent_spec.rb
715
+ - spec/models/v1_entities_company_deal_spec.rb
716
+ - spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb
717
+ - spec/models/get_access_token_request_spec.rb
718
+ - spec/models/v1_entities_users_verification_resources_spec.rb
715
719
  - spec/spec_helper.rb