DealMakerAPI 0.91.2 → 0.91.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -7
  3. data/docs/DealApi.md +69 -0
  4. data/docs/DefaultApi.md +67 -0
  5. data/docs/InvestorApi.md +4 -4
  6. data/docs/InvestorProfileApi.md +67 -0
  7. data/docs/PostInvestorProfilesManaged.md +68 -0
  8. data/docs/{V1EntitiesInvestorIncentivePlan.md → V1EntitiesDealsIncentivePlan.md} +2 -2
  9. data/docs/{V1EntitiesInvestorIncentiveTier.md → V1EntitiesDealsIncentivePlansIncentiveTier.md} +2 -2
  10. data/docs/V1EntitiesDealsPriceDetails.md +28 -0
  11. data/docs/V1EntitiesInvestorProfileFieldsBeneficiary.md +32 -0
  12. data/docs/V1EntitiesInvestorProfileFieldsProvider.md +30 -0
  13. data/docs/V1EntitiesInvestorProfileItem.md +1 -1
  14. data/docs/V1EntitiesInvestorProfileManaged.md +38 -0
  15. data/docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md +18 -0
  16. data/lib/DealMakerAPI/api/deal_api.rb +66 -0
  17. data/lib/DealMakerAPI/api/default_api.rb +63 -0
  18. data/lib/DealMakerAPI/api/investor_api.rb +3 -3
  19. data/lib/DealMakerAPI/api/investor_profile_api.rb +68 -0
  20. data/lib/DealMakerAPI/models/post_investor_profiles_managed.rb +519 -0
  21. data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_plan.rb → v1_entities_deals_incentive_plan.rb} +37 -3
  22. data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_tier.rb → v1_entities_deals_incentive_plans_incentive_tier.rb} +3 -3
  23. data/lib/DealMakerAPI/models/{v1_entities_investor_price_details.rb → v1_entities_deals_price_details.rb} +27 -7
  24. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +2 -2
  25. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary.rb +284 -0
  26. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_provider.rb +274 -0
  27. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +2 -2
  28. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
  29. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +2 -2
  30. data/lib/DealMakerAPI/models/v1_entities_investor_profile_managed.rb +347 -0
  31. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +2 -2
  32. data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data.rb +216 -0
  33. data/lib/DealMakerAPI/version.rb +1 -1
  34. data/lib/DealMakerAPI.rb +8 -3
  35. data/spec/api/deal_api_spec.rb +13 -0
  36. data/spec/api/default_api_spec.rb +12 -0
  37. data/spec/api/investor_api_spec.rb +1 -1
  38. data/spec/api/investor_profile_api_spec.rb +12 -0
  39. data/spec/models/post_investor_profiles_managed_spec.rb +194 -0
  40. data/spec/models/{v1_entities_investor_incentive_plan_spec.rb → v1_entities_deals_incentive_plan_spec.rb} +10 -6
  41. data/spec/models/{v1_entities_investor_incentive_tier_spec.rb → v1_entities_deals_incentive_plans_incentive_tier_spec.rb} +6 -6
  42. data/spec/models/{v1_entities_investor_price_details_spec.rb → v1_entities_deals_price_details_spec.rb} +18 -6
  43. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
  44. data/spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb +78 -0
  45. data/spec/models/v1_entities_investor_profile_fields_provider_spec.rb +72 -0
  46. data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
  47. data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
  48. data/spec/models/v1_entities_investor_profile_managed_spec.rb +100 -0
  49. data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
  50. data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb +36 -0
  51. metadata +119 -99
  52. data/docs/V1EntitiesInvestorPriceDetails.md +0 -24
data/lib/DealMakerAPI.rb CHANGED
@@ -39,6 +39,7 @@ require 'DealMakerAPI/models/post_investor_profiles_corporations'
39
39
  require 'DealMakerAPI/models/post_investor_profiles_corporations_beneficial_owners_inner'
