DealMakerAPI 0.88.4 → 0.89.1

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: 58b35b1158f5cc0748eeea3f6dc353c5383c297db2e243bd486d112ac99f34a3
4
- data.tar.gz: 26948c085409167decad23fa3d18e673cea880e1b0c4c7f5a0d77e92c4d26610
3
+ metadata.gz: 1c625a5e8bf9fbb8eb234487aae2a788e29971509cb1655443bd2ff77a539b14
4
+ data.tar.gz: 8cc72859c98f179c84e52115d685b8934d2b58cdd25fecd66ebd764e88e8db69
5
5
  SHA512:
6
- metadata.gz: afc57e69989e30bdd320f33d576a8c49f588592bbdb6800fea6596e29405ca88d6308c7720f09d0912ee605dfea46ac68d297c0ebae9f3bb2cd937c3c186d48c
7
- data.tar.gz: e0ca5e57db2e016af1e911c3b2d84061cc217de9d3a48512ccd91b84e93f5d737d3f9185659353dcd829e599a53c4634edbe12e4d609b2270a5415fd152e0717
6
+ metadata.gz: 0ae1572b58f3b06c95462b10972b16ae0264741bec947d888152d272b831ef2104fcc52e1c1e6014b5f8452908ea9f9b115c700bd2121fd73e83149abcf07a1c
7
+ data.tar.gz: 4081df217ac55c69651784d5da10ab926c6f1036a577a3d8168c80f8ed0aee3713b31b185eeabc55d8d0979a187daa628f531dcc42a976d221b1e3739f7d6960
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.88.4
341
+ - Package version: 0.89.1
342
342
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
343
343
 
344
344
  ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
354
354
  Then either install the gem locally:
355
355
 
356
356
  ```shell
357
- gem install ./DealMakerAPI-0.88.4.gem
357
+ gem install ./DealMakerAPI-0.89.1.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.88.4.gem` to install the development dependencies)
360
+ (for development, run `gem install --dev ./DealMakerAPI-0.89.1.gem` to install the development dependencies)
361
361
 
362
362
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
363
363
 
364
364
  Finally add this to the Gemfile:
365
365
 
366
- gem 'DealMakerAPI', '~> 0.88.4'
366
+ gem 'DealMakerAPI', '~> 0.89.1'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -481,6 +481,7 @@ Class | Method | HTTP request | Description
481
481
  - [DealMakerAPI::PatchInvestorProfilesIndividuals](docs/PatchInvestorProfilesIndividuals.md)
482
482
  - [DealMakerAPI::PatchInvestorProfilesJoints](docs/PatchInvestorProfilesJoints.md)
