DealMakerAPI 0.98.0 → 0.98.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -4
- data/docs/CompanyApi.md +69 -0
- data/docs/CreateEmailTemplateRequest.md +22 -0
- data/docs/DefaultApi.md +66 -0
- data/docs/InvestorApi.md +71 -0
- data/docs/V1EntitiesEmailTemplate.md +24 -0
- data/docs/V1EntitiesInvestorSearchEntities.md +26 -0
- data/docs/V1EntitiesInvestorSearchEntitiesRequiredFields.md +26 -0
- data/lib/DealMakerAPI/api/company_api.rb +74 -0
- data/lib/DealMakerAPI/api/default_api.rb +61 -0
- data/lib/DealMakerAPI/api/investor_api.rb +69 -0
- data/lib/DealMakerAPI/models/create_email_template_request.rb +256 -0
- data/lib/DealMakerAPI/models/v1_entities_email_template.rb +246 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_search_entities.rb +289 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_search_entities_required_fields.rb +255 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +4 -0
- data/spec/api/company_api_spec.rb +13 -0
- data/spec/api/default_api_spec.rb +12 -0
- data/spec/api/investor_api_spec.rb +13 -0
- data/spec/models/create_email_template_request_spec.rb +48 -0
- data/spec/models/v1_entities_email_template_spec.rb +54 -0
- data/spec/models/v1_entities_investor_search_entities_required_fields_spec.rb +60 -0
- data/spec/models/v1_entities_investor_search_entities_spec.rb +64 -0
- metadata +118 -102
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 85e4b10fa6177c246be430746b1eb6a80fa94c403951b8dc1cbc4fdea459ee85
|
4
|
+
data.tar.gz: ddab8ea699c00ad33c94ff9479fee560b8fbdac31a04773b9f4fd8baeb8faa57
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d2883a0d5f7063d487ed3d76fdfdbb6093ba4377b344d3dc356a541d13ea1284aa5469692c158db254d1a00d345f37da7bd0f47b986e289e86d9841a596cf9c2
|
7
|
+
data.tar.gz: b92fb77cd7443a3177fc2b2745c85d15748507701a28a66e90387612b44b5748dbcb8b0be027f196242717a695170f38e4b6577835d5f3babdf549c430e6335c
|
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.98.
|
341
|
+
- Package version: 0.98.2
|
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.98.
|
357
|
+
gem install ./DealMakerAPI-0.98.2.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.98.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.98.2.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.98.
|
366
|
+
gem 'DealMakerAPI', '~> 0.98.2'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -413,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
413
413
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
|
414
414
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload_detail**](docs/CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record
|
415
415
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
416
|
+
*DealMakerAPI::CompanyApi* | [**create_email_template**](docs/CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_template | Creates an email template
|
416
417
|
*DealMakerAPI::CompanyApi* | [**create_shareholder_action**](docs/CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action
|
417
418
|
*DealMakerAPI::CompanyApi* | [**get_bulk_upload**](docs/CompanyApi.md#get_bulk_upload) | **GET** /companies/{id}/documents/bulk_uploads/{bulk_upload_id} | Return a given bulk upload by id
|
418
419
|
*DealMakerAPI::CompanyApi* | [**get_bulk_upload_details_errors**](docs/CompanyApi.md#get_bulk_upload_details_errors) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/errors | Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc
|
@@ -436,6 +437,7 @@ Class | Method | HTTP request | Description
|
|
436
437
|
*DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data
|
437
438
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal
|
438
439
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_investors_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal
|
440
|
+
*DealMakerAPI::DefaultApi* | [**get_deals_id_summary**](docs/DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview
|
439
441
|
*DealMakerAPI::DefaultApi* | [**get_deals_payment_onboarding_questionnaire_initial_questions**](docs/DefaultApi.md#get_deals_payment_onboarding_questionnaire_initial_questions) | **GET** /deals/payment_onboarding/questionnaire/initial_questions | Get initial questions
|
440
442
|
*DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
|
441
443
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_deal_id**](docs/DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id
|
@@ -456,6 +458,7 @@ Class | Method | HTTP request | Description
|
|
456
458
|
*DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
|
457
459
|
*DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
|
458
460
|
*DealMakerAPI::InvestorApi* | [**edit_investor_tags**](docs/InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor
|
461
|
+
*DealMakerAPI::InvestorApi* | [**get_deal_investor_search_entities**](docs/InvestorApi.md#get_deal_investor_search_entities) | **GET** /deals/{id}/investors/{investor_id}/search_entities | Get the search entities attached to the investor
|
459
462
|
*DealMakerAPI::InvestorApi* | [**get_enforcements**](docs/InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search
|
460
463
|
*DealMakerAPI::InvestorApi* | [**get_incentive_plan**](docs/InvestorApi.md#get_incentive_plan) | **GET** /deals/{id}/investors/{investor_id}/incentive_plan | Get investor incentive plan by investor id
|
461
464
|
*DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
|
@@ -493,6 +496,7 @@ Class | Method | HTTP request | Description
|
|
493
496
|
- [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
|
494
497
|
- [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
495
498
|
- [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
|
499
|
+
- [DealMakerAPI::CreateEmailTemplateRequest](docs/CreateEmailTemplateRequest.md)
|
496
500
|
- [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
|
497
501
|
- [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
|
498
502
|
- [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
|
@@ -550,6 +554,7 @@ Class | Method | HTTP request | Description
|
|
550
554
|
- [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
|
551
555
|
- [DealMakerAPI::V1EntitiesEmailEvent](docs/V1EntitiesEmailEvent.md)
|
552
556
|
- [DealMakerAPI::V1EntitiesEmailEvents](docs/V1EntitiesEmailEvents.md)
|
557
|
+
- [DealMakerAPI::V1EntitiesEmailTemplate](docs/V1EntitiesEmailTemplate.md)
|
553
558
|
- [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
|
554
559
|
- [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
|
555
560
|
- [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
|
@@ -574,6 +579,8 @@ Class | Method | HTTP request | Description
|
|
574
579
|
- [DealMakerAPI::V1EntitiesInvestorProfileOwner](docs/V1EntitiesInvestorProfileOwner.md)
|
575
580
|
- [DealMakerAPI::V1EntitiesInvestorProfileTrust](docs/V1EntitiesInvestorProfileTrust.md)
|
576
581
|
- [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
|
582
|
+
- [DealMakerAPI::V1EntitiesInvestorSearchEntities](docs/V1EntitiesInvestorSearchEntities.md)
|
583
|
+
- [DealMakerAPI::V1EntitiesInvestorSearchEntitiesRequiredFields](docs/V1EntitiesInvestorSearchEntitiesRequiredFields.md)
|
577
584
|
- [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
|
578
585
|
- [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
|
579
586
|
- [DealMakerAPI::V1EntitiesMoneyEntity](docs/V1EntitiesMoneyEntity.md)
|
data/docs/CompanyApi.md
CHANGED
@@ -7,6 +7,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
7
7
|
| [**create_bulk_upload**](CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record |
|
8
8
|
| [**create_bulk_upload_detail**](CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record |
|
9
9
|
| [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
|
10
|
+
| [**create_email_template**](CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_template | Creates an email template |
|
10
11
|
| [**create_shareholder_action**](CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action |
|
11
12
|
| [**get_bulk_upload**](CompanyApi.md#get_bulk_upload) | **GET** /companies/{id}/documents/bulk_uploads/{bulk_upload_id} | Return a given bulk upload by id |
|
12
13
|
| [**get_bulk_upload_details_errors**](CompanyApi.md#get_bulk_upload_details_errors) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/errors | Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc |
|
@@ -225,6 +226,74 @@ No authorization required
|
|
225
226
|
- **Accept**: application/json
|
226
227
|
|
227
228
|
|
229
|
+
## create_email_template
|
230
|
+
|
231
|
+
> <V1EntitiesEmailTemplate> create_email_template(id, create_email_template_request)
|
232
|
+
|
233
|
+
Creates an email template
|
234
|
+
|
235
|
+
Create new email template
|
236
|
+
|
237
|
+
### Examples
|
238
|
+
|
239
|
+
```ruby
|
240
|
+
require 'time'
|
241
|
+
require 'DealMakerAPI'
|
242
|
+
# setup authorization
|
243
|
+
DealMakerAPI.configure do |config|end
|
244
|
+
|
245
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
246
|
+
id = 56 # Integer |
|
247
|
+
create_email_template_request = DealMakerAPI::CreateEmailTemplateRequest.new({name: 'name_example', json_content: 'json_content_example', html_content: 'html_content_example'}) # CreateEmailTemplateRequest |
|
248
|
+
|
249
|
+
begin
|
250
|
+
# Creates an email template
|
251
|
+
result = api_instance.create_email_template(id, create_email_template_request)
|
252
|
+
p result
|
253
|
+
rescue DealMakerAPI::ApiError => e
|
254
|
+
puts "Error when calling CompanyApi->create_email_template: #{e}"
|
255
|
+
end
|
256
|
+
```
|
257
|
+
|
258
|
+
#### Using the create_email_template_with_http_info variant
|
259
|
+
|
260
|
+
This returns an Array which contains the response data, status code and headers.
|
261
|
+
|
262
|
+
> <Array(<V1EntitiesEmailTemplate>, Integer, Hash)> create_email_template_with_http_info(id, create_email_template_request)
|
263
|
+
|
264
|
+
```ruby
|
265
|
+
begin
|
266
|
+
# Creates an email template
|
267
|
+
data, status_code, headers = api_instance.create_email_template_with_http_info(id, create_email_template_request)
|
268
|
+
p status_code # => 2xx
|
269
|
+
p headers # => { ... }
|
270
|
+
p data # => <V1EntitiesEmailTemplate>
|
271
|
+
rescue DealMakerAPI::ApiError => e
|
272
|
+
puts "Error when calling CompanyApi->create_email_template_with_http_info: #{e}"
|
273
|
+
end
|
274
|
+
```
|
275
|
+
|
276
|
+
### Parameters
|
277
|
+
|
278
|
+
| Name | Type | Description | Notes |
|
279
|
+
| ---- | ---- | ----------- | ----- |
|
280
|
+
| **id** | **Integer** | | |
|
281
|
+
| **create_email_template_request** | [**CreateEmailTemplateRequest**](CreateEmailTemplateRequest.md) | | |
|
282
|
+
|
283
|
+
### Return type
|
284
|
+
|
285
|
+
[**V1EntitiesEmailTemplate**](V1EntitiesEmailTemplate.md)
|
286
|
+
|
287
|
+
### Authorization
|
288
|
+
|
289
|
+
No authorization required
|
290
|
+
|
291
|
+
### HTTP request headers
|
292
|
+
|
293
|
+
- **Content-Type**: application/json
|
294
|
+
- **Accept**: application/json
|
295
|
+
|
296
|
+
|
228
297
|
## create_shareholder_action
|
229
298
|
|
230
299
|
> <V1EntitiesGenericResponse> create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request)
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DealMakerAPI::CreateEmailTemplateRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | The name of the email template | |
|
8
|
+
| **json_content** | **String** | The json content of the email template | |
|
9
|
+
| **html_content** | **String** | The HTML content markup | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'DealMakerAPI'
|
15
|
+
|
16
|
+
instance = DealMakerAPI::CreateEmailTemplateRequest.new(
|
17
|
+
name: null,
|
18
|
+
json_content: null,
|
19
|
+
html_content: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/DefaultApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
8
8
|
| [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data |
|
9
9
|
| [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal |
|
10
10
|
| [**get_deals_id_investors_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal |
|
11
|
+
| [**get_deals_id_summary**](DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview |
|
11
12
|
| [**get_deals_payment_onboarding_questionnaire_initial_questions**](DefaultApi.md#get_deals_payment_onboarding_questionnaire_initial_questions) | **GET** /deals/payment_onboarding/questionnaire/initial_questions | Get initial questions |
|
12
13
|
| [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
|
13
14
|
| [**get_webhooks_deal_id**](DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id |
|
@@ -286,6 +287,71 @@ No authorization required
|
|
286
287
|
- **Accept**: application/json
|
287
288
|
|
288
289
|
|
290
|
+
## get_deals_id_summary
|
291
|
+
|
292
|
+
> get_deals_id_summary(id)
|
293
|
+
|
294
|
+
Get Deal Overview
|
295
|
+
|
296
|
+
Get Deal Overview
|
297
|
+
|
298
|
+
### Examples
|
299
|
+
|
300
|
+
```ruby
|
301
|
+
require 'time'
|
302
|
+
require 'DealMakerAPI'
|
303
|
+
# setup authorization
|
304
|
+
DealMakerAPI.configure do |config|end
|
305
|
+
|
306
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
307
|
+
id = 56 # Integer |
|
308
|
+
|
309
|
+
begin
|
310
|
+
# Get Deal Overview
|
311
|
+
api_instance.get_deals_id_summary(id)
|
312
|
+
rescue DealMakerAPI::ApiError => e
|
313
|
+
puts "Error when calling DefaultApi->get_deals_id_summary: #{e}"
|
314
|
+
end
|
315
|
+
```
|
316
|
+
|
317
|
+
#### Using the get_deals_id_summary_with_http_info variant
|
318
|
+
|
319
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
320
|
+
|
321
|
+
> <Array(nil, Integer, Hash)> get_deals_id_summary_with_http_info(id)
|
322
|
+
|
323
|
+
```ruby
|
324
|
+
begin
|
325
|
+
# Get Deal Overview
|
326
|
+
data, status_code, headers = api_instance.get_deals_id_summary_with_http_info(id)
|
327
|
+
p status_code # => 2xx
|
328
|
+
p headers # => { ... }
|
329
|
+
p data # => nil
|
330
|
+
rescue DealMakerAPI::ApiError => e
|
331
|
+
puts "Error when calling DefaultApi->get_deals_id_summary_with_http_info: #{e}"
|
332
|
+
end
|
333
|
+
```
|
334
|
+
|
335
|
+
### Parameters
|
336
|
+
|
337
|
+
| Name | Type | Description | Notes |
|
338
|
+
| ---- | ---- | ----------- | ----- |
|
339
|
+
| **id** | **Integer** | | |
|
340
|
+
|
341
|
+
### Return type
|
342
|
+
|
343
|
+
nil (empty response body)
|
344
|
+
|
345
|
+
### Authorization
|
346
|
+
|
347
|
+
No authorization required
|
348
|
+
|
349
|
+
### HTTP request headers
|
350
|
+
|
351
|
+
- **Content-Type**: Not defined
|
352
|
+
- **Accept**: Not defined
|
353
|
+
|
354
|
+
|
289
355
|
## get_deals_payment_onboarding_questionnaire_initial_questions
|
290
356
|
|
291
357
|
> get_deals_payment_onboarding_questionnaire_initial_questions
|
data/docs/InvestorApi.md
CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
11
11
|
| [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
|
12
12
|
| [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
|
13
13
|
| [**edit_investor_tags**](InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor |
|
14
|
+
| [**get_deal_investor_search_entities**](InvestorApi.md#get_deal_investor_search_entities) | **GET** /deals/{id}/investors/{investor_id}/search_entities | Get the search entities attached to the investor |
|
14
15
|
| [**get_enforcements**](InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search |
|
15
16
|
| [**get_incentive_plan**](InvestorApi.md#get_incentive_plan) | **GET** /deals/{id}/investors/{investor_id}/incentive_plan | Get investor incentive plan by investor id |
|
16
17
|
| [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
|
@@ -503,6 +504,74 @@ No authorization required
|
|
503
504
|
- **Accept**: application/json
|
504
505
|
|
505
506
|
|
507
|
+
## get_deal_investor_search_entities
|
508
|
+
|
509
|
+
> <V1EntitiesInvestorSearchEntities> get_deal_investor_search_entities(id, investor_id)
|
510
|
+
|
511
|
+
Get the search entities attached to the investor
|
512
|
+
|
513
|
+
Get the entities that needs to be updated due to wrong information.
|
514
|
+
|
515
|
+
### Examples
|
516
|
+
|
517
|
+
```ruby
|
518
|
+
require 'time'
|
519
|
+
require 'DealMakerAPI'
|
520
|
+
# setup authorization
|
521
|
+
DealMakerAPI.configure do |config|end
|
522
|
+
|
523
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
524
|
+
id = 56 # Integer | The deal id.
|
525
|
+
investor_id = 56 # Integer | The investor id.
|
526
|
+
|
527
|
+
begin
|
528
|
+
# Get the search entities attached to the investor
|
529
|
+
result = api_instance.get_deal_investor_search_entities(id, investor_id)
|
530
|
+
p result
|
531
|
+
rescue DealMakerAPI::ApiError => e
|
532
|
+
puts "Error when calling InvestorApi->get_deal_investor_search_entities: #{e}"
|
533
|
+
end
|
534
|
+
```
|
535
|
+
|
536
|
+
#### Using the get_deal_investor_search_entities_with_http_info variant
|
537
|
+
|
538
|
+
This returns an Array which contains the response data, status code and headers.
|
539
|
+
|
540
|
+
> <Array(<V1EntitiesInvestorSearchEntities>, Integer, Hash)> get_deal_investor_search_entities_with_http_info(id, investor_id)
|
541
|
+
|
542
|
+
```ruby
|
543
|
+
begin
|
544
|
+
# Get the search entities attached to the investor
|
545
|
+
data, status_code, headers = api_instance.get_deal_investor_search_entities_with_http_info(id, investor_id)
|
546
|
+
p status_code # => 2xx
|
547
|
+
p headers # => { ... }
|
548
|
+
p data # => <V1EntitiesInvestorSearchEntities>
|
549
|
+
rescue DealMakerAPI::ApiError => e
|
550
|
+
puts "Error when calling InvestorApi->get_deal_investor_search_entities_with_http_info: #{e}"
|
551
|
+
end
|
552
|
+
```
|
553
|
+
|
554
|
+
### Parameters
|
555
|
+
|
556
|
+
| Name | Type | Description | Notes |
|
557
|
+
| ---- | ---- | ----------- | ----- |
|
558
|
+
| **id** | **Integer** | The deal id. | |
|
559
|
+
| **investor_id** | **Integer** | The investor id. | |
|
560
|
+
|
561
|
+
### Return type
|
562
|
+
|
563
|
+
[**V1EntitiesInvestorSearchEntities**](V1EntitiesInvestorSearchEntities.md)
|
564
|
+
|
565
|
+
### Authorization
|
566
|
+
|
567
|
+
No authorization required
|
568
|
+
|
569
|
+
### HTTP request headers
|
570
|
+
|
571
|
+
- **Content-Type**: Not defined
|
572
|
+
- **Accept**: application/json
|
573
|
+
|
574
|
+
|
506
575
|
## get_enforcements
|
507
576
|
|
508
577
|
> <V1EntitiesInvestor> get_enforcements(id, investor_id, search_entity_id)
|
@@ -938,6 +1007,8 @@ Run Alloy background search for the investor
|
|
938
1007
|
```ruby
|
939
1008
|
require 'time'
|
940
1009
|
require 'DealMakerAPI'
|
1010
|
+
# setup authorization
|
1011
|
+
DealMakerAPI.configure do |config|end
|
941
1012
|
|
942
1013
|
api_instance = DealMakerAPI::InvestorApi.new
|
943
1014
|
id = 56 # Integer |
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesEmailTemplate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the email template. | [optional] |
|
8
|
+
| **name** | **String** | The name of the email template. | [optional] |
|
9
|
+
| **json_content** | **String** | The json content of the email template. | [optional] |
|
10
|
+
| **company_id** | **Integer** | The ID of the company. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'DealMakerAPI'
|
16
|
+
|
17
|
+
instance = DealMakerAPI::V1EntitiesEmailTemplate.new(
|
18
|
+
id: null,
|
19
|
+
name: null,
|
20
|
+
json_content: null,
|
21
|
+
company_id: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorSearchEntities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | Search entity ID. | [optional] |
|
8
|
+
| **name** | **String** | The full name of the entity. | [optional] |
|
9
|
+
| **type** | **String** | The type of the entity. | [optional] |
|
10
|
+
| **type_num** | **String** | The position in the list when beneficial owner of trustees, if none it returns null. | [optional] |
|
11
|
+
| **required_fields** | [**V1EntitiesInvestorSearchEntitiesRequiredFields**](V1EntitiesInvestorSearchEntitiesRequiredFields.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'DealMakerAPI'
|
17
|
+
|
18
|
+
instance = DealMakerAPI::V1EntitiesInvestorSearchEntities.new(
|
19
|
+
id: null,
|
20
|
+
name: null,
|
21
|
+
type: null,
|
22
|
+
type_num: null,
|
23
|
+
required_fields: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorSearchEntitiesRequiredFields
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **count** | **Integer** | The quantity of fields that needs to be updated. | [optional] |
|
8
|
+
| **name** | **Boolean** | Whether or not the name needs to be updated. | [optional] |
|
9
|
+
| **address** | **Boolean** | Whether or not the address needs to be updated. | [optional] |
|
10
|
+
| **date_of_birth** | **Boolean** | Whether or not the date of birth needs to be updated. | [optional] |
|
11
|
+
| **tin** | **Boolean** | Whether or not the taxpayer identification number needs to be updated. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'DealMakerAPI'
|
17
|
+
|
18
|
+
instance = DealMakerAPI::V1EntitiesInvestorSearchEntitiesRequiredFields.new(
|
19
|
+
count: null,
|
20
|
+
name: null,
|
21
|
+
address: null,
|
22
|
+
date_of_birth: null,
|
23
|
+
tin: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -241,6 +241,80 @@ module DealMakerAPI
|
|
241
241
|
return data, status_code, headers
|
242
242
|
end
|
243
243
|
|
244
|
+
# Creates an email template
|
245
|
+
# Create new email template
|
246
|
+
# @param id [Integer]
|
247
|
+
# @param create_email_template_request [CreateEmailTemplateRequest]
|
248
|
+
# @param [Hash] opts the optional parameters
|
249
|
+
# @return [V1EntitiesEmailTemplate]
|
250
|
+
def create_email_template(id, create_email_template_request, opts = {})
|
251
|
+
data, _status_code, _headers = create_email_template_with_http_info(id, create_email_template_request, opts)
|
252
|
+
data
|
253
|
+
end
|
254
|
+
|
255
|
+
# Creates an email template
|
256
|
+
# Create new email template
|
257
|
+
# @param id [Integer]
|
258
|
+
# @param create_email_template_request [CreateEmailTemplateRequest]
|
259
|
+
# @param [Hash] opts the optional parameters
|
260
|
+
# @return [Array<(V1EntitiesEmailTemplate, Integer, Hash)>] V1EntitiesEmailTemplate data, response status code and response headers
|
261
|
+
def create_email_template_with_http_info(id, create_email_template_request, opts = {})
|
262
|
+
if @api_client.config.debugging
|
263
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.create_email_template ...'
|
264
|
+
end
|
265
|
+
# verify the required parameter 'id' is set
|
266
|
+
if @api_client.config.client_side_validation && id.nil?
|
267
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.create_email_template"
|
268
|
+
end
|
269
|
+
# verify the required parameter 'create_email_template_request' is set
|
270
|
+
if @api_client.config.client_side_validation && create_email_template_request.nil?
|
271
|
+
fail ArgumentError, "Missing the required parameter 'create_email_template_request' when calling CompanyApi.create_email_template"
|
272
|
+
end
|
273
|
+
# resource path
|
274
|
+
local_var_path = '/companies/{id}/news_releases/email_template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
275
|
+
|
276
|
+
# query parameters
|
277
|
+
query_params = opts[:query_params] || {}
|
278
|
+
|
279
|
+
# header parameters
|
280
|
+
header_params = opts[:header_params] || {}
|
281
|
+
# HTTP header 'Accept' (if needed)
|
282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
283
|
+
# HTTP header 'Content-Type'
|
284
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
285
|
+
if !content_type.nil?
|
286
|
+
header_params['Content-Type'] = content_type
|
287
|
+
end
|
288
|
+
|
289
|
+
# form parameters
|
290
|
+
form_params = opts[:form_params] || {}
|
291
|
+
|
292
|
+
# http body (model)
|
293
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_email_template_request)
|
294
|
+
|
295
|
+
# return_type
|
296
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesEmailTemplate'
|
297
|
+
|
298
|
+
# auth_names
|
299
|
+
auth_names = opts[:debug_auth_names] || []
|
300
|
+
|
301
|
+
new_options = opts.merge(
|
302
|
+
:operation => :"CompanyApi.create_email_template",
|
303
|
+
:header_params => header_params,
|
304
|
+
:query_params => query_params,
|
305
|
+
:form_params => form_params,
|
306
|
+
:body => post_body,
|
307
|
+
:auth_names => auth_names,
|
308
|
+
:return_type => return_type
|
309
|
+
)
|
310
|
+
|
311
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
312
|
+
if @api_client.config.debugging
|
313
|
+
@api_client.config.logger.debug "API called: CompanyApi#create_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
314
|
+
end
|
315
|
+
return data, status_code, headers
|
316
|
+
end
|
317
|
+
|
244
318
|
# Create a shareholder action
|
245
319
|
# Create a shareholder action
|
246
320
|
# @param company_id [Integer] The company id
|
@@ -277,6 +277,67 @@ module DealMakerAPI
|
|
277
277
|
return data, status_code, headers
|
278
278
|
end
|
279
279
|
|
280
|
+
# Get Deal Overview
|
281
|
+
# Get Deal Overview
|
282
|
+
# @param id [Integer]
|
283
|
+
# @param [Hash] opts the optional parameters
|
284
|
+
# @return [nil]
|
285
|
+
def get_deals_id_summary(id, opts = {})
|
286
|
+
get_deals_id_summary_with_http_info(id, opts)
|
287
|
+
nil
|
288
|
+
end
|
289
|
+
|
290
|
+
# Get Deal Overview
|
291
|
+
# Get Deal Overview
|
292
|
+
# @param id [Integer]
|
293
|
+
# @param [Hash] opts the optional parameters
|
294
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
295
|
+
def get_deals_id_summary_with_http_info(id, opts = {})
|
296
|
+
if @api_client.config.debugging
|
297
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_id_summary ...'
|
298
|
+
end
|
299
|
+
# verify the required parameter 'id' is set
|
300
|
+
if @api_client.config.client_side_validation && id.nil?
|
301
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.get_deals_id_summary"
|
302
|
+
end
|
303
|
+
# resource path
|
304
|
+
local_var_path = '/deals/{id}/summary'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
305
|
+
|
306
|
+
# query parameters
|
307
|
+
query_params = opts[:query_params] || {}
|
308
|
+
|
309
|
+
# header parameters
|
310
|
+
header_params = opts[:header_params] || {}
|
311
|
+
|
312
|
+
# form parameters
|
313
|
+
form_params = opts[:form_params] || {}
|
314
|
+
|
315
|
+
# http body (model)
|
316
|
+
post_body = opts[:debug_body]
|
317
|
+
|
318
|
+
# return_type
|
319
|
+
return_type = opts[:debug_return_type]
|
320
|
+
|
321
|
+
# auth_names
|
322
|
+
auth_names = opts[:debug_auth_names] || []
|
323
|
+
|
324
|
+
new_options = opts.merge(
|
325
|
+
:operation => :"DefaultApi.get_deals_id_summary",
|
326
|
+
:header_params => header_params,
|
327
|
+
:query_params => query_params,
|
328
|
+
:form_params => form_params,
|
329
|
+
:body => post_body,
|
330
|
+
:auth_names => auth_names,
|
331
|
+
:return_type => return_type
|
332
|
+
)
|
333
|
+
|
334
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
335
|
+
if @api_client.config.debugging
|
336
|
+
@api_client.config.logger.debug "API called: DefaultApi#get_deals_id_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
337
|
+
end
|
338
|
+
return data, status_code, headers
|
339
|
+
end
|
340
|
+
|
280
341
|
# Get initial questions
|
281
342
|
# Get initial questions
|
282
343
|
# @param [Hash] opts the optional parameters
|