40
40
  require 'DealMakerAPI/models/post_investor_profiles_individuals'
41
41
  require 'DealMakerAPI/models/post_investor_profiles_joints'
42
+ require 'DealMakerAPI/models/post_investor_profiles_managed'
42
43
  require 'DealMakerAPI/models/post_investor_profiles_trusts'
43
44
  require 'DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner'
44
45
  require 'DealMakerAPI/models/post_webhooks_request'
@@ -69,28 +70,31 @@ require 'DealMakerAPI/models/v1_entities_deal_issuer'
69
70
  require 'DealMakerAPI/models/v1_entities_deal_setup'
70
71
  require 'DealMakerAPI/models/v1_entities_deal_setup_user'
71
72
  require 'DealMakerAPI/models/v1_entities_deals'
73
+ require 'DealMakerAPI/models/v1_entities_deals_incentive_plan'
74
+ require 'DealMakerAPI/models/v1_entities_deals_incentive_plans_incentive_tier'
75
+ require 'DealMakerAPI/models/v1_entities_deals_price_details'
72
76
  require 'DealMakerAPI/models/v1_entities_dividend'
73
77
  require 'DealMakerAPI/models/v1_entities_dividends'
74
78
  require 'DealMakerAPI/models/v1_entities_express_wire_instruction'
75
79
  require 'DealMakerAPI/models/v1_entities_express_wire_instructions'
76
80
  require 'DealMakerAPI/models/v1_entities_generic_response'
77
81
  require 'DealMakerAPI/models/v1_entities_investor'
78
- require 'DealMakerAPI/models/v1_entities_investor_incentive_plan'
79
- require 'DealMakerAPI/models/v1_entities_investor_incentive_tier'
80
82
  require 'DealMakerAPI/models/v1_entities_investor_otp_access_link'
81
- require 'DealMakerAPI/models/v1_entities_investor_price_details'
82
83
  require 'DealMakerAPI/models/v1_entities_investor_profile_address'
83
84
  require 'DealMakerAPI/models/v1_entities_investor_profile_corporation'
84
85
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder'
85
86
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_beneficial_owner'
87
+ require 'DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary'
86
88
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_corporation'
87
89
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder'
90
+ require 'DealMakerAPI/models/v1_entities_investor_profile_fields_provider'
88
91
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_signing_officer'
89
92
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_trust'
90
93
  require 'DealMakerAPI/models/v1_entities_investor_profile_fields_trustee'
91
94
  require 'DealMakerAPI/models/v1_entities_investor_profile_individual'
92
95
  require 'DealMakerAPI/models/v1_entities_investor_profile_item'
93
96
  require 'DealMakerAPI/models/v1_entities_investor_profile_joint'
97
+ require 'DealMakerAPI/models/v1_entities_investor_profile_managed'
94
98
  require 'DealMakerAPI/models/v1_entities_investor_profile_owner'
95
99
  require 'DealMakerAPI/models/v1_entities_investor_profile_trust'
96
100
  require 'DealMakerAPI/models/v1_entities_investor_profiles'
@@ -98,6 +102,7 @@ require 'DealMakerAPI/models/v1_entities_investor_user'
98
102
  require 'DealMakerAPI/models/v1_entities_investors'
99
103
  require 'DealMakerAPI/models/v1_entities_money_entity'
100
104
  require 'DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data'
105
+ require 'DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data'
101
106
  require 'DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result'
102
107
  require 'DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result'
103
108
  require 'DealMakerAPI/models/v1_entities_presigned_url_result'
@@ -56,6 +56,19 @@ describe 'DealApi' do
56
56
  end
57
57
  end
58
58
 