483
483
  - [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
484
+ - [DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner](docs/PatchInvestorProfilesTrustsTrusteesInner.md)
484
485
  - [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
485
486
  - [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
486
487
  - [DealMakerAPI::PostInvestorProfilesCorporations](docs/PostInvestorProfilesCorporations.md)
@@ -17,16 +17,7 @@
17
17
  | **income** | **Float** | The income of the Trust. | [optional] |
18
18
  | **net_worth** | **Float** | The net worth of the Trust. | [optional] |
19
19
  | **reg_cf_prior_offerings_amount** | **Float** | The prior offering amount of the Trust. | [optional] |
20
- | **trustee_first_name** | **String** | Trustee first name. | [optional] |
21
- | **trustee_last_name** | **String** | Trustee last name. | [optional] |
22
- | **trustee_suffix** | **String** | Trustee suffix. | [optional] |
23
- | **trustee_street_address** | **String** | Trustee street address. | [optional] |
24
- | **trustee_unit2** | **String** | Trustee street address line 2. | [optional] |
25
- | **trustee_city** | **String** | Trustee city. | [optional] |
26
- | **trustee_region** | **String** | Trustee region or state. | [optional] |
27
- | **trustee_postal_code** | **String** | Trustee postal code or zipcode. | [optional] |
28
- | **trustee_date_of_birth** | **String** | Trustee date of birth. | [optional] |
29
- | **trustee_taxpayer_id** | **String** | The taxpayer identification number of the investor profile. | [optional] |
20
+ | **trustees** | [**Array<PatchInvestorProfilesTrustsTrusteesInner>**](PatchInvestorProfilesTrustsTrusteesInner.md) | | [optional] |
30
21
 
31
22
  ## Example
32
23
 
@@ -47,16 +38,7 @@ instance = DealMakerAPI::PatchInvestorProfilesTrusts.new(
47
38
  income: null,
48
39
  net_worth: null,
49
40
  reg_cf_prior_offerings_amount: null,
50
- trustee_first_name: null,
51
- trustee_last_name: null,
52
- trustee_suffix: null,
53
- trustee_street_address: null,
54
- trustee_unit2: null,
55
- trustee_city: null,
56
- trustee_region: null,
57
- trustee_postal_code: null,
58
- trustee_date_of_birth: null,
59
- trustee_taxpayer_id: null
41
+ trustees: null
60
42
  )
61
43
  ```
62
44
 
@@ -0,0 +1,40 @@
1
+ # DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **index** | **Integer** | The index of the trustee. | |
8
+ | **_delete** | **Boolean** | If true, this entry will be cleared. | [optional] |
9
+ | **first_name** | **String** | The list of first names for the trustees (required for trustee 1). | [optional] |
10
+ | **last_name** | **String** | The list of last names for the trustees (required for trustee 1). | [optional] |
11
+ | **suffix** | **String** | The list of suffixes for the trustees. | [optional] |
12
+ | **street_address** | **String** | The list of street addresses for the trustees (required for trustee 1). | [optional] |
13
+ | **unit2** | **String** | The list of street address line 2 for the trustees. | [optional] |
14
+ | **city** | **String** | The list of cities for the trustees (required for trustee 1). | [optional] |
15
+ | **region** | **String** | The list of regions or states for the trustees (required for trustee 1). | [optional] |
16
+ | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required for trustee 1). | [optional] |
17
+ | **date_of_birth** | **String** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
18
+ | **taxpayer_id** | **String** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'DealMakerAPI'
24
+
25
+ instance = DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner.new(
26
+ index: null,
27
+ _delete: null,
28
+ first_name: null,
29
+ last_name: null,
30
+ suffix: null,
31
+ street_address: null,
32
+ unit2: null,
33
+ city: null,
34
+ region: null,
35
+ postal_code: null,
36
+ date_of_birth: null,
37
+ taxpayer_id: null
38
+ )
39
+ ```
40
+
@@ -11,7 +11,7 @@
11
11
  | **unit2** | **String** | The list of street address line 2 for the trustees. | [optional] |
12
12
  | **city** | **String** | The list of cities for the trustees (required for trustee 1). | [optional] |
13
13
  | **region** | **String** | The list of regions or states for the trustees (required for trustee 1). | [optional] |
14
- | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required) for trustee 1. | [optional] |
14
+ | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required for trustee 1). | [optional] |
15
15
  | **date_of_birth** | **String** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
16
16
  | **taxpayer_id** | **String** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
17
17
 
@@ -55,35 +55,7 @@ module DealMakerAPI
55
55
  # The prior offering amount of the Trust.
56
56
  attr_accessor :reg_cf_prior_offerings_amount
57
57
 
58
- # Trustee first name.
59
- attr_accessor :trustee_first_name
60
-
61
- # Trustee last name.
62
- attr_accessor :trustee_last_name
63
-
64
- # Trustee suffix.
65
- attr_accessor :trustee_suffix
66
-
67
- # Trustee street address.
68
- attr_accessor :trustee_street_address
69
-
70
- # Trustee street address line 2.
71
- attr_accessor :trustee_unit2
72
-
73
- # Trustee city.
74
- attr_accessor :trustee_city
75
-
76
- # Trustee region or state.
77
- attr_accessor :trustee_region
78
-
79
- # Trustee postal code or zipcode.
80
- attr_accessor :trustee_postal_code
81
-
82
- # Trustee date of birth.
83
- attr_accessor :trustee_date_of_birth
84
-
85
- # The taxpayer identification number of the investor profile.
86
- attr_accessor :trustee_taxpayer_id
58
+ attr_accessor :trustees
87
59
 
88
60
  class EnumAttributeValidator
89
61
  attr_reader :datatype
@@ -123,16 +95,7 @@ module DealMakerAPI
123
95
  :'income' => :'income',
124
96
  :'net_worth' => :'net_worth',
125
97
  :'reg_cf_prior_offerings_amount' => :'reg_cf_prior_offerings_amount',
126
- :'trustee_first_name' => :'trustee_first_name',
127
- :'trustee_last_name' => :'trustee_last_name',
128
- :'trustee_suffix' => :'trustee_suffix',
129
- :'trustee_street_address' => :'trustee_street_address',
130
- :'trustee_unit2' => :'trustee_unit2',
131
- :'trustee_city' => :'trustee_city',
132
- :'trustee_region' => :'trustee_region',
133
- :'trustee_postal_code' => :'trustee_postal_code',
134
- :'trustee_date_of_birth' => :'trustee_date_of_birth',
135
- :'trustee_taxpayer_id' => :'trustee_taxpayer_id'
98
+ :'trustees' => :'trustees'
136
99
  }
