DealMakerAPI 0.71.0 → 0.74.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/DealMakerAPI.gemspec +1 -1
- data/README.md +8 -4
- data/docs/InvestorApi.md +69 -0
- data/docs/InvestorProfileApi.md +144 -0
- data/docs/PatchInvestorRequest.md +3 -1
- data/docs/V1EntitiesInvestor.md +5 -1
- data/docs/V1EntitiesInvestorOtpAccessLink.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +1 -1
- data/lib/DealMakerAPI/api/deal_api.rb +1 -1
- data/lib/DealMakerAPI/api/deal_setup_api.rb +1 -1
- data/lib/DealMakerAPI/api/default_api.rb +1 -1
- data/lib/DealMakerAPI/api/investor_api.rb +70 -1
- data/lib/DealMakerAPI/api/investor_profile_api.rb +139 -1
- data/lib/DealMakerAPI/api_client.rb +1 -1
- data/lib/DealMakerAPI/api_error.rb +1 -1
- data/lib/DealMakerAPI/configuration.rb +6 -1
- data/lib/DealMakerAPI/models/create_company_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_deal_setup_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_individual_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_investor_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_joint_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_trust_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_request.rb +51 -5
- data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +1 -1
- data/lib/DealMakerAPI/models/post_webhooks_request.rb +1 -1
- data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +1 -1
- data/lib/DealMakerAPI/models/update_investor_request.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_address.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_addresses.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_attachment.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +25 -5
- data/lib/DealMakerAPI/models/v1_entities_investor_otp_access_link.rb +221 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +2 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investors.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +1 -1
- data/lib/DealMakerAPI/version.rb +2 -2
- data/lib/DealMakerAPI.rb +2 -1
- data/spec/api/company_api_spec.rb +1 -1
- data/spec/api/deal_api_spec.rb +1 -1
- data/spec/api/deal_setup_api_spec.rb +1 -1
- data/spec/api/default_api_spec.rb +1 -1
- data/spec/api/investor_api_spec.rb +14 -1
- data/spec/api/investor_profile_api_spec.rb +29 -1
- data/spec/api_client_spec.rb +3 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/create_company_request_spec.rb +1 -1
- data/spec/models/create_corporation_profile_request_spec.rb +1 -1
- data/spec/models/create_deal_setup_request_spec.rb +1 -1
- data/spec/models/create_individual_profile_request_spec.rb +1 -1
- data/spec/models/create_investor_request_spec.rb +1 -1
- data/spec/models/create_joint_profile_request_spec.rb +1 -1
- data/spec/models/create_trust_profile_request_spec.rb +1 -1
- data/spec/models/patch_corporation_profile_request_spec.rb +1 -1
- data/spec/models/patch_individual_profile_request_spec.rb +1 -1
- data/spec/models/patch_investor_request_spec.rb +11 -1
- data/spec/models/patch_joint_profile_request_spec.rb +1 -1
- data/spec/models/patch_trust_profile_request_spec.rb +1 -1
- data/spec/models/post_webhooks_request_spec.rb +1 -1
- data/spec/models/put_webhooks_id_request_spec.rb +1 -1
- data/spec/models/update_investor_request_spec.rb +1 -1
- data/spec/models/v1_entities_address_spec.rb +1 -1
- data/spec/models/v1_entities_addresses_spec.rb +1 -1
- data/spec/models/v1_entities_attachment_spec.rb +1 -1
- data/spec/models/v1_entities_background_check_search_spec.rb +1 -1
- data/spec/models/v1_entities_company_deal_spec.rb +1 -1
- data/spec/models/v1_entities_company_deals_spec.rb +1 -1
- data/spec/models/v1_entities_company_spec.rb +1 -1
- data/spec/models/v1_entities_deal_enterprise_spec.rb +1 -1
- data/spec/models/v1_entities_deal_funding_metrics_spec.rb +1 -1
- data/spec/models/v1_entities_deal_investor_metrics_spec.rb +1 -1
- data/spec/models/v1_entities_deal_issuer_spec.rb +1 -1
- data/spec/models/v1_entities_deal_setup_spec.rb +1 -1
- data/spec/models/v1_entities_deal_setup_user_spec.rb +1 -1
- data/spec/models/v1_entities_deal_spec.rb +1 -1
- data/spec/models/v1_entities_deals_spec.rb +1 -1
- data/spec/models/v1_entities_investor_otp_access_link_spec.rb +34 -0
- data/spec/models/v1_entities_investor_profile_address_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_item_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profiles_spec.rb +1 -1
- data/spec/models/v1_entities_investor_spec.rb +13 -1
- data/spec/models/v1_entities_investor_user_spec.rb +1 -1
- data/spec/models/v1_entities_investors_spec.rb +1 -1
- data/spec/models/v1_entities_subscription_agreement_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_deal_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_security_token_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +48 -44
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e13b3ba22cdcb876a535cc2a40f0a3fe8fe1f29e37c21056464e46c9c8c0565e
|
4
|
+
data.tar.gz: 5cae2c4e7aa9731bf97e65359093fae1f68c9998e66438195e671263923c4209
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bba5e964aa3a4124e3283e28a21d176d6cd5cbfdff7aa56df30eeb9aed198fccc63ae45fc4f59da3d098caff71113cdfd447612f45f838f214efb08ae5d58b32
|
7
|
+
data.tar.gz: 46c83bf1a7cd2391b6b67375a1914bd3c7d4056242faaadd6f93e551b3a6b136ca0badefdcb99c4baacd70ae88ba67f1e0c4446365a811ea1cfc63611756d18a
|
data/DealMakerAPI.gemspec
CHANGED
data/README.md
CHANGED
@@ -313,7 +313,7 @@ Given the high number of updates our platform performs on any investor, we’ve
|
|
313
313
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
314
314
|
|
315
315
|
- API version: 1.0.0
|
316
|
-
- Package version: 0.
|
316
|
+
- Package version: 0.74.1
|
317
317
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
318
318
|
|
319
319
|
## Installation
|
@@ -329,16 +329,16 @@ gem build DealMakerAPI.gemspec
|
|
329
329
|
Then either install the gem locally:
|
330
330
|
|
331
331
|
```shell
|
332
|
-
gem install ./DealMakerAPI-0.
|
332
|
+
gem install ./DealMakerAPI-0.74.1.gem
|
333
333
|
```
|
334
334
|
|
335
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
335
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.74.1.gem` to install the development dependencies)
|
336
336
|
|
337
337
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
338
338
|
|
339
339
|
Finally add this to the Gemfile:
|
340
340
|
|
341
|
-
gem 'DealMakerAPI', '~> 0.
|
341
|
+
gem 'DealMakerAPI', '~> 0.74.1'
|
342
342
|
|
343
343
|
### Install from Git
|
344
344
|
|
@@ -398,6 +398,7 @@ Class | Method | HTTP request | Description
|
|
398
398
|
*DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
|
399
399
|
*DealMakerAPI::InvestorApi* | [**create_investor**](docs/InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor
|
400
400
|
*DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
|
401
|
+
*DealMakerAPI::InvestorApi* | [**get_investor_otp_link**](docs/InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor
|
401
402
|
*DealMakerAPI::InvestorApi* | [**list_investors**](docs/InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors
|
402
403
|
*DealMakerAPI::InvestorApi* | [**patch_investor**](docs/InvestorApi.md#patch_investor) | **PATCH** /deals/{id}/investors/{investor_id} | Patch a deal investor
|
403
404
|
*DealMakerAPI::InvestorApi* | [**update_investor**](docs/InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor
|
@@ -405,6 +406,8 @@ Class | Method | HTTP request | Description
|
|
405
406
|
*DealMakerAPI::InvestorProfileApi* | [**create_individual_profile**](docs/InvestorProfileApi.md#create_individual_profile) | **POST** /investor_profiles/individuals | Create new individual investor profile
|
406
407
|
*DealMakerAPI::InvestorProfileApi* | [**create_joint_profile**](docs/InvestorProfileApi.md#create_joint_profile) | **POST** /investor_profiles/joints | Create new joint investor profile
|
407
408
|
*DealMakerAPI::InvestorProfileApi* | [**create_trust_profile**](docs/InvestorProfileApi.md#create_trust_profile) | **POST** /investor_profiles/trusts | Create new trust investor profile.
|
409
|
+
*DealMakerAPI::InvestorProfileApi* | [**get_deal_investor_profiles**](docs/InvestorProfileApi.md#get_deal_investor_profiles) | **GET** /investor_profiles/{deal_id} | Get list of InvestorProfiles for a specific deal
|
410
|
+
*DealMakerAPI::InvestorProfileApi* | [**get_investor_profile**](docs/InvestorProfileApi.md#get_investor_profile) | **GET** /investor_profiles/profile/{id} | Get an investor profile by id
|
408
411
|
*DealMakerAPI::InvestorProfileApi* | [**get_investor_profiles**](docs/InvestorProfileApi.md#get_investor_profiles) | **GET** /investor_profiles | Get list of InvestorProfiles
|
409
412
|
*DealMakerAPI::InvestorProfileApi* | [**patch_corporation_profile**](docs/InvestorProfileApi.md#patch_corporation_profile) | **PATCH** /investor_profiles/corporations/{investor_profile_id} | Patch a corporation investor profile
|
410
413
|
*DealMakerAPI::InvestorProfileApi* | [**patch_individual_profile**](docs/InvestorProfileApi.md#patch_individual_profile) | **PATCH** /investor_profiles/individuals/{investor_profile_id} | Patch an individual investor profile.
|
@@ -445,6 +448,7 @@ Class | Method | HTTP request | Description
|
|
445
448
|
- [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
|
446
449
|
- [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
|
447
450
|
- [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
|
451
|
+
- [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
|
448
452
|
- [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
|
449
453
|
- [DealMakerAPI::V1EntitiesInvestorProfileCorporation](docs/V1EntitiesInvestorProfileCorporation.md)
|
450
454
|
- [DealMakerAPI::V1EntitiesInvestorProfileFieldsAccountHolder](docs/V1EntitiesInvestorProfileFieldsAccountHolder.md)
|
data/docs/InvestorApi.md
CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_investor**](InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
|
8
8
|
| [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
|
9
|
+
| [**get_investor_otp_link**](InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor |
|
9
10
|
| [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
|
10
11
|
| [**patch_investor**](InvestorApi.md#patch_investor) | **PATCH** /deals/{id}/investors/{investor_id} | Patch a deal investor |
|
11
12
|
| [**update_investor**](InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor |
|
@@ -147,6 +148,74 @@ No authorization required
|
|
147
148
|
- **Accept**: application/json
|
148
149
|
|
149
150
|
|
151
|
+
## get_investor_otp_link
|
152
|
+
|
153
|
+
> <V1EntitiesInvestorOtpAccessLink> get_investor_otp_link(id, investor_id)
|
154
|
+
|
155
|
+
Get OTP access link for deal investor
|
156
|
+
|
157
|
+
Get OTP access link for deal investor by id
|
158
|
+
|
159
|
+
### Examples
|
160
|
+
|
161
|
+
```ruby
|
162
|
+
require 'time'
|
163
|
+
require 'DealMakerAPI'
|
164
|
+
# setup authorization
|
165
|
+
DealMakerAPI.configure do |config|end
|
166
|
+
|
167
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
168
|
+
id = 56 # Integer | The deal id.
|
169
|
+
investor_id = 56 # Integer | The investor id.
|
170
|
+
|
171
|
+
begin
|
172
|
+
# Get OTP access link for deal investor
|
173
|
+
result = api_instance.get_investor_otp_link(id, investor_id)
|
174
|
+
p result
|
175
|
+
rescue DealMakerAPI::ApiError => e
|
176
|
+
puts "Error when calling InvestorApi->get_investor_otp_link: #{e}"
|
177
|
+
end
|
178
|
+
```
|
179
|
+
|
180
|
+
#### Using the get_investor_otp_link_with_http_info variant
|
181
|
+
|
182
|
+
This returns an Array which contains the response data, status code and headers.
|
183
|
+
|
184
|
+
> <Array(<V1EntitiesInvestorOtpAccessLink>, Integer, Hash)> get_investor_otp_link_with_http_info(id, investor_id)
|
185
|
+
|
186
|
+
```ruby
|
187
|
+
begin
|
188
|
+
# Get OTP access link for deal investor
|
189
|
+
data, status_code, headers = api_instance.get_investor_otp_link_with_http_info(id, investor_id)
|
190
|
+
p status_code # => 2xx
|
191
|
+
p headers # => { ... }
|
192
|
+
p data # => <V1EntitiesInvestorOtpAccessLink>
|
193
|
+
rescue DealMakerAPI::ApiError => e
|
194
|
+
puts "Error when calling InvestorApi->get_investor_otp_link_with_http_info: #{e}"
|
195
|
+
end
|
196
|
+
```
|
197
|
+
|
198
|
+
### Parameters
|
199
|
+
|
200
|
+
| Name | Type | Description | Notes |
|
201
|
+
| ---- | ---- | ----------- | ----- |
|
202
|
+
| **id** | **Integer** | The deal id. | |
|
203
|
+
| **investor_id** | **Integer** | The investor id. | |
|
204
|
+
|
205
|
+
### Return type
|
206
|
+
|
207
|
+
[**V1EntitiesInvestorOtpAccessLink**](V1EntitiesInvestorOtpAccessLink.md)
|
208
|
+
|
209
|
+
### Authorization
|
210
|
+
|
211
|
+
No authorization required
|
212
|
+
|
213
|
+
### HTTP request headers
|
214
|
+
|
215
|
+
- **Content-Type**: Not defined
|
216
|
+
- **Accept**: application/json
|
217
|
+
|
218
|
+
|
150
219
|
## list_investors
|
151
220
|
|
152
221
|
> <V1EntitiesInvestors> list_investors(id, opts)
|
data/docs/InvestorProfileApi.md
CHANGED
@@ -8,6 +8,8 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
8
8
|
| [**create_individual_profile**](InvestorProfileApi.md#create_individual_profile) | **POST** /investor_profiles/individuals | Create new individual investor profile |
|
9
9
|
| [**create_joint_profile**](InvestorProfileApi.md#create_joint_profile) | **POST** /investor_profiles/joints | Create new joint investor profile |
|
10
10
|
| [**create_trust_profile**](InvestorProfileApi.md#create_trust_profile) | **POST** /investor_profiles/trusts | Create new trust investor profile. |
|
11
|
+
| [**get_deal_investor_profiles**](InvestorProfileApi.md#get_deal_investor_profiles) | **GET** /investor_profiles/{deal_id} | Get list of InvestorProfiles for a specific deal |
|
12
|
+
| [**get_investor_profile**](InvestorProfileApi.md#get_investor_profile) | **GET** /investor_profiles/profile/{id} | Get an investor profile by id |
|
11
13
|
| [**get_investor_profiles**](InvestorProfileApi.md#get_investor_profiles) | **GET** /investor_profiles | Get list of InvestorProfiles |
|
12
14
|
| [**patch_corporation_profile**](InvestorProfileApi.md#patch_corporation_profile) | **PATCH** /investor_profiles/corporations/{investor_profile_id} | Patch a corporation investor profile |
|
13
15
|
| [**patch_individual_profile**](InvestorProfileApi.md#patch_individual_profile) | **PATCH** /investor_profiles/individuals/{investor_profile_id} | Patch an individual investor profile. |
|
@@ -279,6 +281,148 @@ No authorization required
|
|
279
281
|
- **Accept**: application/json
|
280
282
|
|
281
283
|
|
284
|
+
## get_deal_investor_profiles
|
285
|
+
|
286
|
+
> <V1EntitiesInvestorProfiles> get_deal_investor_profiles(deal_id, opts)
|
287
|
+
|
288
|
+
Get list of InvestorProfiles for a specific deal
|
289
|
+
|
290
|
+
Get investor profiles for a specific deal
|
291
|
+
|
292
|
+
### Examples
|
293
|
+
|
294
|
+
```ruby
|
295
|
+
require 'time'
|
296
|
+
require 'DealMakerAPI'
|
297
|
+
# setup authorization
|
298
|
+
DealMakerAPI.configure do |config|end
|
299
|
+
|
300
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
301
|
+
deal_id = 56 # Integer | The deal id.
|
302
|
+
opts = {
|
303
|
+
page: 56, # Integer | Page offset to fetch.
|
304
|
+
per_page: 56, # Integer | Number of results to return per page.
|
305
|
+
offset: 56, # Integer | Pad a number of results.
|
306
|
+
user_id: 56 # Integer | The user id filter.
|
307
|
+
}
|
308
|
+
|
309
|
+
begin
|
310
|
+
# Get list of InvestorProfiles for a specific deal
|
311
|
+
result = api_instance.get_deal_investor_profiles(deal_id, opts)
|
312
|
+
p result
|
313
|
+
rescue DealMakerAPI::ApiError => e
|
314
|
+
puts "Error when calling InvestorProfileApi->get_deal_investor_profiles: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
#### Using the get_deal_investor_profiles_with_http_info variant
|
319
|
+
|
320
|
+
This returns an Array which contains the response data, status code and headers.
|
321
|
+
|
322
|
+
> <Array(<V1EntitiesInvestorProfiles>, Integer, Hash)> get_deal_investor_profiles_with_http_info(deal_id, opts)
|
323
|
+
|
324
|
+
```ruby
|
325
|
+
begin
|
326
|
+
# Get list of InvestorProfiles for a specific deal
|
327
|
+
data, status_code, headers = api_instance.get_deal_investor_profiles_with_http_info(deal_id, opts)
|
328
|
+
p status_code # => 2xx
|
329
|
+
p headers # => { ... }
|
330
|
+
p data # => <V1EntitiesInvestorProfiles>
|
331
|
+
rescue DealMakerAPI::ApiError => e
|
332
|
+
puts "Error when calling InvestorProfileApi->get_deal_investor_profiles_with_http_info: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
### Parameters
|
337
|
+
|
338
|
+
| Name | Type | Description | Notes |
|
339
|
+
| ---- | ---- | ----------- | ----- |
|
340
|
+
| **deal_id** | **Integer** | The deal id. | |
|
341
|
+
| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
|
342
|
+
| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
|
343
|
+
| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
|
344
|
+
| **user_id** | **Integer** | The user id filter. | [optional] |
|
345
|
+
|
346
|
+
### Return type
|
347
|
+
|
348
|
+
[**V1EntitiesInvestorProfiles**](V1EntitiesInvestorProfiles.md)
|
349
|
+
|
350
|
+
### Authorization
|
351
|
+
|
352
|
+
No authorization required
|
353
|
+
|
354
|
+
### HTTP request headers
|
355
|
+
|
356
|
+
- **Content-Type**: Not defined
|
357
|
+
- **Accept**: application/json
|
358
|
+
|
359
|
+
|
360
|
+
## get_investor_profile
|
361
|
+
|
362
|
+
> <V1EntitiesInvestorProfileItem> get_investor_profile(id)
|
363
|
+
|
364
|
+
Get an investor profile by id
|
365
|
+
|
366
|
+
Get an investor profile
|
367
|
+
|
368
|
+
### Examples
|
369
|
+
|
370
|
+
```ruby
|
371
|
+
require 'time'
|
372
|
+
require 'DealMakerAPI'
|
373
|
+
# setup authorization
|
374
|
+
DealMakerAPI.configure do |config|end
|
375
|
+
|
376
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
377
|
+
id = 56 # Integer | The id of the investor profile.
|
378
|
+
|
379
|
+
begin
|
380
|
+
# Get an investor profile by id
|
381
|
+
result = api_instance.get_investor_profile(id)
|
382
|
+
p result
|
383
|
+
rescue DealMakerAPI::ApiError => e
|
384
|
+
puts "Error when calling InvestorProfileApi->get_investor_profile: #{e}"
|
385
|
+
end
|
386
|
+
```
|
387
|
+
|
388
|
+
#### Using the get_investor_profile_with_http_info variant
|
389
|
+
|
390
|
+
This returns an Array which contains the response data, status code and headers.
|
391
|
+
|
392
|
+
> <Array(<V1EntitiesInvestorProfileItem>, Integer, Hash)> get_investor_profile_with_http_info(id)
|
393
|
+
|
394
|
+
```ruby
|
395
|
+
begin
|
396
|
+
# Get an investor profile by id
|
397
|
+
data, status_code, headers = api_instance.get_investor_profile_with_http_info(id)
|
398
|
+
p status_code # => 2xx
|
399
|
+
p headers # => { ... }
|
400
|
+
p data # => <V1EntitiesInvestorProfileItem>
|
401
|
+
rescue DealMakerAPI::ApiError => e
|
402
|
+
puts "Error when calling InvestorProfileApi->get_investor_profile_with_http_info: #{e}"
|
403
|
+
end
|
404
|
+
```
|
405
|
+
|
406
|
+
### Parameters
|
407
|
+
|
408
|
+
| Name | Type | Description | Notes |
|
409
|
+
| ---- | ---- | ----------- | ----- |
|
410
|
+
| **id** | **Integer** | The id of the investor profile. | |
|
411
|
+
|
412
|
+
### Return type
|
413
|
+
|
414
|
+
[**V1EntitiesInvestorProfileItem**](V1EntitiesInvestorProfileItem.md)
|
415
|
+
|
416
|
+
### Authorization
|
417
|
+
|
418
|
+
No authorization required
|
419
|
+
|
420
|
+
### HTTP request headers
|
421
|
+
|
422
|
+
- **Content-Type**: Not defined
|
423
|
+
- **Accept**: application/json
|
424
|
+
|
425
|
+
|
282
426
|
## get_investor_profiles
|
283
427
|
|
284
428
|
> <V1EntitiesInvestorProfiles> get_investor_profiles(opts)
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **investor_profile_id** | **Integer** | Investor profile id that needs to be set on investor | |
|
8
|
+
| **current_step** | **String** | Step on checkout page. | [optional][default to 'contact-information'] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'DealMakerAPI'
|
13
14
|
|
14
15
|
instance = DealMakerAPI::PatchInvestorRequest.new(
|
15
|
-
investor_profile_id: null
|
16
|
+
investor_profile_id: null,
|
17
|
+
current_step: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/V1EntitiesInvestor.md
CHANGED
@@ -29,6 +29,8 @@
|
|
29
29
|
| **warrant_certificate_number** | **Integer** | The warrant certificate number. | [optional] |
|
30
30
|
| **ranking_score** | **Float** | A value `[0, 1]` that represents the propensity for the investor to complete payment for the investment. A larger value indicates a higher likelihood of payment, as predicted by DealMaker’s machine learning algorithm. This field will only populate if DealMaker Compass is enabled for a deal and the investor `funds_state` value is not `funded` or `overfunded` | [optional] |
|
31
31
|
| **investor_profile** | **String** | | [optional] |
|
32
|
+
| **investor_profile_id** | **Integer** | The investor profile id. | [optional] |
|
33
|
+
| **checkout_state** | **String** | Current state on checkout page. | [optional] |
|
32
34
|
|
33
35
|
## Example
|
34
36
|
|
@@ -60,7 +62,9 @@ instance = DealMakerAPI::V1EntitiesInvestor.new(
|
|
60
62
|
warrant_expiry_date: null,
|
61
63
|
warrant_certificate_number: null,
|
62
64
|
ranking_score: null,
|
63
|
-
investor_profile: null
|
65
|
+
investor_profile: null,
|
66
|
+
investor_profile_id: null,
|
67
|
+
checkout_state: null
|
64
68
|
)
|
65
69
|
```
|
66
70
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorOtpAccessLink
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **access_link** | **String** | OTP access link for the investor. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesInvestorOtpAccessLink.new(
|
15
|
+
access_link: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 6.
|
9
|
+
OpenAPI Generator version: 6.5.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -162,6 +162,75 @@ module DealMakerAPI
|
|
162
162
|
return data, status_code, headers
|
163
163
|
end
|
164
164
|
|
165
|
+
# Get OTP access link for deal investor
|
166
|
+
# Get OTP access link for deal investor by id
|
167
|
+
# @param id [Integer] The deal id.
|
168
|
+
# @param investor_id [Integer] The investor id.
|
169
|
+
# @param [Hash] opts the optional parameters
|
170
|
+
# @return [V1EntitiesInvestorOtpAccessLink]
|
171
|
+
def get_investor_otp_link(id, investor_id, opts = {})
|
172
|
+
data, _status_code, _headers = get_investor_otp_link_with_http_info(id, investor_id, opts)
|
173
|
+
data
|
174
|
+
end
|
175
|
+
|
176
|
+
# Get OTP access link for deal investor
|
177
|
+
# Get OTP access link for deal investor by id
|
178
|
+
# @param id [Integer] The deal id.
|
179
|
+
# @param investor_id [Integer] The investor id.
|
180
|
+
# @param [Hash] opts the optional parameters
|
181
|
+
# @return [Array<(V1EntitiesInvestorOtpAccessLink, Integer, Hash)>] V1EntitiesInvestorOtpAccessLink data, response status code and response headers
|
182
|
+
def get_investor_otp_link_with_http_info(id, investor_id, opts = {})
|
183
|
+
if @api_client.config.debugging
|
184
|
+
@api_client.config.logger.debug 'Calling API: InvestorApi.get_investor_otp_link ...'
|
185
|
+
end
|
186
|
+
# verify the required parameter 'id' is set
|
187
|
+
if @api_client.config.client_side_validation && id.nil?
|
188
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InvestorApi.get_investor_otp_link"
|
189
|
+
end
|
190
|
+
# verify the required parameter 'investor_id' is set
|
191
|
+
if @api_client.config.client_side_validation && investor_id.nil?
|
192
|
+
fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_investor_otp_link"
|
193
|
+
end
|
194
|
+
# resource path
|
195
|
+
local_var_path = '/deals/{id}/investors/{investor_id}/otp_access_link'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s))
|
196
|
+
|
197
|
+
# query parameters
|
198
|
+
query_params = opts[:query_params] || {}
|
199
|
+
|
200
|
+
# header parameters
|
201
|
+
header_params = opts[:header_params] || {}
|
202
|
+
# HTTP header 'Accept' (if needed)
|
203
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
204
|
+
|
205
|
+
# form parameters
|
206
|
+
form_params = opts[:form_params] || {}
|
207
|
+
|
208
|
+
# http body (model)
|
209
|
+
post_body = opts[:debug_body]
|
210
|
+
|
211
|
+
# return_type
|
212
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesInvestorOtpAccessLink'
|
213
|
+
|
214
|
+
# auth_names
|
215
|
+
auth_names = opts[:debug_auth_names] || []
|
216
|
+
|
217
|
+
new_options = opts.merge(
|
218
|
+
:operation => :"InvestorApi.get_investor_otp_link",
|
219
|
+
:header_params => header_params,
|
220
|
+
:query_params => query_params,
|
221
|
+
:form_params => form_params,
|
222
|
+
:body => post_body,
|
223
|
+
:auth_names => auth_names,
|
224
|
+
:return_type => return_type
|
225
|
+
)
|
226
|
+
|
227
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
228
|
+
if @api_client.config.debugging
|
229
|
+
@api_client.config.logger.debug "API called: InvestorApi#get_investor_otp_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
230
|
+
end
|
231
|
+
return data, status_code, headers
|
232
|
+
end
|
233
|
+
|
165
234
|
# List deal investors
|
166
235
|
# List deal investors according to the specified search criteria.
|
167
236
|
# @param id [Integer] The deal id.
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 6.
|
9
|
+
OpenAPI Generator version: 6.5.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -291,6 +291,144 @@ module DealMakerAPI
|
|
291
291
|
return data, status_code, headers
|
292
292
|
end
|
293
293
|
|
294
|
+
# Get list of InvestorProfiles for a specific deal
|
295
|
+
# Get investor profiles for a specific deal
|
296
|
+
# @param deal_id [Integer] The deal id.
|
297
|
+
# @param [Hash] opts the optional parameters
|
298
|
+
# @option opts [Integer] :page Page offset to fetch. (default to 1)
|
299
|
+
# @option opts [Integer] :per_page Number of results to return per page. (default to 25)
|
300
|
+
# @option opts [Integer] :offset Pad a number of results. (default to 0)
|
301
|
+
# @option opts [Integer] :user_id The user id filter.
|
302
|
+
# @return [V1EntitiesInvestorProfiles]
|
303
|
+
def get_deal_investor_profiles(deal_id, opts = {})
|
304
|
+
data, _status_code, _headers = get_deal_investor_profiles_with_http_info(deal_id, opts)
|
305
|
+
data
|
306
|
+
end
|
307
|
+
|
308
|
+
# Get list of InvestorProfiles for a specific deal
|
309
|
+
# Get investor profiles for a specific deal
|
310
|
+
# @param deal_id [Integer] The deal id.
|
311
|
+
# @param [Hash] opts the optional parameters
|
312
|
+
# @option opts [Integer] :page Page offset to fetch. (default to 1)
|
313
|
+
# @option opts [Integer] :per_page Number of results to return per page. (default to 25)
|
314
|
+
# @option opts [Integer] :offset Pad a number of results. (default to 0)
|
315
|
+
# @option opts [Integer] :user_id The user id filter.
|
316
|
+
# @return [Array<(V1EntitiesInvestorProfiles, Integer, Hash)>] V1EntitiesInvestorProfiles data, response status code and response headers
|
317
|
+
def get_deal_investor_profiles_with_http_info(deal_id, opts = {})
|
318
|
+
if @api_client.config.debugging
|
319
|
+
@api_client.config.logger.debug 'Calling API: InvestorProfileApi.get_deal_investor_profiles ...'
|
320
|
+
end
|
321
|
+
# verify the required parameter 'deal_id' is set
|
322
|
+
if @api_client.config.client_side_validation && deal_id.nil?
|
323
|
+
fail ArgumentError, "Missing the required parameter 'deal_id' when calling InvestorProfileApi.get_deal_investor_profiles"
|
324
|
+
end
|
325
|
+
# resource path
|
326
|
+
local_var_path = '/investor_profiles/{deal_id}'.sub('{' + 'deal_id' + '}', CGI.escape(deal_id.to_s))
|
327
|
+
|
328
|
+
# query parameters
|
329
|
+
query_params = opts[:query_params] || {}
|
330
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
331
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
332
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
333
|
+
query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
|
334
|
+
|
335
|
+
# header parameters
|
336
|
+
header_params = opts[:header_params] || {}
|
337
|
+
# HTTP header 'Accept' (if needed)
|
338
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
339
|
+
|
340
|
+
# form parameters
|
341
|
+
form_params = opts[:form_params] || {}
|
342
|
+
|
343
|
+
# http body (model)
|
344
|
+
post_body = opts[:debug_body]
|
345
|
+
|
346
|
+
# return_type
|
347
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfiles'
|
348
|
+
|
349
|
+
# auth_names
|
350
|
+
auth_names = opts[:debug_auth_names] || []
|
351
|
+
|
352
|
+
new_options = opts.merge(
|
353
|
+
:operation => :"InvestorProfileApi.get_deal_investor_profiles",
|
354
|
+
:header_params => header_params,
|
355
|
+
:query_params => query_params,
|
356
|
+
:form_params => form_params,
|
357
|
+
:body => post_body,
|
358
|
+
:auth_names => auth_names,
|
359
|
+
:return_type => return_type
|
360
|
+
)
|
361
|
+
|
362
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
363
|
+
if @api_client.config.debugging
|
364
|
+
@api_client.config.logger.debug "API called: InvestorProfileApi#get_deal_investor_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
365
|
+
end
|
366
|
+
return data, status_code, headers
|
367
|
+
end
|
368
|
+
|
369
|
+
# Get an investor profile by id
|
370
|
+
# Get an investor profile
|
371
|
+
# @param id [Integer] The id of the investor profile.
|
372
|
+
# @param [Hash] opts the optional parameters
|
373
|
+
# @return [V1EntitiesInvestorProfileItem]
|
374
|
+
def get_investor_profile(id, opts = {})
|
375
|
+
data, _status_code, _headers = get_investor_profile_with_http_info(id, opts)
|
376
|
+
data
|
377
|
+
end
|
378
|
+
|
379
|
+
# Get an investor profile by id
|
380
|
+
# Get an investor profile
|
381
|
+
# @param id [Integer] The id of the investor profile.
|
382
|
+
# @param [Hash] opts the optional parameters
|
383
|
+
# @return [Array<(V1EntitiesInvestorProfileItem, Integer, Hash)>] V1EntitiesInvestorProfileItem data, response status code and response headers
|
384
|
+
def get_investor_profile_with_http_info(id, opts = {})
|
385
|
+
if @api_client.config.debugging
|
386
|
+
@api_client.config.logger.debug 'Calling API: InvestorProfileApi.get_investor_profile ...'
|
387
|
+
end
|
388
|
+
# verify the required parameter 'id' is set
|
389
|
+
if @api_client.config.client_side_validation && id.nil?
|
390
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InvestorProfileApi.get_investor_profile"
|
391
|
+
end
|
392
|
+
# resource path
|
393
|
+
local_var_path = '/investor_profiles/profile/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
394
|
+
|
395
|
+
# query parameters
|
396
|
+
query_params = opts[:query_params] || {}
|
397
|
+
|
398
|
+
# header parameters
|
399
|
+
header_params = opts[:header_params] || {}
|
400
|
+
# HTTP header 'Accept' (if needed)
|
401
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
402
|
+
|
403
|
+
# form parameters
|
404
|
+
form_params = opts[:form_params] || {}
|
405
|
+
|
406
|
+
# http body (model)
|
407
|
+
post_body = opts[:debug_body]
|
408
|
+
|
409
|
+
# return_type
|
410
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileItem'
|
411
|
+
|
412
|
+
# auth_names
|
413
|
+
auth_names = opts[:debug_auth_names] || []
|
414
|
+
|
415
|
+
new_options = opts.merge(
|
416
|
+
:operation => :"InvestorProfileApi.get_investor_profile",
|
417
|
+
:header_params => header_params,
|
418
|
+
:query_params => query_params,
|
419
|
+
:form_params => form_params,
|
420
|
+
:body => post_body,
|
421
|
+
:auth_names => auth_names,
|
422
|
+
:return_type => return_type
|
423
|
+
)
|
424
|
+
|
425
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
426
|
+
if @api_client.config.debugging
|
427
|
+
@api_client.config.logger.debug "API called: InvestorProfileApi#get_investor_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
428
|
+
end
|
429
|
+
return data, status_code, headers
|
430
|
+
end
|
431
|
+
|
294
432
|
# Get list of InvestorProfiles
|
295
433
|
# Get investor profiles
|
296
434
|
# @param [Hash] opts the optional parameters
|