59
+ # unit tests for get_deal_incentive_plan
60
+ # Get incentive plan by deal id
61
+ # Gets the current active incentive plan for the given deal id.
62
+ # @param id The deal id.
63
+ # @param [Hash] opts the optional parameters
64
+ # @option opts [Float] :investment_amount The investment amount to get the security price for.
65
+ # @return [V1EntitiesDealsPriceDetails]
66
+ describe 'get_deal_incentive_plan test' do
67
+ it 'should work' do
68
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
69
+ end
70
+ end
71
+
59
72
  # unit tests for list_deals
60
73
  # List available deals
61
74
  # List available deals
@@ -44,6 +44,18 @@ describe 'DefaultApi' do
44
44
  end
45
45
  end
46
46
 
47
+ # unit tests for get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data
48
+ # Get payout account data
49
+ # Get payout account data
50
+ # @param deal_id
51
+ # @param [Hash] opts the optional parameters
52
+ # @return [V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData]
53
+ describe 'get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data test' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
56
+ end
57
+ end
58
+
47
59
  # unit tests for get_deals_id_investors_investor_id_payments_express_wire_instructions
48
60
  # Displays the express wire instructions for an investor on a deal
49
61
  # Get express wire instructions
@@ -147,7 +147,7 @@ describe 'InvestorApi' do
147
147
  # @param id The deal id.
148
148
  # @param investor_id The investor id.
149
149
  # @param [Hash] opts the optional parameters
150
- # @return [V1EntitiesInvestorPriceDetails]
150
+ # @return [V1EntitiesDealsPriceDetails]
151
151
  describe 'get_incentive_plan test' do
152
152
  it 'should work' do
153
153
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -68,6 +68,18 @@ describe 'InvestorProfileApi' do
68
68
  end
69
69
  end
70
70
 
71
+ # unit tests for create_managed_profile
72
+ # Create new managed investor profile.
73
+ # Create new managed investor profile associated to the user by email.
74
+ # @param investor_profiles_managed
75
+ # @param [Hash] opts the optional parameters
76
+ # @return [V1EntitiesInvestorProfileManaged]
77
+ describe 'create_managed_profile test' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
80
+ end
81
+ end
82
+
71
83
  # unit tests for create_trust_profile
72
84
  # Create new trust investor profile.
73
85
  # Create new trust investor profile associated to the user by email.
