DealMakerAPI 0.78.4 → 0.80.1
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/AddDocumentRequest.md +24 -0
- data/docs/CreateCorporationProfileRequest.md +3 -1
- data/docs/CreateIndividualProfileRequest.md +3 -1
- data/docs/CreateJointProfileRequest.md +3 -1
- data/docs/CreateTrustProfileRequest.md +3 -1
- data/docs/DealApi.md +71 -0
- data/docs/InvestorApi.md +141 -0
- data/docs/PatchCorporationProfileRequest.md +3 -1
- data/docs/PatchIndividualProfileRequest.md +3 -1
- data/docs/PatchJointProfileRequest.md +3 -1
- data/docs/PatchTrustProfileRequest.md +3 -1
- data/docs/ShareholderApi.md +74 -0
- data/docs/UpdateInvestorRequest.md +3 -1
- data/docs/V1EntitiesInvestorProfileCorporation.md +3 -1
- data/docs/V1EntitiesInvestorProfileIndividual.md +3 -1
- data/docs/V1EntitiesInvestorProfileJoint.md +3 -1
- data/docs/V1EntitiesInvestorProfileTrust.md +3 -1
- data/docs/V1EntitiesShareholder.md +22 -0
- data/docs/V1EntitiesShareholders.md +18 -0
- data/lib/DealMakerAPI/api/deal_api.rb +66 -0
- data/lib/DealMakerAPI/api/investor_api.rb +153 -0
- data/lib/DealMakerAPI/api/shareholder_api.rb +85 -0
- data/lib/DealMakerAPI/models/add_document_request.rb +296 -0
- data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/create_individual_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/create_joint_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/create_trust_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +24 -2
- data/lib/DealMakerAPI/models/update_investor_request.rb +14 -4
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +12 -2
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +12 -2
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +12 -2
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +12 -2
- data/lib/DealMakerAPI/models/v1_entities_shareholder.rb +240 -0
- data/lib/DealMakerAPI/models/v1_entities_shareholders.rb +220 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +4 -0
- data/spec/api/deal_api_spec.rb +13 -0
- data/spec/api/investor_api_spec.rb +28 -0
- data/spec/api/shareholder_api_spec.rb +47 -0
- data/spec/models/add_document_request_spec.rb +56 -0
- data/spec/models/create_corporation_profile_request_spec.rb +10 -0
- data/spec/models/create_individual_profile_request_spec.rb +10 -0
- data/spec/models/create_joint_profile_request_spec.rb +10 -0
- data/spec/models/create_trust_profile_request_spec.rb +10 -0
- data/spec/models/patch_corporation_profile_request_spec.rb +10 -0
- data/spec/models/patch_individual_profile_request_spec.rb +10 -0
- data/spec/models/patch_joint_profile_request_spec.rb +10 -0
- data/spec/models/patch_trust_profile_request_spec.rb +10 -0
- data/spec/models/update_investor_request_spec.rb +6 -0
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +6 -0
- data/spec/models/v1_entities_investor_profile_individual_spec.rb +6 -0
- data/spec/models/v1_entities_investor_profile_joint_spec.rb +6 -0
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +6 -0
- data/spec/models/v1_entities_shareholder_spec.rb +46 -0
- data/spec/models/v1_entities_shareholders_spec.rb +34 -0
- metadata +61 -45
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2a35a795c000a0d7d4bee587a36986ae5fcfa770194672c88f26be69b57a6c79
|
4
|
+
data.tar.gz: 232661a895da19483f3227eec88eac5227ba53840dd41f8ae816017503ed8122
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c45eb73ad103535adde033133280f94f79193170078a9d50f43abb56e1d241eaf85b11a5cb1bae4d548ce54cf0f26c5afb57ae445257b344f52c7d37b1ef8d97
|
7
|
+
data.tar.gz: eb35a3f9cb4f2174352e697a2a7be75673fd0bc4ec9cf20cc80225d70bd897c9106938d7d7d5aa35e1dc8af58702b0daca9fb61745d1ae651c0be600aaf249b4
|
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.0.0
|
341
|
-
- Package version: 0.
|
341
|
+
- Package version: 0.80.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.
|
357
|
+
gem install ./DealMakerAPI-0.80.1.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.80.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.
|
366
|
+
gem 'DealMakerAPI', '~> 0.80.1'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -412,6 +412,7 @@ Class | Method | HTTP request | Description
|
|
412
412
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
413
413
|
*DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
|
414
414
|
*DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
|
415
|
+
*DealMakerAPI::DealApi* | [**get_analytics_dashboard_info**](docs/DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info
|
415
416
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
416
417
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
417
418
|
*DealMakerAPI::DealSetupApi* | [**create_deal_setup**](docs/DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
|
@@ -421,7 +422,9 @@ Class | Method | HTTP request | Description
|
|
421
422
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_security_token**](docs/DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription
|
422
423
|
*DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
|
423
424
|
*DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
|
425
|
+
*DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
|
424
426
|
*DealMakerAPI::InvestorApi* | [**create_investor**](docs/InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor
|
427
|
+
*DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
|
425
428
|
*DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
|
426
429
|
*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
|
427
430
|
*DealMakerAPI::InvestorApi* | [**list_investors**](docs/InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors
|
@@ -438,10 +441,12 @@ Class | Method | HTTP request | Description
|
|
438
441
|
*DealMakerAPI::InvestorProfileApi* | [**patch_individual_profile**](docs/InvestorProfileApi.md#patch_individual_profile) | **PATCH** /investor_profiles/individuals/{investor_profile_id} | Patch an individual investor profile.
|
439
442
|
*DealMakerAPI::InvestorProfileApi* | [**patch_joint_profile**](docs/InvestorProfileApi.md#patch_joint_profile) | **PATCH** /investor_profiles/joints/{investor_profile_id} | Patch a joint investor profile
|
440
443
|
*DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
|
444
|
+
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
441
445
|
|
442
446
|
|
443
447
|
## Documentation for Models
|
444
448
|
|
449
|
+
- [DealMakerAPI::AddDocumentRequest](docs/AddDocumentRequest.md)
|
445
450
|
- [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
446
451
|
- [DealMakerAPI::CreateCorporationProfileRequest](docs/CreateCorporationProfileRequest.md)
|
447
452
|
- [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
|
@@ -488,6 +493,8 @@ Class | Method | HTTP request | Description
|
|
488
493
|
- [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
|
489
494
|
- [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
|
490
495
|
- [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
|
496
|
+
- [DealMakerAPI::V1EntitiesShareholder](docs/V1EntitiesShareholder.md)
|
497
|
+
- [DealMakerAPI::V1EntitiesShareholders](docs/V1EntitiesShareholders.md)
|
491
498
|
- [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
|
492
499
|
- [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
|
493
500
|
- [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DealMakerAPI::AddDocumentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | Document type. | [default to 'regular'] |
|
8
|
+
| **file** | **File** | File to upload. | |
|
9
|
+
| **caption** | **String** | The caption. | [optional] |
|
10
|
+
| **search_entity_id** | **Integer** | Search entity id. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'DealMakerAPI'
|
16
|
+
|
17
|
+
instance = DealMakerAPI::AddDocumentRequest.new(
|
18
|
+
type: null,
|
19
|
+
file: null,
|
20
|
+
caption: null,
|
21
|
+
search_entity_id: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | User email which is associated with investor profile (required). | |
|
8
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
9
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **name** | **String** | The name of the corporation (required). | [optional] |
|
10
11
|
| **country** | **String** | The country of the corporation (required). | [optional] |
|
11
12
|
| **street_address** | **String** | The street address of the corporation (required). | [optional] |
|
@@ -49,6 +50,7 @@ require 'DealMakerAPI'
|
|
49
50
|
instance = DealMakerAPI::CreateCorporationProfileRequest.new(
|
50
51
|
email: null,
|
51
52
|
us_accredited_category: null,
|
53
|
+
ca_accredited_investor: null,
|
52
54
|
name: null,
|
53
55
|
country: null,
|
54
56
|
street_address: null,
|
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | User email which is associated with individual investor profile. | |
|
8
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
9
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **first_name** | **String** | The first name of the individual investor profile (required). | [optional] |
|
10
11
|
| **last_name** | **String** | The last name of the individual investor profile (required) | [optional] |
|
11
12
|
| **suffix** | **String** | The suffix of the individual investor profile | [optional] |
|
@@ -30,6 +31,7 @@ require 'DealMakerAPI'
|
|
30
31
|
instance = DealMakerAPI::CreateIndividualProfileRequest.new(
|
31
32
|
email: null,
|
32
33
|
us_accredited_category: null,
|
34
|
+
ca_accredited_investor: null,
|
33
35
|
first_name: null,
|
34
36
|
last_name: null,
|
35
37
|
suffix: null,
|
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | User email which is associated with investor profile. | |
|
8
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
9
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **joint_type** | **String** | The types of joint investor. | [optional] |
|
10
11
|
| **first_name** | **String** | The first name of the primary holder (required). | [optional] |
|
11
12
|
| **last_name** | **String** | The last name of the primary holder (required). | [optional] |
|
@@ -42,6 +43,7 @@ require 'DealMakerAPI'
|
|
42
43
|
instance = DealMakerAPI::CreateJointProfileRequest.new(
|
43
44
|
email: null,
|
44
45
|
us_accredited_category: null,
|
46
|
+
ca_accredited_investor: null,
|
45
47
|
joint_type: null,
|
46
48
|
first_name: null,
|
47
49
|
last_name: null,
|
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | User email which is associated with investor profile (required). | |
|
8
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
9
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **name** | **String** | The name of the trust (required). | [optional] |
|
10
11
|
| **date** | **String** | The creation date of the trust (required). | [optional] |
|
11
12
|
| **country** | **String** | The country of the trust (required). | [optional] |
|
@@ -38,6 +39,7 @@ require 'DealMakerAPI'
|
|
38
39
|
instance = DealMakerAPI::CreateTrustProfileRequest.new(
|
39
40
|
email: null,
|
40
41
|
us_accredited_category: null,
|
42
|
+
ca_accredited_investor: null,
|
41
43
|
name: null,
|
42
44
|
date: null,
|
43
45
|
country: null,
|
data/docs/DealApi.md
CHANGED
@@ -4,10 +4,81 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_analytics_dashboard_info**](DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info |
|
7
8
|
| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
|
8
9
|
| [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
|
9
10
|
|
10
11
|
|
12
|
+
## get_analytics_dashboard_info
|
13
|
+
|
14
|
+
> Object get_analytics_dashboard_info(id, opts)
|
15
|
+
|
16
|
+
Get Analytics Dashboard Info
|
17
|
+
|
18
|
+
Get Analytics Dashboard Info
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'DealMakerAPI'
|
25
|
+
# setup authorization
|
26
|
+
DealMakerAPI.configure do |config|end
|
27
|
+
|
28
|
+
api_instance = DealMakerAPI::DealApi.new
|
29
|
+
id = 56 # Integer | The deal id.
|
30
|
+
opts = {
|
31
|
+
dashboard_key: 'dashboard_key_example' # String | The dashboard key.
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
# Get Analytics Dashboard Info
|
36
|
+
result = api_instance.get_analytics_dashboard_info(id, opts)
|
37
|
+
p result
|
38
|
+
rescue DealMakerAPI::ApiError => e
|
39
|
+
puts "Error when calling DealApi->get_analytics_dashboard_info: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the get_analytics_dashboard_info_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(Object, Integer, Hash)> get_analytics_dashboard_info_with_http_info(id, opts)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
# Get Analytics Dashboard Info
|
52
|
+
data, status_code, headers = api_instance.get_analytics_dashboard_info_with_http_info(id, opts)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => Object
|
56
|
+
rescue DealMakerAPI::ApiError => e
|
57
|
+
puts "Error when calling DealApi->get_analytics_dashboard_info_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **id** | **Integer** | The deal id. | |
|
66
|
+
| **dashboard_key** | **String** | The dashboard key. | [optional] |
|
67
|
+
|
68
|
+
### Return type
|
69
|
+
|
70
|
+
**Object**
|
71
|
+
|
72
|
+
### Authorization
|
73
|
+
|
74
|
+
No authorization required
|
75
|
+
|
76
|
+
### HTTP request headers
|
77
|
+
|
78
|
+
- **Content-Type**: Not defined
|
79
|
+
- **Accept**: application/json
|
80
|
+
|
81
|
+
|
11
82
|
## get_deal
|
12
83
|
|
13
84
|
> <V1EntitiesDeal> get_deal(id)
|
data/docs/InvestorApi.md
CHANGED
@@ -4,7 +4,9 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_document**](InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor |
|
7
8
|
| [**create_investor**](InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
|
9
|
+
| [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
|
8
10
|
| [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
|
9
11
|
| [**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 |
|
10
12
|
| [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
|
@@ -12,6 +14,76 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
12
14
|
| [**update_investor**](InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor |
|
13
15
|
|
14
16
|
|
17
|
+
## add_document
|
18
|
+
|
19
|
+
> <V1EntitiesInvestor> add_document(id, investor_id, add_document_request)
|
20
|
+
|
21
|
+
Add document for deal investor
|
22
|
+
|
23
|
+
Add document for deal investor
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'DealMakerAPI'
|
30
|
+
# setup authorization
|
31
|
+
DealMakerAPI.configure do |config|end
|
32
|
+
|
33
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
34
|
+
id = 56 # Integer | The deal id.
|
35
|
+
investor_id = 56 # Integer | The investor id.
|
36
|
+
add_document_request = DealMakerAPI::AddDocumentRequest.new({type: 'regular', file: File.new('/path/to/some/file')}) # AddDocumentRequest |
|
37
|
+
|
38
|
+
begin
|
39
|
+
# Add document for deal investor
|
40
|
+
result = api_instance.add_document(id, investor_id, add_document_request)
|
41
|
+
p result
|
42
|
+
rescue DealMakerAPI::ApiError => e
|
43
|
+
puts "Error when calling InvestorApi->add_document: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the add_document_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<V1EntitiesInvestor>, Integer, Hash)> add_document_with_http_info(id, investor_id, add_document_request)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Add document for deal investor
|
56
|
+
data, status_code, headers = api_instance.add_document_with_http_info(id, investor_id, add_document_request)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <V1EntitiesInvestor>
|
60
|
+
rescue DealMakerAPI::ApiError => e
|
61
|
+
puts "Error when calling InvestorApi->add_document_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **id** | **Integer** | The deal id. | |
|
70
|
+
| **investor_id** | **Integer** | The investor id. | |
|
71
|
+
| **add_document_request** | [**AddDocumentRequest**](AddDocumentRequest.md) | | |
|
72
|
+
|
73
|
+
### Return type
|
74
|
+
|
75
|
+
[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
|
76
|
+
|
77
|
+
### Authorization
|
78
|
+
|
79
|
+
No authorization required
|
80
|
+
|
81
|
+
### HTTP request headers
|
82
|
+
|
83
|
+
- **Content-Type**: application/json
|
84
|
+
- **Accept**: application/json
|
85
|
+
|
86
|
+
|
15
87
|
## create_investor
|
16
88
|
|
17
89
|
> <V1EntitiesInvestor> create_investor(id, create_investor_request)
|
@@ -80,6 +152,75 @@ No authorization required
|
|
80
152
|
- **Accept**: application/json
|
81
153
|
|
82
154
|
|
155
|
+
## delete_document
|
156
|
+
|
157
|
+
> delete_document(id, investor_id, document_id)
|
158
|
+
|
159
|
+
Delete document for deal investor
|
160
|
+
|
161
|
+
Delete document for deal investor
|
162
|
+
|
163
|
+
### Examples
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
require 'time'
|
167
|
+
require 'DealMakerAPI'
|
168
|
+
# setup authorization
|
169
|
+
DealMakerAPI.configure do |config|end
|
170
|
+
|
171
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
172
|
+
id = 56 # Integer |
|
173
|
+
investor_id = 56 # Integer |
|
174
|
+
document_id = 56 # Integer |
|
175
|
+
|
176
|
+
begin
|
177
|
+
# Delete document for deal investor
|
178
|
+
api_instance.delete_document(id, investor_id, document_id)
|
179
|
+
rescue DealMakerAPI::ApiError => e
|
180
|
+
puts "Error when calling InvestorApi->delete_document: #{e}"
|
181
|
+
end
|
182
|
+
```
|
183
|
+
|
184
|
+
#### Using the delete_document_with_http_info variant
|
185
|
+
|
186
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
187
|
+
|
188
|
+
> <Array(nil, Integer, Hash)> delete_document_with_http_info(id, investor_id, document_id)
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
begin
|
192
|
+
# Delete document for deal investor
|
193
|
+
data, status_code, headers = api_instance.delete_document_with_http_info(id, investor_id, document_id)
|
194
|
+
p status_code # => 2xx
|
195
|
+
p headers # => { ... }
|
196
|
+
p data # => nil
|
197
|
+
rescue DealMakerAPI::ApiError => e
|
198
|
+
puts "Error when calling InvestorApi->delete_document_with_http_info: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Parameters
|
203
|
+
|
204
|
+
| Name | Type | Description | Notes |
|
205
|
+
| ---- | ---- | ----------- | ----- |
|
206
|
+
| **id** | **Integer** | | |
|
207
|
+
| **investor_id** | **Integer** | | |
|
208
|
+
| **document_id** | **Integer** | | |
|
209
|
+
|
210
|
+
### Return type
|
211
|
+
|
212
|
+
nil (empty response body)
|
213
|
+
|
214
|
+
### Authorization
|
215
|
+
|
216
|
+
No authorization required
|
217
|
+
|
218
|
+
### HTTP request headers
|
219
|
+
|
220
|
+
- **Content-Type**: Not defined
|
221
|
+
- **Accept**: Not defined
|
222
|
+
|
223
|
+
|
83
224
|
## get_investor
|
84
225
|
|
85
226
|
> <V1EntitiesInvestor> get_investor(id, investor_id)
|
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
7
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
8
9
|
| **name** | **String** | Corporation name. | [optional] |
|
9
10
|
| **country** | **String** | Corporation country. | [optional] |
|
10
11
|
| **street_address** | **String** | Corporation street address. | [optional] |
|
@@ -36,6 +37,7 @@ require 'DealMakerAPI'
|
|
36
37
|
|
37
38
|
instance = DealMakerAPI::PatchCorporationProfileRequest.new(
|
38
39
|
us_accredited_category: null,
|
40
|
+
ca_accredited_investor: null,
|
39
41
|
name: null,
|
40
42
|
country: null,
|
41
43
|
street_address: null,
|
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
7
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
8
9
|
| **first_name** | **String** | The first name of the individual investor profile. | [optional] |
|
9
10
|
| **last_name** | **String** | The last name of the individual investor profile. | [optional] |
|
10
11
|
| **suffix** | **String** | The suffix of the individual investor profile. | [optional] |
|
@@ -28,6 +29,7 @@ require 'DealMakerAPI'
|
|
28
29
|
|
29
30
|
instance = DealMakerAPI::PatchIndividualProfileRequest.new(
|
30
31
|
us_accredited_category: null,
|
32
|
+
ca_accredited_investor: null,
|
31
33
|
first_name: null,
|
32
34
|
last_name: null,
|
33
35
|
suffix: null,
|
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
7
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
8
9
|
| **joint_type** | **String** | The kind of joint investor. | [optional] |
|
9
10
|
| **first_name** | **String** | The first name of the investor profile. | [optional] |
|
10
11
|
| **last_name** | **String** | The last name of the investor profile. | [optional] |
|
@@ -40,6 +41,7 @@ require 'DealMakerAPI'
|
|
40
41
|
|
41
42
|
instance = DealMakerAPI::PatchJointProfileRequest.new(
|
42
43
|
us_accredited_category: null,
|
44
|
+
ca_accredited_investor: null,
|
43
45
|
joint_type: null,
|
44
46
|
first_name: null,
|
45
47
|
last_name: null,
|
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
7
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
8
9
|
| **name** | **String** | The name of the trust. | [optional] |
|
9
10
|
| **date** | **String** | The creation date of the trust. | [optional] |
|
10
11
|
| **phone_number** | **String** | The phone number of the trust. | [optional] |
|
@@ -36,6 +37,7 @@ require 'DealMakerAPI'
|
|
36
37
|
|
37
38
|
instance = DealMakerAPI::PatchTrustProfileRequest.new(
|
38
39
|
us_accredited_category: null,
|
40
|
+
ca_accredited_investor: null,
|
39
41
|
name: null,
|
40
42
|
date: null,
|
41
43
|
phone_number: null,
|
@@ -0,0 +1,74 @@
|
|
1
|
+
# DealMakerAPI::ShareholderApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_shareholders**](ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list |
|
8
|
+
|
9
|
+
|
10
|
+
## get_shareholders
|
11
|
+
|
12
|
+
> <V1EntitiesShareholders> get_shareholders(id)
|
13
|
+
|
14
|
+
Get a company shareholders list
|
15
|
+
|
16
|
+
Gets a list of company shareholders.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'DealMakerAPI'
|
23
|
+
# setup authorization
|
24
|
+
DealMakerAPI.configure do |config|end
|
25
|
+
|
26
|
+
api_instance = DealMakerAPI::ShareholderApi.new
|
27
|
+
id = 56 # Integer | The company id.
|
28
|
+
|
29
|
+
begin
|
30
|
+
# Get a company shareholders list
|
31
|
+
result = api_instance.get_shareholders(id)
|
32
|
+
p result
|
33
|
+
rescue DealMakerAPI::ApiError => e
|
34
|
+
puts "Error when calling ShareholderApi->get_shareholders: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the get_shareholders_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(<V1EntitiesShareholders>, Integer, Hash)> get_shareholders_with_http_info(id)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
# Get a company shareholders list
|
47
|
+
data, status_code, headers = api_instance.get_shareholders_with_http_info(id)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => <V1EntitiesShareholders>
|
51
|
+
rescue DealMakerAPI::ApiError => e
|
52
|
+
puts "Error when calling ShareholderApi->get_shareholders_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **id** | **Integer** | The company id. | |
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
[**V1EntitiesShareholders**](V1EntitiesShareholders.md)
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
No authorization required
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: Not defined
|
73
|
+
- **Accept**: application/json
|
74
|
+
|
@@ -8,6 +8,7 @@
|
|
8
8
|
| **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
|
9
9
|
| **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
|
10
10
|
| **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
|
11
|
+
| **investment_value** | **Float** | The investment value of the investor. | [optional] |
|
11
12
|
|
12
13
|
## Example
|
13
14
|
|
@@ -18,7 +19,8 @@ instance = DealMakerAPI::UpdateInvestorRequest.new(
|
|
18
19
|
warrant_expiry_date: null,
|
19
20
|
warrant_certificate_number: null,
|
20
21
|
allocated_amount: null,
|
21
|
-
allocation_unit: null
|
22
|
+
allocation_unit: null,
|
23
|
+
investment_value: null
|
22
24
|
)
|
23
25
|
```
|
24
26
|
|
@@ -8,7 +8,8 @@
|
|
8
8
|
| **user_id** | **Integer** | User id | [optional] |
|
9
9
|
| **email** | **String** | User email | [optional] |
|
10
10
|
| **type** | **String** | Investor Profile type | [optional] |
|
11
|
-
| **us_accredited_category** | **String** | The accredited investor information | [optional] |
|
11
|
+
| **us_accredited_category** | **String** | The United States accredited investor information | [optional] |
|
12
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information | [optional] |
|
12
13
|
| **complete** | **Boolean** | To check if the profile is complete or not | [optional] |
|
13
14
|
| **owner_type** | **String** | Type of the investor profile owner | [optional] |
|
14
15
|
| **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) | | [optional] |
|
@@ -27,6 +28,7 @@ instance = DealMakerAPI::V1EntitiesInvestorProfileCorporation.new(
|
|
27
28
|
email: null,
|
28
29
|
type: null,
|
29
30
|
us_accredited_category: null,
|
31
|
+
ca_accredited_investor: null,
|
30
32
|
complete: null,
|
31
33
|
owner_type: null,
|
32
34
|
owner: null,
|
@@ -8,7 +8,8 @@
|
|
8
8
|
| **user_id** | **Integer** | User id | [optional] |
|
9
9
|
| **email** | **String** | User email | [optional] |
|
10
10
|
| **type** | **String** | Investor Profile type | [optional] |
|
11
|
-
| **us_accredited_category** | **String** | The accredited investor information | [optional] |
|
11
|
+
| **us_accredited_category** | **String** | The United States accredited investor information | [optional] |
|
12
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information | [optional] |
|
12
13
|
| **complete** | **Boolean** | To check if the profile is complete or not | [optional] |
|
13
14
|
| **owner_type** | **String** | Type of the investor profile owner | [optional] |
|
14
15
|
| **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) | | [optional] |
|
@@ -25,6 +26,7 @@ instance = DealMakerAPI::V1EntitiesInvestorProfileIndividual.new(
|
|
25
26
|
email: null,
|
26
27
|
type: null,
|
27
28
|
us_accredited_category: null,
|
29
|
+
ca_accredited_investor: null,
|
28
30
|
complete: null,
|
29
31
|
owner_type: null,
|
30
32
|
owner: null,
|
@@ -8,7 +8,8 @@
|
|
8
8
|
| **user_id** | **Integer** | User id | [optional] |
|
9
9
|
| **email** | **String** | User email | [optional] |
|
10
10
|
| **type** | **String** | Investor Profile type | [optional] |
|
11
|
-
| **us_accredited_category** | **String** | The accredited investor information | [optional] |
|
11
|
+
| **us_accredited_category** | **String** | The United States accredited investor information | [optional] |
|
12
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information | [optional] |
|
12
13
|
| **complete** | **Boolean** | To check if the profile is complete or not | [optional] |
|
13
14
|
| **owner_type** | **String** | Type of the investor profile owner | [optional] |
|
14
15
|
| **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) | | [optional] |
|
@@ -27,6 +28,7 @@ instance = DealMakerAPI::V1EntitiesInvestorProfileJoint.new(
|
|
27
28
|
email: null,
|
28
29
|
type: null,
|
29
30
|
us_accredited_category: null,
|
31
|
+
ca_accredited_investor: null,
|
30
32
|
complete: null,
|
31
33
|
owner_type: null,
|
32
34
|
owner: null,
|
@@ -8,7 +8,8 @@
|
|
8
8
|
| **user_id** | **Integer** | User id | [optional] |
|
9
9
|
| **email** | **String** | User email | [optional] |
|
10
10
|
| **type** | **String** | Investor Profile type | [optional] |
|
11
|
-
| **us_accredited_category** | **String** | The accredited investor information | [optional] |
|
11
|
+
| **us_accredited_category** | **String** | The United States accredited investor information | [optional] |
|
12
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information | [optional] |
|
12
13
|
| **complete** | **Boolean** | To check if the profile is complete or not | [optional] |
|
13
14
|
| **owner_type** | **String** | Type of the investor profile owner | [optional] |
|
14
15
|
| **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) | | [optional] |
|
@@ -26,6 +27,7 @@ instance = DealMakerAPI::V1EntitiesInvestorProfileTrust.new(
|
|
26
27
|
email: null,
|
27
28
|
type: null,
|
28
29
|
us_accredited_category: null,
|
30
|
+
ca_accredited_investor: null,
|
29
31
|
complete: null,
|
30
32
|
owner_type: null,
|
31
33
|
owner: null,
|