137
100
  end
138
101
 
@@ -157,16 +120,7 @@ module DealMakerAPI
157
120
  :'income' => :'Float',
158
121
  :'net_worth' => :'Float',
159
122
  :'reg_cf_prior_offerings_amount' => :'Float',
160
- :'trustee_first_name' => :'String',
161
- :'trustee_last_name' => :'String',
162
- :'trustee_suffix' => :'String',
163
- :'trustee_street_address' => :'String',
164
- :'trustee_unit2' => :'String',
165
- :'trustee_city' => :'String',
166
- :'trustee_region' => :'String',
167
- :'trustee_postal_code' => :'String',
168
- :'trustee_date_of_birth' => :'String',
169
- :'trustee_taxpayer_id' => :'String'
123
+ :'trustees' => :'Array<PatchInvestorProfilesTrustsTrusteesInner>'
170
124
  }
171
125
  end
172
126
 
@@ -243,44 +197,10 @@ module DealMakerAPI
243
197
  self.reg_cf_prior_offerings_amount = attributes[:'reg_cf_prior_offerings_amount']
244
198
  end
245
199
 
246
- if attributes.key?(:'trustee_first_name')
247
- self.trustee_first_name = attributes[:'trustee_first_name']
248
- end
249
-
250
- if attributes.key?(:'trustee_last_name')
251
- self.trustee_last_name = attributes[:'trustee_last_name']
252
- end
253
-
254
- if attributes.key?(:'trustee_suffix')
255
- self.trustee_suffix = attributes[:'trustee_suffix']
256
- end
257
-
258
- if attributes.key?(:'trustee_street_address')
259
- self.trustee_street_address = attributes[:'trustee_street_address']
260
- end
261
-
262
- if attributes.key?(:'trustee_unit2')
263
- self.trustee_unit2 = attributes[:'trustee_unit2']
264
- end
265
-
266
- if attributes.key?(:'trustee_city')
267
- self.trustee_city = attributes[:'trustee_city']
268
- end
269
-
270
- if attributes.key?(:'trustee_region')
271
- self.trustee_region = attributes[:'trustee_region']
272
- end
273
-
274
- if attributes.key?(:'trustee_postal_code')
275
- self.trustee_postal_code = attributes[:'trustee_postal_code']
276
- end
277
-
278
- if attributes.key?(:'trustee_date_of_birth')
279
- self.trustee_date_of_birth = attributes[:'trustee_date_of_birth']
280
- end
281
-
282
- if attributes.key?(:'trustee_taxpayer_id')
283
- self.trustee_taxpayer_id = attributes[:'trustee_taxpayer_id']
200
+ if attributes.key?(:'trustees')
201
+ if (value = attributes[:'trustees']).is_a?(Array)
202
+ self.trustees = value
203
+ end
284
204
  end
285
205
  end
286
206
 
@@ -341,16 +261,7 @@ module DealMakerAPI
341
261
  income == o.income &&
342
262
  net_worth == o.net_worth &&
343
263
  reg_cf_prior_offerings_amount == o.reg_cf_prior_offerings_amount &&
344
- trustee_first_name == o.trustee_first_name &&
345
- trustee_last_name == o.trustee_last_name &&
346
- trustee_suffix == o.trustee_suffix &&
347
- trustee_street_address == o.trustee_street_address &&
348
- trustee_unit2 == o.trustee_unit2 &&
349
- trustee_city == o.trustee_city &&
350
- trustee_region == o.trustee_region &&
351
- trustee_postal_code == o.trustee_postal_code &&
352
- trustee_date_of_birth == o.trustee_date_of_birth &&
353
- trustee_taxpayer_id == o.trustee_taxpayer_id
264
+ trustees == o.trustees
354
265
  end