@@ -0,0 +1,194 @@
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
+ OpenAPI Generator version: 7.2.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for DealMakerAPI::PostInvestorProfilesManaged
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe DealMakerAPI::PostInvestorProfilesManaged do
21
+ let(:instance) { DealMakerAPI::PostInvestorProfilesManaged.new }
22
+
23
+ describe 'test an instance of PostInvestorProfilesManaged' do
24
+ it 'should create an instance of PostInvestorProfilesManaged' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(DealMakerAPI::PostInvestorProfilesManaged)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "email"' 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 "us_accredited_category"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["income_individual", "assets_individual", "director", "knowledgable_employee", "broker_or_dealer", "investment_advisor_registered", "investment_advisor_relying", "designated_accredited_investor", "not_accredited"])
40
+ # validator.allowable_values.each do |value|
41
+ # expect { instance.us_accredited_category = value }.not_to raise_error
42
+ # end
43
+ end
44
+ end
45
+
46
+ describe 'test attribute "ca_accredited_investor"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["d", "e", "e_1", "j", "j_1", "k_alone", "k_spouse", "l", "q", "v", "x"])
50
+ # validator.allowable_values.each do |value|
51
+ # expect { instance.ca_accredited_investor = value }.not_to raise_error
52
+ # end
53
+ end
54
+ end
55
+
56
+ describe 'test attribute "name"' do
57
+ it 'should work' do
58
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
59
+ end
60
+ end
61
+
62
+ describe 'test attribute "street_address"' do
63
+ it 'should work' do
64
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
65
+ end
66
+ end
67
+
68
+ describe 'test attribute "unit2"' do
69
+ it 'should work' do
70
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
71
+ end
72
+ end
73
+
74
+ describe 'test attribute "city"' do
75
+ it 'should work' do
76
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
77
+ end
78
+ end
79
+
80
+ describe 'test attribute "region"' do
81
+ it 'should work' do
82
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
83
+ end
84
+ end
85
+
86
+ describe 'test attribute "postal_code"' do
87
+ it 'should work' do
88
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
89
+ end
90
+ end
91
+
92
+ describe 'test attribute "taxpayer_id"' do
93
+ it 'should work' do
94
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
95
+ end
96
+ end
97
+
98
+ describe 'test attribute "confirmation"' do
99
+ it 'should work' do
100
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
101
+ end
102
+ end
103
+
104
+ describe 'test attribute "income"' do
105
+ it 'should work' do
106
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
107
+ end
108
+ end
109
+
110
+ describe 'test attribute "net_worth"' do
111
+ it 'should work' do
112
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
113
+ end
114
+ end
115
+
116
+ describe 'test attribute "reg_cf_prior_offerings_amount"' do
117
+ it 'should work' do
118
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
119
+ end
120
+ end
121
+
122
+ describe 'test attribute "beneficiary_account_number"' do
123
+ it 'should work' do
124
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
125
+ end
126
+ end
127
+
128
+ describe 'test attribute "beneficiary_first_name"' do
129
+ it 'should work' do
130
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
131
+ end
132
+ end
133
+
134
+ describe 'test attribute "beneficiary_last_name"' do
135
+ it 'should work' do
136
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
137
+ end
138
+ end
139
+
140
+ describe 'test attribute "beneficiary_suffix"' do
141
+ it 'should work' do
142
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
143
+ end
144
+ end
145
+
146
+ describe 'test attribute "beneficiary_street_address"' do
147
+ it 'should work' do
148
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
149
+ end
150
+ end
151
+
152
+ describe 'test attribute "beneficiary_unit2"' do
153
+ it 'should work' do
154
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
155
+ end
156
+ end
157
+
158
+ describe 'test attribute "beneficiary_city"' do
159
+ it 'should work' do
160
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
161
+ end
162
+ end
163
+
164
+ describe 'test attribute "beneficiary_region"' do
165
+ it 'should work' do
166
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
167
+ end
168
+ end
169
+
170
+ describe 'test attribute "beneficiary_postal_code"' do
171
+ it 'should work' do
172
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
173
+ end
174
+ end
175
+
176
+ describe 'test attribute "beneficiary_date_of_birth"' do
177
+ it 'should work' do
178
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
179
+ end
180
+ end
181
+
182
+ describe 'test attribute "beneficiary_taxpayer_id"' do
183
+ it 'should work' do
184
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
185
+ end
186
+ end
187
+
188
+ describe 'test attribute "beneficiary_phone_number"' do
189
+ it 'should work' do
190
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
191
+ end
192
+ end
193
+
194
+ end
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for DealMakerAPI::V1EntitiesInvestorIncentivePlan
17
+ # Unit tests for DealMakerAPI::V1EntitiesDealsIncentivePlan
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe DealMakerAPI::V1EntitiesInvestorIncentivePlan do
21
- let(:instance) { DealMakerAPI::V1EntitiesInvestorIncentivePlan.new }
20
+ describe DealMakerAPI::V1EntitiesDealsIncentivePlan do
21
+ let(:instance) { DealMakerAPI::V1EntitiesDealsIncentivePlan.new }
22
22
 
23
- describe 'test an instance of V1EntitiesInvestorIncentivePlan' do
24
- it 'should create an instance of V1EntitiesInvestorIncentivePlan' do
23
+ describe 'test an instance of V1EntitiesDealsIncentivePlan' do
24
+ it 'should create an instance of V1EntitiesDealsIncentivePlan' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesInvestorIncentivePlan)
26
+ #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesDealsIncentivePlan)
27
27
  end
28
28
  end
29
29
 
@@ -42,6 +42,10 @@ describe DealMakerAPI::V1EntitiesInvestorIncentivePlan do
42
42
  describe 'test attribute "plan_type"' do
