DealMakerAPI 0.0.3 → 0.68.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/DealMakerAPI.gemspec +3 -3
- data/README.md +75 -20
- data/docs/CompanyApi.md +214 -0
- data/docs/CreateCompanyRequest.md +32 -0
- data/docs/CreateCorporationProfileRequest.md +82 -0
- data/docs/CreateDealSetupRequest.md +30 -0
- data/docs/CreateIndividualProfileRequest.md +44 -0
- data/docs/CreateInvestorRequest.md +40 -0
- data/docs/CreateJointProfileRequest.md +68 -0
- data/docs/CreateTrustProfileRequest.md +60 -0
- data/docs/DealApi.md +5 -222
- data/docs/DealSetupApi.md +74 -0
- data/docs/DefaultApi.md +413 -0
- data/docs/InvestorApi.md +368 -0
- data/docs/InvestorProfileApi.md +573 -15
- data/docs/PatchCorporationProfileRequest.md +58 -0
- data/docs/PatchIndividualProfileRequest.md +42 -0
- data/docs/PatchInvestorRequest.md +18 -0
- data/docs/PatchJointProfileRequest.md +66 -0
- data/docs/PatchTrustProfileRequest.md +58 -0
- data/docs/PostWebhooksRequest.md +26 -0
- data/docs/PutWebhooksIdRequest.md +30 -0
- data/docs/UpdateInvestorRequest.md +24 -0
- data/docs/V1EntitiesAddress.md +28 -0
- data/docs/V1EntitiesAddresses.md +18 -0
- data/docs/V1EntitiesCompany.md +34 -0
- data/docs/V1EntitiesCompanyDeal.md +20 -0
- data/docs/V1EntitiesCompanyDeals.md +18 -0
- data/docs/V1EntitiesDealSetup.md +34 -0
- data/docs/V1EntitiesDealSetupUser.md +20 -0
- data/docs/V1EntitiesInvestor.md +10 -4
- data/docs/V1EntitiesInvestorProfileAddress.md +28 -0
- data/docs/V1EntitiesInvestorProfileCorporation.md +34 -0
- data/docs/V1EntitiesInvestorProfileFieldsAccountHolder.md +28 -0
- data/docs/V1EntitiesInvestorProfileFieldsCorporation.md +24 -0
- data/docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md +30 -0
- data/docs/V1EntitiesInvestorProfileFieldsTrust.md +24 -0
- data/docs/V1EntitiesInvestorProfileIndividual.md +6 -16
- data/docs/V1EntitiesInvestorProfileItem.md +18 -0
- data/docs/V1EntitiesInvestorProfileJoint.md +34 -0
- data/docs/V1EntitiesInvestorProfileTrust.md +32 -0
- data/docs/V1EntitiesInvestorProfiles.md +18 -0
- data/docs/V1EntitiesWebhooksDeal.md +22 -0
- data/docs/V1EntitiesWebhooksSecurityToken.md +18 -0
- data/docs/V1EntitiesWebhooksSubscription.md +28 -0
- data/docs/V1EntitiesWebhooksSubscriptionDeal.md +24 -0
- data/docs/V1EntitiesWebhooksSubscriptionDeals.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +219 -0
- data/lib/DealMakerAPI/api/deal_api.rb +9 -226
- data/lib/DealMakerAPI/api/deal_setup_api.rb +90 -0
- data/lib/DealMakerAPI/api/default_api.rb +403 -0
- data/lib/DealMakerAPI/api/investor_api.rb +399 -0
- data/lib/DealMakerAPI/api/investor_profile_api.rb +570 -16
- data/lib/DealMakerAPI/api_client.rb +5 -3
- data/lib/DealMakerAPI/api_error.rb +3 -2
- data/lib/DealMakerAPI/configuration.rb +4 -3
- data/lib/DealMakerAPI/models/create_company_request.rb +320 -0
- data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +601 -0
- data/lib/DealMakerAPI/models/create_deal_setup_request.rb +364 -0
- data/lib/DealMakerAPI/models/create_individual_profile_request.rb +389 -0
- data/lib/DealMakerAPI/models/create_investor_request.rb +386 -0
- data/lib/DealMakerAPI/models/create_joint_profile_request.rb +521 -0
- data/lib/DealMakerAPI/models/create_trust_profile_request.rb +491 -0
- data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +454 -0
- data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +374 -0
- data/lib/DealMakerAPI/models/patch_investor_request.rb +225 -0
- data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +506 -0
- data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +454 -0
- data/lib/DealMakerAPI/models/post_webhooks_request.rb +277 -0
- data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +286 -0
- data/lib/DealMakerAPI/models/update_investor_request.rb +286 -0
- data/lib/DealMakerAPI/models/v1_entities_address.rb +270 -0
- data/lib/DealMakerAPI/models/v1_entities_addresses.rb +219 -0
- data/lib/DealMakerAPI/models/v1_entities_attachment.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_company.rb +299 -0
- data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +230 -0
- data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +219 -0
- data/lib/DealMakerAPI/models/v1_entities_deal.rb +5 -4
- data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +300 -0
- data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +230 -0
- data/lib/DealMakerAPI/models/v1_entities_deals.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +50 -20
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +270 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +332 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +269 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +249 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +279 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +249 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +26 -76
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +219 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +333 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +323 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +220 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_investors.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +241 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +221 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +270 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +250 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +219 -0
- data/lib/DealMakerAPI/version.rb +3 -3
- data/lib/DealMakerAPI.rb +43 -2
- data/spec/api/company_api_spec.rb +73 -0
- data/spec/api/deal_api_spec.rb +4 -47
- data/spec/api/deal_setup_api_spec.rb +47 -0
- data/spec/api/default_api_spec.rb +108 -0
- data/spec/api/investor_api_spec.rb +106 -0
- data/spec/api/investor_profile_api_spec.rb +109 -7
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/create_company_request_spec.rb +76 -0
- data/spec/models/create_corporation_profile_request_spec.rb +230 -0
- data/spec/models/create_deal_setup_request_spec.rb +82 -0
- data/spec/models/create_individual_profile_request_spec.rb +116 -0
- data/spec/models/create_investor_request_spec.rb +108 -0
- data/spec/models/create_joint_profile_request_spec.rb +192 -0
- data/spec/models/create_trust_profile_request_spec.rb +164 -0
- data/spec/models/patch_corporation_profile_request_spec.rb +158 -0
- data/spec/models/patch_individual_profile_request_spec.rb +110 -0
- data/spec/models/patch_investor_request_spec.rb +34 -0
- data/spec/models/patch_joint_profile_request_spec.rb +186 -0
- data/spec/models/patch_trust_profile_request_spec.rb +158 -0
- data/spec/models/post_webhooks_request_spec.rb +58 -0
- data/spec/models/put_webhooks_id_request_spec.rb +70 -0
- data/spec/models/update_investor_request_spec.rb +56 -0
- data/spec/models/v1_entities_address_spec.rb +64 -0
- data/spec/models/v1_entities_addresses_spec.rb +34 -0
- data/spec/models/v1_entities_attachment_spec.rb +2 -2
- data/spec/models/v1_entities_background_check_search_spec.rb +2 -2
- data/spec/models/v1_entities_company_deal_spec.rb +40 -0
- data/spec/models/v1_entities_company_deals_spec.rb +34 -0
- data/spec/models/v1_entities_company_spec.rb +82 -0
- data/spec/models/v1_entities_deal_enterprise_spec.rb +2 -2
- data/spec/models/v1_entities_deal_funding_metrics_spec.rb +2 -2
- data/spec/models/v1_entities_deal_investor_metrics_spec.rb +2 -2
- data/spec/models/v1_entities_deal_issuer_spec.rb +2 -2
- data/spec/models/v1_entities_deal_setup_spec.rb +82 -0
- data/spec/models/v1_entities_deal_setup_user_spec.rb +40 -0
- data/spec/models/v1_entities_deal_spec.rb +3 -3
- data/spec/models/v1_entities_deals_spec.rb +2 -2
- data/spec/models/v1_entities_investor_profile_address_spec.rb +64 -0
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +86 -0
- data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +64 -0
- data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +52 -0
- data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +70 -0
- data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +52 -0
- data/spec/models/v1_entities_investor_profile_individual_spec.rb +6 -36
- data/spec/models/v1_entities_investor_profile_item_spec.rb +34 -0
- data/spec/models/v1_entities_investor_profile_joint_spec.rb +86 -0
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +80 -0
- data/spec/models/v1_entities_investor_profiles_spec.rb +34 -0
- data/spec/models/v1_entities_investor_spec.rb +22 -4
- data/spec/models/v1_entities_investor_user_spec.rb +2 -2
- data/spec/models/v1_entities_investors_spec.rb +2 -2
- data/spec/models/v1_entities_subscription_agreement_spec.rb +2 -2
- data/spec/models/v1_entities_webhooks_deal_spec.rb +46 -0
- data/spec/models/v1_entities_webhooks_security_token_spec.rb +34 -0
- data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +52 -0
- data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +34 -0
- data/spec/models/v1_entities_webhooks_subscription_spec.rb +64 -0
- data/spec/spec_helper.rb +2 -2
- metadata +176 -12
data/docs/InvestorProfileApi.md
CHANGED
@@ -4,16 +4,24 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**create_corporation_profile**](InvestorProfileApi.md#create_corporation_profile) | **POST** /investor_profiles/corporations | Create new corporation investor profile. |
|
8
|
+
| [**create_individual_profile**](InvestorProfileApi.md#create_individual_profile) | **POST** /investor_profiles/individuals | Create new individual investor profile |
|
9
|
+
| [**create_joint_profile**](InvestorProfileApi.md#create_joint_profile) | **POST** /investor_profiles/joints | Create new joint investor profile |
|
10
|
+
| [**create_trust_profile**](InvestorProfileApi.md#create_trust_profile) | **POST** /investor_profiles/trusts | Create new trust investor profile. |
|
11
|
+
| [**get_investor_profiles**](InvestorProfileApi.md#get_investor_profiles) | **GET** /investor_profiles | Get list of InvestorProfiles |
|
12
|
+
| [**patch_corporation_profile**](InvestorProfileApi.md#patch_corporation_profile) | **PATCH** /investor_profiles/corporations/{investor_profile_id} | Patch a corporation investor profile |
|
13
|
+
| [**patch_individual_profile**](InvestorProfileApi.md#patch_individual_profile) | **PATCH** /investor_profiles/individuals/{investor_profile_id} | Patch an individual investor profile. |
|
14
|
+
| [**patch_joint_profile**](InvestorProfileApi.md#patch_joint_profile) | **PATCH** /investor_profiles/joints/{investor_profile_id} | Patch a joint investor profile |
|
15
|
+
| [**patch_trust_profile**](InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile |
|
8
16
|
|
9
17
|
|
10
|
-
##
|
18
|
+
## create_corporation_profile
|
11
19
|
|
12
|
-
> <
|
20
|
+
> <V1EntitiesInvestorProfileCorporation> create_corporation_profile(create_corporation_profile_request)
|
13
21
|
|
14
|
-
Create new investor profile
|
22
|
+
Create new corporation investor profile.
|
15
23
|
|
16
|
-
Create new investor profile associated to the user by email.
|
24
|
+
Create new corporation investor profile associated to the user by email.
|
17
25
|
|
18
26
|
### Examples
|
19
27
|
|
@@ -24,32 +32,98 @@ require 'DealMakerAPI'
|
|
24
32
|
DealMakerAPI.configure do |config|end
|
25
33
|
|
26
34
|
api_instance = DealMakerAPI::InvestorProfileApi.new
|
27
|
-
|
35
|
+
create_corporation_profile_request = DealMakerAPI::CreateCorporationProfileRequest.new({email: 'email_example'}) # CreateCorporationProfileRequest |
|
28
36
|
|
29
37
|
begin
|
30
|
-
# Create new investor profile
|
31
|
-
result = api_instance.
|
38
|
+
# Create new corporation investor profile.
|
39
|
+
result = api_instance.create_corporation_profile(create_corporation_profile_request)
|
32
40
|
p result
|
33
41
|
rescue DealMakerAPI::ApiError => e
|
34
|
-
puts "Error when calling InvestorProfileApi->
|
42
|
+
puts "Error when calling InvestorProfileApi->create_corporation_profile: #{e}"
|
35
43
|
end
|
36
44
|
```
|
37
45
|
|
38
|
-
#### Using the
|
46
|
+
#### Using the create_corporation_profile_with_http_info variant
|
39
47
|
|
40
48
|
This returns an Array which contains the response data, status code and headers.
|
41
49
|
|
42
|
-
> <Array(<
|
50
|
+
> <Array(<V1EntitiesInvestorProfileCorporation>, Integer, Hash)> create_corporation_profile_with_http_info(create_corporation_profile_request)
|
43
51
|
|
44
52
|
```ruby
|
45
53
|
begin
|
46
|
-
# Create new investor profile
|
47
|
-
data, status_code, headers = api_instance.
|
54
|
+
# Create new corporation investor profile.
|
55
|
+
data, status_code, headers = api_instance.create_corporation_profile_with_http_info(create_corporation_profile_request)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => <V1EntitiesInvestorProfileCorporation>
|
59
|
+
rescue DealMakerAPI::ApiError => e
|
60
|
+
puts "Error when calling InvestorProfileApi->create_corporation_profile_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **create_corporation_profile_request** | [**CreateCorporationProfileRequest**](CreateCorporationProfileRequest.md) | | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**V1EntitiesInvestorProfileCorporation**](V1EntitiesInvestorProfileCorporation.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
No authorization required
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: application/json
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## create_individual_profile
|
85
|
+
|
86
|
+
> <V1EntitiesInvestorProfileIndividual> create_individual_profile(create_individual_profile_request)
|
87
|
+
|
88
|
+
Create new individual investor profile
|
89
|
+
|
90
|
+
Create new individual investor profile associated to the user by email.
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'DealMakerAPI'
|
97
|
+
# setup authorization
|
98
|
+
DealMakerAPI.configure do |config|end
|
99
|
+
|
100
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
101
|
+
create_individual_profile_request = DealMakerAPI::CreateIndividualProfileRequest.new({email: 'email_example'}) # CreateIndividualProfileRequest |
|
102
|
+
|
103
|
+
begin
|
104
|
+
# Create new individual investor profile
|
105
|
+
result = api_instance.create_individual_profile(create_individual_profile_request)
|
106
|
+
p result
|
107
|
+
rescue DealMakerAPI::ApiError => e
|
108
|
+
puts "Error when calling InvestorProfileApi->create_individual_profile: #{e}"
|
109
|
+
end
|
110
|
+
```
|
111
|
+
|
112
|
+
#### Using the create_individual_profile_with_http_info variant
|
113
|
+
|
114
|
+
This returns an Array which contains the response data, status code and headers.
|
115
|
+
|
116
|
+
> <Array(<V1EntitiesInvestorProfileIndividual>, Integer, Hash)> create_individual_profile_with_http_info(create_individual_profile_request)
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
begin
|
120
|
+
# Create new individual investor profile
|
121
|
+
data, status_code, headers = api_instance.create_individual_profile_with_http_info(create_individual_profile_request)
|
48
122
|
p status_code # => 2xx
|
49
123
|
p headers # => { ... }
|
50
124
|
p data # => <V1EntitiesInvestorProfileIndividual>
|
51
125
|
rescue DealMakerAPI::ApiError => e
|
52
|
-
puts "Error when calling InvestorProfileApi->
|
126
|
+
puts "Error when calling InvestorProfileApi->create_individual_profile_with_http_info: #{e}"
|
53
127
|
end
|
54
128
|
```
|
55
129
|
|
@@ -57,7 +131,7 @@ end
|
|
57
131
|
|
58
132
|
| Name | Type | Description | Notes |
|
59
133
|
| ---- | ---- | ----------- | ----- |
|
60
|
-
| **
|
134
|
+
| **create_individual_profile_request** | [**CreateIndividualProfileRequest**](CreateIndividualProfileRequest.md) | | |
|
61
135
|
|
62
136
|
### Return type
|
63
137
|
|
@@ -72,3 +146,487 @@ No authorization required
|
|
72
146
|
- **Content-Type**: application/json
|
73
147
|
- **Accept**: application/json
|
74
148
|
|
149
|
+
|
150
|
+
## create_joint_profile
|
151
|
+
|
152
|
+
> <V1EntitiesInvestorProfileJoint> create_joint_profile(create_joint_profile_request)
|
153
|
+
|
154
|
+
Create new joint investor profile
|
155
|
+
|
156
|
+
Create new joint investor profile associated to the user by email.
|
157
|
+
|
158
|
+
### Examples
|
159
|
+
|
160
|
+
```ruby
|
161
|
+
require 'time'
|
162
|
+
require 'DealMakerAPI'
|
163
|
+
# setup authorization
|
164
|
+
DealMakerAPI.configure do |config|end
|
165
|
+
|
166
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
167
|
+
create_joint_profile_request = DealMakerAPI::CreateJointProfileRequest.new({email: 'email_example'}) # CreateJointProfileRequest |
|
168
|
+
|
169
|
+
begin
|
170
|
+
# Create new joint investor profile
|
171
|
+
result = api_instance.create_joint_profile(create_joint_profile_request)
|
172
|
+
p result
|
173
|
+
rescue DealMakerAPI::ApiError => e
|
174
|
+
puts "Error when calling InvestorProfileApi->create_joint_profile: #{e}"
|
175
|
+
end
|
176
|
+
```
|
177
|
+
|
178
|
+
#### Using the create_joint_profile_with_http_info variant
|
179
|
+
|
180
|
+
This returns an Array which contains the response data, status code and headers.
|
181
|
+
|
182
|
+
> <Array(<V1EntitiesInvestorProfileJoint>, Integer, Hash)> create_joint_profile_with_http_info(create_joint_profile_request)
|
183
|
+
|
184
|
+
```ruby
|
185
|
+
begin
|
186
|
+
# Create new joint investor profile
|
187
|
+
data, status_code, headers = api_instance.create_joint_profile_with_http_info(create_joint_profile_request)
|
188
|
+
p status_code # => 2xx
|
189
|
+
p headers # => { ... }
|
190
|
+
p data # => <V1EntitiesInvestorProfileJoint>
|
191
|
+
rescue DealMakerAPI::ApiError => e
|
192
|
+
puts "Error when calling InvestorProfileApi->create_joint_profile_with_http_info: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
| Name | Type | Description | Notes |
|
199
|
+
| ---- | ---- | ----------- | ----- |
|
200
|
+
| **create_joint_profile_request** | [**CreateJointProfileRequest**](CreateJointProfileRequest.md) | | |
|
201
|
+
|
202
|
+
### Return type
|
203
|
+
|
204
|
+
[**V1EntitiesInvestorProfileJoint**](V1EntitiesInvestorProfileJoint.md)
|
205
|
+
|
206
|
+
### Authorization
|
207
|
+
|
208
|
+
No authorization required
|
209
|
+
|
210
|
+
### HTTP request headers
|
211
|
+
|
212
|
+
- **Content-Type**: application/json
|
213
|
+
- **Accept**: application/json
|
214
|
+
|
215
|
+
|
216
|
+
## create_trust_profile
|
217
|
+
|
218
|
+
> <V1EntitiesInvestorProfileTrust> create_trust_profile(create_trust_profile_request)
|
219
|
+
|
220
|
+
Create new trust investor profile.
|
221
|
+
|
222
|
+
Create new trust investor profile associated to the user by email.
|
223
|
+
|
224
|
+
### Examples
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
require 'time'
|
228
|
+
require 'DealMakerAPI'
|
229
|
+
# setup authorization
|
230
|
+
DealMakerAPI.configure do |config|end
|
231
|
+
|
232
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
233
|
+
create_trust_profile_request = DealMakerAPI::CreateTrustProfileRequest.new({email: 'email_example'}) # CreateTrustProfileRequest |
|
234
|
+
|
235
|
+
begin
|
236
|
+
# Create new trust investor profile.
|
237
|
+
result = api_instance.create_trust_profile(create_trust_profile_request)
|
238
|
+
p result
|
239
|
+
rescue DealMakerAPI::ApiError => e
|
240
|
+
puts "Error when calling InvestorProfileApi->create_trust_profile: #{e}"
|
241
|
+
end
|
242
|
+
```
|
243
|
+
|
244
|
+
#### Using the create_trust_profile_with_http_info variant
|
245
|
+
|
246
|
+
This returns an Array which contains the response data, status code and headers.
|
247
|
+
|
248
|
+
> <Array(<V1EntitiesInvestorProfileTrust>, Integer, Hash)> create_trust_profile_with_http_info(create_trust_profile_request)
|
249
|
+
|
250
|
+
```ruby
|
251
|
+
begin
|
252
|
+
# Create new trust investor profile.
|
253
|
+
data, status_code, headers = api_instance.create_trust_profile_with_http_info(create_trust_profile_request)
|
254
|
+
p status_code # => 2xx
|
255
|
+
p headers # => { ... }
|
256
|
+
p data # => <V1EntitiesInvestorProfileTrust>
|
257
|
+
rescue DealMakerAPI::ApiError => e
|
258
|
+
puts "Error when calling InvestorProfileApi->create_trust_profile_with_http_info: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
### Parameters
|
263
|
+
|
264
|
+
| Name | Type | Description | Notes |
|
265
|
+
| ---- | ---- | ----------- | ----- |
|
266
|
+
| **create_trust_profile_request** | [**CreateTrustProfileRequest**](CreateTrustProfileRequest.md) | | |
|
267
|
+
|
268
|
+
### Return type
|
269
|
+
|
270
|
+
[**V1EntitiesInvestorProfileTrust**](V1EntitiesInvestorProfileTrust.md)
|
271
|
+
|
272
|
+
### Authorization
|
273
|
+
|
274
|
+
No authorization required
|
275
|
+
|
276
|
+
### HTTP request headers
|
277
|
+
|
278
|
+
- **Content-Type**: application/json
|
279
|
+
- **Accept**: application/json
|
280
|
+
|
281
|
+
|
282
|
+
## get_investor_profiles
|
283
|
+
|
284
|
+
> <V1EntitiesInvestorProfiles> get_investor_profiles(opts)
|
285
|
+
|
286
|
+
Get list of InvestorProfiles
|
287
|
+
|
288
|
+
Get investor profiles
|
289
|
+
|
290
|
+
### Examples
|
291
|
+
|
292
|
+
```ruby
|
293
|
+
require 'time'
|
294
|
+
require 'DealMakerAPI'
|
295
|
+
# setup authorization
|
296
|
+
DealMakerAPI.configure do |config|end
|
297
|
+
|
298
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
299
|
+
opts = {
|
300
|
+
page: 56, # Integer | Page offset to fetch.
|
301
|
+
per_page: 56, # Integer | Number of results to return per page.
|
302
|
+
offset: 56 # Integer | Pad a number of results.
|
303
|
+
}
|
304
|
+
|
305
|
+
begin
|
306
|
+
# Get list of InvestorProfiles
|
307
|
+
result = api_instance.get_investor_profiles(opts)
|
308
|
+
p result
|
309
|
+
rescue DealMakerAPI::ApiError => e
|
310
|
+
puts "Error when calling InvestorProfileApi->get_investor_profiles: #{e}"
|
311
|
+
end
|
312
|
+
```
|
313
|
+
|
314
|
+
#### Using the get_investor_profiles_with_http_info variant
|
315
|
+
|
316
|
+
This returns an Array which contains the response data, status code and headers.
|
317
|
+
|
318
|
+
> <Array(<V1EntitiesInvestorProfiles>, Integer, Hash)> get_investor_profiles_with_http_info(opts)
|
319
|
+
|
320
|
+
```ruby
|
321
|
+
begin
|
322
|
+
# Get list of InvestorProfiles
|
323
|
+
data, status_code, headers = api_instance.get_investor_profiles_with_http_info(opts)
|
324
|
+
p status_code # => 2xx
|
325
|
+
p headers # => { ... }
|
326
|
+
p data # => <V1EntitiesInvestorProfiles>
|
327
|
+
rescue DealMakerAPI::ApiError => e
|
328
|
+
puts "Error when calling InvestorProfileApi->get_investor_profiles_with_http_info: #{e}"
|
329
|
+
end
|
330
|
+
```
|
331
|
+
|
332
|
+
### Parameters
|
333
|
+
|
334
|
+
| Name | Type | Description | Notes |
|
335
|
+
| ---- | ---- | ----------- | ----- |
|
336
|
+
| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
|
337
|
+
| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
|
338
|
+
| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
|
339
|
+
|
340
|
+
### Return type
|
341
|
+
|
342
|
+
[**V1EntitiesInvestorProfiles**](V1EntitiesInvestorProfiles.md)
|
343
|
+
|
344
|
+
### Authorization
|
345
|
+
|
346
|
+
No authorization required
|
347
|
+
|
348
|
+
### HTTP request headers
|
349
|
+
|
350
|
+
- **Content-Type**: Not defined
|
351
|
+
- **Accept**: application/json
|
352
|
+
|
353
|
+
|
354
|
+
## patch_corporation_profile
|
355
|
+
|
356
|
+
> <V1EntitiesInvestorProfileCorporation> patch_corporation_profile(investor_profile_id, opts)
|
357
|
+
|
358
|
+
Patch a corporation investor profile
|
359
|
+
|
360
|
+
Patch corporation investor profile
|
361
|
+
|
362
|
+
### Examples
|
363
|
+
|
364
|
+
```ruby
|
365
|
+
require 'time'
|
366
|
+
require 'DealMakerAPI'
|
367
|
+
# setup authorization
|
368
|
+
DealMakerAPI.configure do |config|end
|
369
|
+
|
370
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
371
|
+
investor_profile_id = 56 # Integer |
|
372
|
+
opts = {
|
373
|
+
patch_corporation_profile_request: DealMakerAPI::PatchCorporationProfileRequest.new # PatchCorporationProfileRequest |
|
374
|
+
}
|
375
|
+
|
376
|
+
begin
|
377
|
+
# Patch a corporation investor profile
|
378
|
+
result = api_instance.patch_corporation_profile(investor_profile_id, opts)
|
379
|
+
p result
|
380
|
+
rescue DealMakerAPI::ApiError => e
|
381
|
+
puts "Error when calling InvestorProfileApi->patch_corporation_profile: #{e}"
|
382
|
+
end
|
383
|
+
```
|
384
|
+
|
385
|
+
#### Using the patch_corporation_profile_with_http_info variant
|
386
|
+
|
387
|
+
This returns an Array which contains the response data, status code and headers.
|
388
|
+
|
389
|
+
> <Array(<V1EntitiesInvestorProfileCorporation>, Integer, Hash)> patch_corporation_profile_with_http_info(investor_profile_id, opts)
|
390
|
+
|
391
|
+
```ruby
|
392
|
+
begin
|
393
|
+
# Patch a corporation investor profile
|
394
|
+
data, status_code, headers = api_instance.patch_corporation_profile_with_http_info(investor_profile_id, opts)
|
395
|
+
p status_code # => 2xx
|
396
|
+
p headers # => { ... }
|
397
|
+
p data # => <V1EntitiesInvestorProfileCorporation>
|
398
|
+
rescue DealMakerAPI::ApiError => e
|
399
|
+
puts "Error when calling InvestorProfileApi->patch_corporation_profile_with_http_info: #{e}"
|
400
|
+
end
|
401
|
+
```
|
402
|
+
|
403
|
+
### Parameters
|
404
|
+
|
405
|
+
| Name | Type | Description | Notes |
|
406
|
+
| ---- | ---- | ----------- | ----- |
|
407
|
+
| **investor_profile_id** | **Integer** | | |
|
408
|
+
| **patch_corporation_profile_request** | [**PatchCorporationProfileRequest**](PatchCorporationProfileRequest.md) | | [optional] |
|
409
|
+
|
410
|
+
### Return type
|
411
|
+
|
412
|
+
[**V1EntitiesInvestorProfileCorporation**](V1EntitiesInvestorProfileCorporation.md)
|
413
|
+
|
414
|
+
### Authorization
|
415
|
+
|
416
|
+
No authorization required
|
417
|
+
|
418
|
+
### HTTP request headers
|
419
|
+
|
420
|
+
- **Content-Type**: application/json
|
421
|
+
- **Accept**: application/json
|
422
|
+
|
423
|
+
|
424
|
+
## patch_individual_profile
|
425
|
+
|
426
|
+
> <V1EntitiesInvestorProfileIndividual> patch_individual_profile(investor_profile_id, opts)
|
427
|
+
|
428
|
+
Patch an individual investor profile.
|
429
|
+
|
430
|
+
Patch individual investor profile.
|
431
|
+
|
432
|
+
### Examples
|
433
|
+
|
434
|
+
```ruby
|
435
|
+
require 'time'
|
436
|
+
require 'DealMakerAPI'
|
437
|
+
# setup authorization
|
438
|
+
DealMakerAPI.configure do |config|end
|
439
|
+
|
440
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
441
|
+
investor_profile_id = 56 # Integer |
|
442
|
+
opts = {
|
443
|
+
patch_individual_profile_request: DealMakerAPI::PatchIndividualProfileRequest.new # PatchIndividualProfileRequest |
|
444
|
+
}
|
445
|
+
|
446
|
+
begin
|
447
|
+
# Patch an individual investor profile.
|
448
|
+
result = api_instance.patch_individual_profile(investor_profile_id, opts)
|
449
|
+
p result
|
450
|
+
rescue DealMakerAPI::ApiError => e
|
451
|
+
puts "Error when calling InvestorProfileApi->patch_individual_profile: #{e}"
|
452
|
+
end
|
453
|
+
```
|
454
|
+
|
455
|
+
#### Using the patch_individual_profile_with_http_info variant
|
456
|
+
|
457
|
+
This returns an Array which contains the response data, status code and headers.
|
458
|
+
|
459
|
+
> <Array(<V1EntitiesInvestorProfileIndividual>, Integer, Hash)> patch_individual_profile_with_http_info(investor_profile_id, opts)
|
460
|
+
|
461
|
+
```ruby
|
462
|
+
begin
|
463
|
+
# Patch an individual investor profile.
|
464
|
+
data, status_code, headers = api_instance.patch_individual_profile_with_http_info(investor_profile_id, opts)
|
465
|
+
p status_code # => 2xx
|
466
|
+
p headers # => { ... }
|
467
|
+
p data # => <V1EntitiesInvestorProfileIndividual>
|
468
|
+
rescue DealMakerAPI::ApiError => e
|
469
|
+
puts "Error when calling InvestorProfileApi->patch_individual_profile_with_http_info: #{e}"
|
470
|
+
end
|
471
|
+
```
|
472
|
+
|
473
|
+
### Parameters
|
474
|
+
|
475
|
+
| Name | Type | Description | Notes |
|
476
|
+
| ---- | ---- | ----------- | ----- |
|
477
|
+
| **investor_profile_id** | **Integer** | | |
|
478
|
+
| **patch_individual_profile_request** | [**PatchIndividualProfileRequest**](PatchIndividualProfileRequest.md) | | [optional] |
|
479
|
+
|
480
|
+
### Return type
|
481
|
+
|
482
|
+
[**V1EntitiesInvestorProfileIndividual**](V1EntitiesInvestorProfileIndividual.md)
|
483
|
+
|
484
|
+
### Authorization
|
485
|
+
|
486
|
+
No authorization required
|
487
|
+
|
488
|
+
### HTTP request headers
|
489
|
+
|
490
|
+
- **Content-Type**: application/json
|
491
|
+
- **Accept**: application/json
|
492
|
+
|
493
|
+
|
494
|
+
## patch_joint_profile
|
495
|
+
|
496
|
+
> <V1EntitiesInvestorProfileJoint> patch_joint_profile(investor_profile_id, opts)
|
497
|
+
|
498
|
+
Patch a joint investor profile
|
499
|
+
|
500
|
+
Patch joint investor profile
|
501
|
+
|
502
|
+
### Examples
|
503
|
+
|
504
|
+
```ruby
|
505
|
+
require 'time'
|
506
|
+
require 'DealMakerAPI'
|
507
|
+
# setup authorization
|
508
|
+
DealMakerAPI.configure do |config|end
|
509
|
+
|
510
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
511
|
+
investor_profile_id = 56 # Integer |
|
512
|
+
opts = {
|
513
|
+
patch_joint_profile_request: DealMakerAPI::PatchJointProfileRequest.new # PatchJointProfileRequest |
|
514
|
+
}
|
515
|
+
|
516
|
+
begin
|
517
|
+
# Patch a joint investor profile
|
518
|
+
result = api_instance.patch_joint_profile(investor_profile_id, opts)
|
519
|
+
p result
|
520
|
+
rescue DealMakerAPI::ApiError => e
|
521
|
+
puts "Error when calling InvestorProfileApi->patch_joint_profile: #{e}"
|
522
|
+
end
|
523
|
+
```
|
524
|
+
|
525
|
+
#### Using the patch_joint_profile_with_http_info variant
|
526
|
+
|
527
|
+
This returns an Array which contains the response data, status code and headers.
|
528
|
+
|
529
|
+
> <Array(<V1EntitiesInvestorProfileJoint>, Integer, Hash)> patch_joint_profile_with_http_info(investor_profile_id, opts)
|
530
|
+
|
531
|
+
```ruby
|
532
|
+
begin
|
533
|
+
# Patch a joint investor profile
|
534
|
+
data, status_code, headers = api_instance.patch_joint_profile_with_http_info(investor_profile_id, opts)
|
535
|
+
p status_code # => 2xx
|
536
|
+
p headers # => { ... }
|
537
|
+
p data # => <V1EntitiesInvestorProfileJoint>
|
538
|
+
rescue DealMakerAPI::ApiError => e
|
539
|
+
puts "Error when calling InvestorProfileApi->patch_joint_profile_with_http_info: #{e}"
|
540
|
+
end
|
541
|
+
```
|
542
|
+
|
543
|
+
### Parameters
|
544
|
+
|
545
|
+
| Name | Type | Description | Notes |
|
546
|
+
| ---- | ---- | ----------- | ----- |
|
547
|
+
| **investor_profile_id** | **Integer** | | |
|
548
|
+
| **patch_joint_profile_request** | [**PatchJointProfileRequest**](PatchJointProfileRequest.md) | | [optional] |
|
549
|
+
|
550
|
+
### Return type
|
551
|
+
|
552
|
+
[**V1EntitiesInvestorProfileJoint**](V1EntitiesInvestorProfileJoint.md)
|
553
|
+
|
554
|
+
### Authorization
|
555
|
+
|
556
|
+
No authorization required
|
557
|
+
|
558
|
+
### HTTP request headers
|
559
|
+
|
560
|
+
- **Content-Type**: application/json
|
561
|
+
- **Accept**: application/json
|
562
|
+
|
563
|
+
|
564
|
+
## patch_trust_profile
|
565
|
+
|
566
|
+
> <V1EntitiesInvestorProfileTrust> patch_trust_profile(investor_profile_id, opts)
|
567
|
+
|
568
|
+
Patch a trust investor profile
|
569
|
+
|
570
|
+
Patch trust investor profile
|
571
|
+
|
572
|
+
### Examples
|
573
|
+
|
574
|
+
```ruby
|
575
|
+
require 'time'
|
576
|
+
require 'DealMakerAPI'
|
577
|
+
# setup authorization
|
578
|
+
DealMakerAPI.configure do |config|end
|
579
|
+
|
580
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
581
|
+
investor_profile_id = 56 # Integer |
|
582
|
+
opts = {
|
583
|
+
patch_trust_profile_request: DealMakerAPI::PatchTrustProfileRequest.new # PatchTrustProfileRequest |
|
584
|
+
}
|
585
|
+
|
586
|
+
begin
|
587
|
+
# Patch a trust investor profile
|
588
|
+
result = api_instance.patch_trust_profile(investor_profile_id, opts)
|
589
|
+
p result
|
590
|
+
rescue DealMakerAPI::ApiError => e
|
591
|
+
puts "Error when calling InvestorProfileApi->patch_trust_profile: #{e}"
|
592
|
+
end
|
593
|
+
```
|
594
|
+
|
595
|
+
#### Using the patch_trust_profile_with_http_info variant
|
596
|
+
|
597
|
+
This returns an Array which contains the response data, status code and headers.
|
598
|
+
|
599
|
+
> <Array(<V1EntitiesInvestorProfileTrust>, Integer, Hash)> patch_trust_profile_with_http_info(investor_profile_id, opts)
|
600
|
+
|
601
|
+
```ruby
|
602
|
+
begin
|
603
|
+
# Patch a trust investor profile
|
604
|
+
data, status_code, headers = api_instance.patch_trust_profile_with_http_info(investor_profile_id, opts)
|
605
|
+
p status_code # => 2xx
|
606
|
+
p headers # => { ... }
|
607
|
+
p data # => <V1EntitiesInvestorProfileTrust>
|
608
|
+
rescue DealMakerAPI::ApiError => e
|
609
|
+
puts "Error when calling InvestorProfileApi->patch_trust_profile_with_http_info: #{e}"
|
610
|
+
end
|
611
|
+
```
|
612
|
+
|
613
|
+
### Parameters
|
614
|
+
|
615
|
+
| Name | Type | Description | Notes |
|
616
|
+
| ---- | ---- | ----------- | ----- |
|
617
|
+
| **investor_profile_id** | **Integer** | | |
|
618
|
+
| **patch_trust_profile_request** | [**PatchTrustProfileRequest**](PatchTrustProfileRequest.md) | | [optional] |
|
619
|
+
|
620
|
+
### Return type
|
621
|
+
|
622
|
+
[**V1EntitiesInvestorProfileTrust**](V1EntitiesInvestorProfileTrust.md)
|
623
|
+
|
624
|
+
### Authorization
|
625
|
+
|
626
|
+
No authorization required
|
627
|
+
|
628
|
+
### HTTP request headers
|
629
|
+
|
630
|
+
- **Content-Type**: application/json
|
631
|
+
- **Accept**: application/json
|
632
|
+
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# DealMakerAPI::PatchCorporationProfileRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **name** | **String** | Corporation name. | [optional] |
|
9
|
+
| **country** | **String** | Corporation country. | [optional] |
|
10
|
+
| **street_address** | **String** | Corporation street address. | [optional] |
|
11
|
+
| **unit2** | **String** | Corporation street address line 2. | [optional] |
|
12
|
+
| **city** | **String** | Corporation city. | [optional] |
|
13
|
+
| **region** | **String** | Corporation region or state. | [optional] |
|
14
|
+
| **postal_code** | **String** | Corporation postal code or zipcode. | [optional] |
|
15
|
+
| **business_number** | **String** | The business number of the investor profile. | [optional] |
|
16
|
+
| **phone_number** | **String** | The phone number of the investor profile. | [optional] |
|
17
|
+
| **signing_officer_first_name** | **String** | Signing officer first name. | [optional] |
|
18
|
+
| **signing_officer_last_name** | **String** | Signing officer last name. | [optional] |
|
19
|
+
| **signing_officer_suffix** | **String** | Signing officer suffix. | [optional] |
|
20
|
+
| **signing_officer_country** | **String** | Signing officer country. | [optional] |
|
21
|
+
| **signing_officer_street_address** | **String** | Signing officer street address. | [optional] |
|
22
|
+
| **signing_officer_unit2** | **String** | Signing officer street address line 2. | [optional] |
|
23
|
+
| **signing_officer_city** | **String** | Signing officer city. | [optional] |
|
24
|
+
| **signing_officer_region** | **String** | Signing officer region or state. | [optional] |
|
25
|
+
| **signing_officer_postal_code** | **String** | Signing officer postal code or zipcode. | [optional] |
|
26
|
+
| **signing_officer_date_of_birth** | **String** | Signing officer date of birth. | [optional] |
|
27
|
+
| **signing_officer_taxpayer_id** | **String** | The taxpayer identification number of the investor profile. | [optional] |
|
28
|
+
|
29
|
+
## Example
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'DealMakerAPI'
|
33
|
+
|
34
|
+
instance = DealMakerAPI::PatchCorporationProfileRequest.new(
|
35
|
+
us_accredited_category: null,
|
36
|
+
name: null,
|
37
|
+
country: null,
|
38
|
+
street_address: null,
|
39
|
+
unit2: null,
|
40
|
+
city: null,
|
41
|
+
region: null,
|
42
|
+
postal_code: null,
|
43
|
+
business_number: null,
|
44
|
+
phone_number: null,
|
45
|
+
signing_officer_first_name: null,
|
46
|
+
signing_officer_last_name: null,
|
47
|
+
signing_officer_suffix: null,
|
48
|
+
signing_officer_country: null,
|
49
|
+
signing_officer_street_address: null,
|
50
|
+
signing_officer_unit2: null,
|
51
|
+
signing_officer_city: null,
|
52
|
+
signing_officer_region: null,
|
53
|
+
signing_officer_postal_code: null,
|
54
|
+
signing_officer_date_of_birth: null,
|
55
|
+
signing_officer_taxpayer_id: null
|
56
|
+
)
|
57
|
+
```
|
58
|
+
|