355
266
 
356
267
  # @see the `==` method
@@ -362,7 +273,7 @@ module DealMakerAPI
362
273
  # Calculates hash code according to all attributes.
363
274
  # @return [Integer] Hash code
364
275
  def hash
365
- [us_accredited_category, ca_accredited_investor, name, date, phone_number, street_address, unit2, city, region, postal_code, income, net_worth, reg_cf_prior_offerings_amount, trustee_first_name, trustee_last_name, trustee_suffix, trustee_street_address, trustee_unit2, trustee_city, trustee_region, trustee_postal_code, trustee_date_of_birth, trustee_taxpayer_id].hash
276
+ [us_accredited_category, ca_accredited_investor, name, date, phone_number, street_address, unit2, city, region, postal_code, income, net_worth, reg_cf_prior_offerings_amount, trustees].hash
366
277
  end
367
278
 
368
279
  # Builds the object from hash
@@ -0,0 +1,332 @@
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.1.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DealMakerAPI
17
+ class PatchInvestorProfilesTrustsTrusteesInner
18
+ # The index of the trustee.
19
+ attr_accessor :index
20
+
21
+ # If true, this entry will be cleared.
22
+ attr_accessor :_delete
23
+
24
+ # The list of first names for the trustees (required for trustee 1).
25
+ attr_accessor :first_name
26
+
27
+ # The list of last names for the trustees (required for trustee 1).
28
+ attr_accessor :last_name
29
+
30
+ # The list of suffixes for the trustees.
31
+ attr_accessor :suffix
32
+
33
+ # The list of street addresses for the trustees (required for trustee 1).
34
+ attr_accessor :street_address
35
+
36
+ # The list of street address line 2 for the trustees.
37
+ attr_accessor :unit2
38
+
39
+ # The list of cities for the trustees (required for trustee 1).
40
+ attr_accessor :city
41
+
42
+ # The list of regions or states for the trustees (required for trustee 1).
43
+ attr_accessor :region
44
+
45
+ # The list of postal codes or zipcodes for the trustees (required for trustee 1).
46
+ attr_accessor :postal_code
47
+
48
+ # The list of dates of birth for the trustees (required for trustee 1).
49
+ attr_accessor :date_of_birth
50
+
51
+ # The list of taxpayer identification numbers for the trustees (required for trustee 1).
52
+ attr_accessor :taxpayer_id
53
+
54
+ # Attribute mapping from ruby-style variable name to JSON key.
55
+ def self.attribute_map
56
+ {
57
+ :'index' => :'index',
58
+ :'_delete' => :'_delete',
59
+ :'first_name' => :'first_name',
60
+ :'last_name' => :'last_name',
61
+ :'suffix' => :'suffix',
62
+ :'street_address' => :'street_address',
63
+ :'unit2' => :'unit2',
64
+ :'city' => :'city',
65
+ :'region' => :'region',
66
+ :'postal_code' => :'postal_code',
67
+ :'date_of_birth' => :'date_of_birth',
68
+ :'taxpayer_id' => :'taxpayer_id'
69
+ }
70
+ end
71
+
72
+ # Returns all the JSON keys this model knows about
73
+ def self.acceptable_attributes
74
+ attribute_map.values
75
+ end
76
+
77
+ # Attribute type mapping.
78
+ def self.openapi_types
79
+ {
80
+ :'index' => :'Integer',
81
+ :'_delete' => :'Boolean',
82
+ :'first_name' => :'String',
83
+ :'last_name' => :'String',
84
+ :'suffix' => :'String',
85
+ :'street_address' => :'String',
86
+ :'unit2' => :'String',
87
+ :'city' => :'String',
88
+ :'region' => :'String',
89
+ :'postal_code' => :'String',
90
+ :'date_of_birth' => :'String',
91
+ :'taxpayer_id' => :'String'
92
+ }
93
+ end
94
+
95
+ # List of attributes with nullable: true
96
+ def self.openapi_nullable
97
+ Set.new([
98
+ ])
99
+ end
100
+
101
+ # Initializes the object
102
+ # @param [Hash] attributes Model attributes in the form of hash
103
+ def initialize(attributes = {})
104
+ if (!attributes.is_a?(Hash))
105
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner` initialize method"
106
+ end
107
+
108
+ # check to see if the attribute exists and convert string to symbol for hash key
109
+ attributes = attributes.each_with_object({}) { |(k, v), h|
110
+ if (!self.class.attribute_map.key?(k.to_sym))
111
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
112
+ end
113
+ h[k.to_sym] = v
114
+ }
115
+
116
+ if attributes.key?(:'index')
117
+ self.index = attributes[:'index']
118
+ else
119
+ self.index = nil
120
+ end
121
+
122
+ if attributes.key?(:'_delete')
123
+ self._delete = attributes[:'_delete']
124
+ end
125
+
126
+ if attributes.key?(:'first_name')
127
+ self.first_name = attributes[:'first_name']
128
+ end
129
+
130
+ if attributes.key?(:'last_name')
131
+ self.last_name = attributes[:'last_name']
132
+ end
133
+
134
+ if attributes.key?(:'suffix')
135
+ self.suffix = attributes[:'suffix']
136
+ end
137
+
138
+ if attributes.key?(:'street_address')
139
+ self.street_address = attributes[:'street_address']
140
+ end
141
+
142
+ if attributes.key?(:'unit2')
143
+ self.unit2 = attributes[:'unit2']
144
+ end
145
+
146
+ if attributes.key?(:'city')
147
+ self.city = attributes[:'city']
148
+ end
149
+
150
+ if attributes.key?(:'region')
151
+ self.region = attributes[:'region']
152
+ end
153
+
154
+ if attributes.key?(:'postal_code')
155
+ self.postal_code = attributes[:'postal_code']
156
+ end
157
+
158
+ if attributes.key?(:'date_of_birth')
159
+ self.date_of_birth = attributes[:'date_of_birth']
160
+ end
161
+
162
+ if attributes.key?(:'taxpayer_id')
163
+ self.taxpayer_id = attributes[:'taxpayer_id']
164
+ end
165
+ end
166
+
167
+ # Show invalid properties with the reasons. Usually used together with valid?
168
+ # @return Array for valid properties with the reasons
169
+ def list_invalid_properties
170
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
171
+ invalid_properties = Array.new
172
+ if @index.nil?
173
+ invalid_properties.push('invalid value for "index", index cannot be nil.')
174
+ end
175
+
176
+ invalid_properties
177
+ end
178
+
179
+ # Check to see if the all the properties in the model are valid
180
+ # @return true if the model is valid
181
+ def valid?
182
+ warn '[DEPRECATED] the `valid?` method is obsolete'
183
+ return false if @index.nil?
184
+ true
185
+ end
186
+
187
+ # Checks equality by comparing each attribute.
188
+ # @param [Object] Object to be compared
189
+ def ==(o)
190
+ return true if self.equal?(o)
191
+ self.class == o.class &&
192
+ index == o.index &&
193
+ _delete == o._delete &&
194
+ first_name == o.first_name &&
195
+ last_name == o.last_name &&
196
+ suffix == o.suffix &&
197
+ street_address == o.street_address &&
198
+ unit2 == o.unit2 &&
199
+ city == o.city &&
200
+ region == o.region &&
201
+ postal_code == o.postal_code &&
202
+ date_of_birth == o.date_of_birth &&
203
+ taxpayer_id == o.taxpayer_id
204
+ end
205
+
206
+ # @see the `==` method
207
+ # @param [Object] Object to be compared
208
+ def eql?(o)
209
+ self == o
210
+ end
211
+
212
+ # Calculates hash code according to all attributes.
213
+ # @return [Integer] Hash code
214
+ def hash
215
+ [index, _delete, first_name, last_name, suffix, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id].hash
216
+ end
217
+
218
+ # Builds the object from hash
219
+ # @param [Hash] attributes Model attributes in the form of hash
220
+ # @return [Object] Returns the model itself
221
+ def self.build_from_hash(attributes)
222
+ return nil unless attributes.is_a?(Hash)
223
+ attributes = attributes.transform_keys(&:to_sym)
224
+ transformed_hash = {}
225
+ openapi_types.each_pair do |key, type|
226
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
227
+ transformed_hash["#{key}"] = nil
228
+ elsif type =~ /\AArray<(.*)>/i
229
+ # check to ensure the input is an array given that the attribute
230
+ # is documented as an array but the input is not
231
+ if attributes[attribute_map[key]].is_a?(Array)
232
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
233
+ end
234
+ elsif !attributes[attribute_map[key]].nil?
235
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
236
+ end
237
+ end
238
+ new(transformed_hash)
239
+ end
240
+
241
+ # Deserializes the data based on type
242
+ # @param string type Data type
243
+ # @param string value Value to be deserialized
244
+ # @return [Object] Deserialized data
245
+ def self._deserialize(type, value)
246
+ case type.to_sym
247
+ when :Time
248
+ Time.parse(value)
249
+ when :Date
250
+ Date.parse(value)
251
+ when :String
252
+ value.to_s
253
+ when :Integer
254
+ value.to_i
255
+ when :Float
256
+ value.to_f
257
+ when :Boolean
258
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
259
+ true
260
+ else
261
+ false
262
+ end
263
+ when :Object
264
+ # generic object (usually a Hash), return directly
265
+ value
266
+ when /\AArray<(?<inner_type>.+)>\z/
267
+ inner_type = Regexp.last_match[:inner_type]
268
+ value.map { |v| _deserialize(inner_type, v) }
269
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
270
+ k_type = Regexp.last_match[:k_type]
271
+ v_type = Regexp.last_match[:v_type]
272
+ {}.tap do |hash|
273
+ value.each do |k, v|
274
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
275
+ end
276
+ end
277
+ else # model
278
+ # models (e.g. Pet) or oneOf
279
+ klass = DealMakerAPI.const_get(type)
280
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
281
+ end
282
+ end
283
+
284
+ # Returns the string representation of the object
285
+ # @return [String] String presentation of the object
286
+ def to_s
287
+ to_hash.to_s
288
+ end
289
+
290
+ # to_body is an alias to to_hash (backward compatibility)
291
+ # @return [Hash] Returns the object in the form of hash
292
+ def to_body
293
+ to_hash
294
+ end
295
+
296
+ # Returns the object in the form of hash
297
+ # @return [Hash] Returns the object in the form of hash
298
+ def to_hash
299
+ hash = {}
300
+ self.class.attribute_map.each_pair do |attr, param|
301
+ value = self.send(attr)
302
+ if value.nil?
303
+ is_nullable = self.class.openapi_nullable.include?(attr)
304
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
305
+ end
306
+
307
+ hash[param] = _to_hash(value)
308
+ end
309
+ hash
310
+ end
311
+
312
+ # Outputs non-array value in the form of hash
313
+ # For object, use to_hash. Otherwise, just return the value
314
+ # @param [Object] value Any valid value
315
+ # @return [Hash] Returns the value in the form of hash
316
+ def _to_hash(value)
317
+ if value.is_a?(Array)
318
+ value.compact.map { |v| _to_hash(v) }
319
+ elsif value.is_a?(Hash)
320
+ {}.tap do |hash|
321
+ value.each { |k, v| hash[k] = _to_hash(v) }
322
+ end
323
+ elsif value.respond_to? :to_hash
324
+ value.to_hash
325
+ else
326
+ value
327
+ end
328
+ end
329
+
330
+ end
331
+
332
+ end
@@ -36,7 +36,7 @@ module DealMakerAPI
36
36
  # The list of regions or states for the trustees (required for trustee 1).
37
37
  attr_accessor :region
38
38
 
39
- # The list of postal codes or zipcodes for the trustees (required) for trustee 1.
39
+ # The list of postal codes or zipcodes for the trustees (required for trustee 1).
40
40
  attr_accessor :postal_code
41
41
 
42
42
  # The list of dates of birth for the trustees (required for trustee 1).
@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.1.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module DealMakerAPI
14
- VERSION = '0.88.4'
14
+ VERSION = '0.89.1'
15
15
  end
data/lib/DealMakerAPI.rb CHANGED
@@ -32,6 +32,7 @@ require 'DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_own
32
32
  require 'DealMakerAPI/models/patch_investor_profiles_individuals'
33
33
  require 'DealMakerAPI/models/patch_investor_profiles_joints'
34
34
  require 'DealMakerAPI/models/patch_investor_profiles_trusts'
35
+ require 'DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner'
35
36
  require 'DealMakerAPI/models/patch_investor_request'
36
37
  require 'DealMakerAPI/models/post_deals_id_investors'
37
38
  require 'DealMakerAPI/models/post_investor_profiles_corporations'
@@ -113,61 +113,7 @@ describe DealMakerAPI::PatchInvestorProfilesTrusts do
113
113
  end
114
114
  end
115
115
 
116
- describe 'test attribute "trustee_first_name"' 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 "trustee_last_name"' 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 "trustee_suffix"' 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 "trustee_street_address"' 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 "trustee_unit2"' 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 "trustee_city"' 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 "trustee_region"' 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 "trustee_postal_code"' 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 "trustee_date_of_birth"' 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 "trustee_taxpayer_id"' do
116
+ describe 'test attribute "trustees"' do
171
117
  it 'should work' do
172
118
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
173
119
  end
@@ -0,0 +1,102 @@
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.1.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner do
21
+ let(:instance) { DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner.new }
22
+
23
+ describe 'test an instance of PatchInvestorProfilesTrustsTrusteesInner' do
24
+ it 'should create an instance of PatchInvestorProfilesTrustsTrusteesInner' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "index"' 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 "_delete"' 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 "first_name"' 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 "last_name"' 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 "suffix"' 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 "street_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 "unit2"' 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 "city"' 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
+ describe 'test attribute "region"' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
+ end
82
+ end
83
+
84
+ describe 'test attribute "postal_code"' do
85
+ it 'should work' do
86
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
+ end
88
+ end
89
+
90
+ describe 'test attribute "date_of_birth"' do
91
+ it 'should work' do
92
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
93
+ end
94
+ end
95
+
96
+ describe 'test attribute "taxpayer_id"' do
97
+ it 'should work' do
98
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
99
+ end
100
+ end
101
+
102
+ end
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.88.4
4
+ version: 0.89.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - DealMaker
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-10 00:00:00.000000000 Z
11
+ date: 2023-10-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -84,6 +84,7 @@ files:
84
84
  - docs/PatchInvestorProfilesIndividuals.md
85
85
  - docs/PatchInvestorProfilesJoints.md
86
86
  - docs/PatchInvestorProfilesTrusts.md
87
+ - docs/PatchInvestorProfilesTrustsTrusteesInner.md
87
88
  - docs/PatchInvestorRequest.md
88
89
  - docs/PostDealsIdInvestors.md
89
90
  - docs/PostInvestorProfilesCorporations.md
@@ -185,6 +186,7 @@ files:
185
186
  - lib/DealMakerAPI/models/patch_investor_profiles_individuals.rb
186
187
  - lib/DealMakerAPI/models/patch_investor_profiles_joints.rb
187
188
  - lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb
189
+ - lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb
188
190
  - lib/DealMakerAPI/models/patch_investor_request.rb
189
191
  - lib/DealMakerAPI/models/post_deals_id_investors.rb
190
192
  - lib/DealMakerAPI/models/post_investor_profiles_corporations.rb
@@ -281,6 +283,7 @@ files:
281
283
  - spec/models/patch_investor_profiles_individuals_spec.rb
282
284
  - spec/models/patch_investor_profiles_joints_spec.rb
283
285
  - spec/models/patch_investor_profiles_trusts_spec.rb
286
+ - spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb
284
287
  - spec/models/patch_investor_request_spec.rb
285
288
  - spec/models/post_deals_id_investors_spec.rb
286
289
  - spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb
@@ -444,6 +447,7 @@ test_files:
444
447
  - spec/models/post_deals_id_investors_spec.rb
445
448
  - spec/models/create_bulk_upload_detail_request_spec.rb
446
449
  - spec/models/create_deal_setup_request_spec.rb
450
+ - spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb
447
451
  - spec/models/v1_entities_webhooks_subscription_spec.rb
448
452
  - spec/models/v1_entities_investors_spec.rb
449
453
  - spec/models/v1_entities_deal_enterprise_spec.rb