43
43
  it 'should work' do
44
44
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["time"])
46
+ # validator.allowable_values.each do |value|
47
+ # expect { instance.plan_type = value }.not_to raise_error
48
+ # end
45
49
  end
46
50
  end
47
51
 
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for DealMakerAPI::V1EntitiesInvestorIncentiveTier
17
+ # Unit tests for DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe DealMakerAPI::V1EntitiesInvestorIncentiveTier do
21
- let(:instance) { DealMakerAPI::V1EntitiesInvestorIncentiveTier.new }
20
+ describe DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier do
21
+ let(:instance) { DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier.new }
22
22
 
23
- describe 'test an instance of V1EntitiesInvestorIncentiveTier' do
24
- it 'should create an instance of V1EntitiesInvestorIncentiveTier' do
23
+ describe 'test an instance of V1EntitiesDealsIncentivePlansIncentiveTier' do
24
+ it 'should create an instance of V1EntitiesDealsIncentivePlansIncentiveTier' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesInvestorIncentiveTier)
26
+ #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier)
27
27
  end
28
28
  end
29
29
 
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for DealMakerAPI::V1EntitiesInvestorPriceDetails
17
+ # Unit tests for DealMakerAPI::V1EntitiesDealsPriceDetails
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe DealMakerAPI::V1EntitiesInvestorPriceDetails do
21
- let(:instance) { DealMakerAPI::V1EntitiesInvestorPriceDetails.new }
20
+ describe DealMakerAPI::V1EntitiesDealsPriceDetails do
21
+ let(:instance) { DealMakerAPI::V1EntitiesDealsPriceDetails.new }
22
22
 
23
- describe 'test an instance of V1EntitiesInvestorPriceDetails' do
24
- it 'should create an instance of V1EntitiesInvestorPriceDetails' do
23
+ describe 'test an instance of V1EntitiesDealsPriceDetails' do
24
+ it 'should create an instance of V1EntitiesDealsPriceDetails' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesInvestorPriceDetails)
26
+ #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesDealsPriceDetails)
27
27
  end
28
28
  end
29
29
 
@@ -39,6 +39,18 @@ describe DealMakerAPI::V1EntitiesInvestorPriceDetails do
39
39
  end
40
40
  end
41
41
 
42
+ describe 'test attribute "computed_investment_amount"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ describe 'test attribute "computed_number_of_securities"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
42
54
  describe 'test attribute "effective_tier"' do
43
55
  it 'should work' do
44
56
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -48,7 +48,7 @@ describe DealMakerAPI::V1EntitiesInvestorProfileCorporation do
48
48
  describe 'test attribute "type"' do
49
49
  it 'should work' do
50
50
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust"])
51
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust", "managed"])
52
52
  # validator.allowable_values.each do |value|
53
53
  # expect { instance.type = value }.not_to raise_error
54
54
  # end
@@ -0,0 +1,78 @@
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
+ OpenAPI Generator version: 7.2.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary do
21
+ let(:instance) { DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary.new }
22
+
23
+ describe 'test an instance of V1EntitiesInvestorProfileFieldsBeneficiary' do
24
+ it 'should create an instance of V1EntitiesInvestorProfileFieldsBeneficiary' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "first_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 "last_name"' 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
+ describe 'test attribute "suffix"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ describe 'test attribute "date_of_birth"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
54
+ describe 'test attribute "taxpayer_id"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ end
58
+ end
59
+
60
+ describe 'test attribute "address"' do
61
+ it 'should work' do
62
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
63
+ end
64
+ end
65
+
66
+ describe 'test attribute "account_number"' do
67
+ it 'should work' do
68
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
69
+ end
70
+ end
71
+
72
+ describe 'test attribute "phone_number"' do
73
+ it 'should work' do
74
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
75
+ end
76
+ end
77
+
78
+ end