DealMakerAPI 0.99.1 → 0.99.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 -5
- data/docs/CompanyApi.md +207 -2
- data/docs/CreateBulkUploadRequest.md +3 -1
- data/docs/CreateMembersBulkUploadRequest.md +26 -0
- data/docs/V1EntitiesInvestor.md +2 -0
- data/docs/V1EntitiesMembersBulkUpload.md +42 -0
- data/docs/V1EntitiesMembersBulkUploads.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +208 -2
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +17 -4
- data/lib/DealMakerAPI/models/create_members_bulk_upload_request.rb +266 -0
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +11 -1
- data/lib/DealMakerAPI/models/v1_entities_members_bulk_upload.rb +336 -0
- data/lib/DealMakerAPI/models/v1_entities_members_bulk_uploads.rb +215 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +3 -0
- data/spec/api/company_api_spec.rb +38 -0
- data/spec/models/create_bulk_upload_request_spec.rb +6 -0
- data/spec/models/create_members_bulk_upload_request_spec.rb +60 -0
- data/spec/models/v1_entities_investor_spec.rb +6 -0
- data/spec/models/v1_entities_members_bulk_upload_spec.rb +108 -0
- data/spec/models/v1_entities_members_bulk_uploads_spec.rb +36 -0
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 47aa37c17ad29161a49d3ce3662065a4b5d264c45677162f0141989074091f8b
|
4
|
+
data.tar.gz: 81b0869578558f7546abf41fe8050342229138ac31276ffa8f760b1daa460576
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f864a056ec993286553a22a6db0eba618ebc080c69e5672507e2337dae6617fa150b874644cde3d05640144f81edf567c1b0d3102c9aa16df92600e57028f922
|
7
|
+
data.tar.gz: 1fe543fbe4bafcfbf4d0cf8dfdf68458533817f3bfc74786fcbc18e0a3323148a648bb800220c520f97363fffbf2096de71db3dea9d7e4b5c95200e1ec5c5f60
|
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.99.
|
341
|
+
- Package version: 0.99.2
|
342
342
|
- Generator version: 7.5.0-SNAPSHOT
|
343
343
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
344
344
|
|
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
|
|
355
355
|
Then either install the gem locally:
|
356
356
|
|
357
357
|
```shell
|
358
|
-
gem install ./DealMakerAPI-0.99.
|
358
|
+
gem install ./DealMakerAPI-0.99.2.gem
|
359
359
|
```
|
360
360
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.99.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.99.2.gem` to install the development dependencies)
|
362
362
|
|
363
363
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
364
364
|
|
365
365
|
Finally add this to the Gemfile:
|
366
366
|
|
367
|
-
gem 'DealMakerAPI', '~> 0.99.
|
367
|
+
gem 'DealMakerAPI', '~> 0.99.2'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -393,7 +393,7 @@ DealMakerAPI.configure do |config|end
|
|
393
393
|
|
394
394
|
api_instance = DealMakerAPI::CompanyApi.new
|
395
395
|
id = 56 # Integer | The company id
|
396
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example', send_notification: false, notification_message: 'notification_message_example'}) # CreateBulkUploadRequest |
|
396
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example', send_notification: false, notification_message: 'notification_message_example', json_notification_message: 3.56}) # CreateBulkUploadRequest |
|
397
397
|
|
398
398
|
begin
|
399
399
|
#Create bulk upload record
|
@@ -415,6 +415,7 @@ Class | Method | HTTP request | Description
|
|
415
415
|
*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
|
416
416
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
417
417
|
*DealMakerAPI::CompanyApi* | [**create_email_template**](docs/CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_template | Creates an email template
|
418
|
+
*DealMakerAPI::CompanyApi* | [**create_members_bulk_upload**](docs/CompanyApi.md#create_members_bulk_upload) | **POST** /companies/{id}/members/bulk_uploads | Create bulk upload record
|
418
419
|
*DealMakerAPI::CompanyApi* | [**create_shareholder_action**](docs/CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action
|
419
420
|
*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
|
420
421
|
*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
|
@@ -426,6 +427,8 @@ Class | Method | HTTP request | Description
|
|
426
427
|
*DealMakerAPI::CompanyApi* | [**get_email_events**](docs/CompanyApi.md#get_email_events) | **GET** /companies/{company_communication_id}/email_events | Get a list of email events for a company communication
|
427
428
|
*DealMakerAPI::CompanyApi* | [**get_email_template**](docs/CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_template/{template_id} | Get a email template
|
428
429
|
*DealMakerAPI::CompanyApi* | [**get_email_templates**](docs/CompanyApi.md#get_email_templates) | **GET** /companies/{id}/news_releases/email_templates | Get list of email template
|
430
|
+
*DealMakerAPI::CompanyApi* | [**get_members_bulk_upload**](docs/CompanyApi.md#get_members_bulk_upload) | **GET** /companies/{id}/members/bulk_uploads/{id_members_bulk_upload} | Get bulk upload record
|
431
|
+
*DealMakerAPI::CompanyApi* | [**get_members_bulk_uploads**](docs/CompanyApi.md#get_members_bulk_uploads) | **GET** /companies/{id}/members/bulk_uploads | Get bulk uploads records
|
429
432
|
*DealMakerAPI::CompanyApi* | [**get_shareholder_ledger**](docs/CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company
|
430
433
|
*DealMakerAPI::CompanyApi* | [**get_user_accessible_companies**](docs/CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user
|
431
434
|
*DealMakerAPI::CompanyApi* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
|
@@ -500,6 +503,7 @@ Class | Method | HTTP request | Description
|
|
500
503
|
- [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
501
504
|
- [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
|
502
505
|
- [DealMakerAPI::CreateEmailTemplateRequest](docs/CreateEmailTemplateRequest.md)
|
506
|
+
- [DealMakerAPI::CreateMembersBulkUploadRequest](docs/CreateMembersBulkUploadRequest.md)
|
503
507
|
- [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
|
504
508
|
- [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
|
505
509
|
- [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
|
@@ -586,6 +590,8 @@ Class | Method | HTTP request | Description
|
|
586
590
|
- [DealMakerAPI::V1EntitiesInvestorSearchEntitiesRequiredFields](docs/V1EntitiesInvestorSearchEntitiesRequiredFields.md)
|
587
591
|
- [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
|
588
592
|
- [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
|
593
|
+
- [DealMakerAPI::V1EntitiesMembersBulkUpload](docs/V1EntitiesMembersBulkUpload.md)
|
594
|
+
- [DealMakerAPI::V1EntitiesMembersBulkUploads](docs/V1EntitiesMembersBulkUploads.md)
|
589
595
|
- [DealMakerAPI::V1EntitiesMoneyEntity](docs/V1EntitiesMoneyEntity.md)
|
590
596
|
- [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
|
591
597
|
- [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md)
|
data/docs/CompanyApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
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
10
|
| [**create_email_template**](CompanyApi.md#create_email_template) | **POST** /companies/{id}/news_releases/email_template | Creates an email template |
|
11
|
+
| [**create_members_bulk_upload**](CompanyApi.md#create_members_bulk_upload) | **POST** /companies/{id}/members/bulk_uploads | Create bulk upload record |
|
11
12
|
| [**create_shareholder_action**](CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action |
|
12
13
|
| [**get_bulk_upload**](CompanyApi.md#get_bulk_upload) | **GET** /companies/{id}/documents/bulk_uploads/{bulk_upload_id} | Return a given bulk upload by id |
|
13
14
|
| [**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 |
|
@@ -19,6 +20,8 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
19
20
|
| [**get_email_events**](CompanyApi.md#get_email_events) | **GET** /companies/{company_communication_id}/email_events | Get a list of email events for a company communication |
|
20
21
|
| [**get_email_template**](CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_template/{template_id} | Get a email template |
|
21
22
|
| [**get_email_templates**](CompanyApi.md#get_email_templates) | **GET** /companies/{id}/news_releases/email_templates | Get list of email template |
|
23
|
+
| [**get_members_bulk_upload**](CompanyApi.md#get_members_bulk_upload) | **GET** /companies/{id}/members/bulk_uploads/{id_members_bulk_upload} | Get bulk upload record |
|
24
|
+
| [**get_members_bulk_uploads**](CompanyApi.md#get_members_bulk_uploads) | **GET** /companies/{id}/members/bulk_uploads | Get bulk uploads records |
|
22
25
|
| [**get_shareholder_ledger**](CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company |
|
23
26
|
| [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
|
24
27
|
| [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
|
@@ -42,7 +45,7 @@ DealMakerAPI.configure do |config|end
|
|
42
45
|
|
43
46
|
api_instance = DealMakerAPI::CompanyApi.new
|
44
47
|
id = 56 # Integer | The company id
|
45
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example', send_notification: false, notification_message: 'notification_message_example'}) # CreateBulkUploadRequest |
|
48
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example', send_notification: false, notification_message: 'notification_message_example', json_notification_message: 3.56}) # CreateBulkUploadRequest |
|
46
49
|
|
47
50
|
begin
|
48
51
|
# Create bulk upload record
|
@@ -296,6 +299,74 @@ No authorization required
|
|
296
299
|
- **Accept**: application/json
|
297
300
|
|
298
301
|
|
302
|
+
## create_members_bulk_upload
|
303
|
+
|
304
|
+
> <V1EntitiesMembersBulkUpload> create_members_bulk_upload(id, create_members_bulk_upload_request)
|
305
|
+
|
306
|
+
Create bulk upload record
|
307
|
+
|
308
|
+
Create members bulk upload record
|
309
|
+
|
310
|
+
### Examples
|
311
|
+
|
312
|
+
```ruby
|
313
|
+
require 'time'
|
314
|
+
require 'DealMakerAPI'
|
315
|
+
# setup authorization
|
316
|
+
DealMakerAPI.configure do |config|end
|
317
|
+
|
318
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
319
|
+
id = 56 # Integer | The company id
|
320
|
+
create_members_bulk_upload_request = DealMakerAPI::CreateMembersBulkUploadRequest.new({csv_file: File.new('/path/to/some/file')}) # CreateMembersBulkUploadRequest |
|
321
|
+
|
322
|
+
begin
|
323
|
+
# Create bulk upload record
|
324
|
+
result = api_instance.create_members_bulk_upload(id, create_members_bulk_upload_request)
|
325
|
+
p result
|
326
|
+
rescue DealMakerAPI::ApiError => e
|
327
|
+
puts "Error when calling CompanyApi->create_members_bulk_upload: #{e}"
|
328
|
+
end
|
329
|
+
```
|
330
|
+
|
331
|
+
#### Using the create_members_bulk_upload_with_http_info variant
|
332
|
+
|
333
|
+
This returns an Array which contains the response data, status code and headers.
|
334
|
+
|
335
|
+
> <Array(<V1EntitiesMembersBulkUpload>, Integer, Hash)> create_members_bulk_upload_with_http_info(id, create_members_bulk_upload_request)
|
336
|
+
|
337
|
+
```ruby
|
338
|
+
begin
|
339
|
+
# Create bulk upload record
|
340
|
+
data, status_code, headers = api_instance.create_members_bulk_upload_with_http_info(id, create_members_bulk_upload_request)
|
341
|
+
p status_code # => 2xx
|
342
|
+
p headers # => { ... }
|
343
|
+
p data # => <V1EntitiesMembersBulkUpload>
|
344
|
+
rescue DealMakerAPI::ApiError => e
|
345
|
+
puts "Error when calling CompanyApi->create_members_bulk_upload_with_http_info: #{e}"
|
346
|
+
end
|
347
|
+
```
|
348
|
+
|
349
|
+
### Parameters
|
350
|
+
|
351
|
+
| Name | Type | Description | Notes |
|
352
|
+
| ---- | ---- | ----------- | ----- |
|
353
|
+
| **id** | **Integer** | The company id | |
|
354
|
+
| **create_members_bulk_upload_request** | [**CreateMembersBulkUploadRequest**](CreateMembersBulkUploadRequest.md) | | |
|
355
|
+
|
356
|
+
### Return type
|
357
|
+
|
358
|
+
[**V1EntitiesMembersBulkUpload**](V1EntitiesMembersBulkUpload.md)
|
359
|
+
|
360
|
+
### Authorization
|
361
|
+
|
362
|
+
No authorization required
|
363
|
+
|
364
|
+
### HTTP request headers
|
365
|
+
|
366
|
+
- **Content-Type**: application/json
|
367
|
+
- **Accept**: application/json
|
368
|
+
|
369
|
+
|
299
370
|
## create_shareholder_action
|
300
371
|
|
301
372
|
> <V1EntitiesGenericResponse> create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request)
|
@@ -1046,7 +1117,7 @@ end
|
|
1046
1117
|
| Name | Type | Description | Notes |
|
1047
1118
|
| ---- | ---- | ----------- | ----- |
|
1048
1119
|
| **id** | **Integer** | The company id | |
|
1049
|
-
| **page** | **Integer** | The page number | [optional][default to
|
1120
|
+
| **page** | **Integer** | The page number | [optional][default to 0] |
|
1050
1121
|
| **per_page** | **Integer** | The number of items per page | [optional][default to 10] |
|
1051
1122
|
| **public_template** | **Boolean** | The public template | [optional][default to false] |
|
1052
1123
|
|
@@ -1064,6 +1135,140 @@ No authorization required
|
|
1064
1135
|
- **Accept**: application/json
|
1065
1136
|
|
1066
1137
|
|
1138
|
+
## get_members_bulk_upload
|
1139
|
+
|
1140
|
+
> <V1EntitiesMembersBulkUpload> get_members_bulk_upload(id, id_members_bulk_upload)
|
1141
|
+
|
1142
|
+
Get bulk upload record
|
1143
|
+
|
1144
|
+
Get members bulk upload record
|
1145
|
+
|
1146
|
+
### Examples
|
1147
|
+
|
1148
|
+
```ruby
|
1149
|
+
require 'time'
|
1150
|
+
require 'DealMakerAPI'
|
1151
|
+
# setup authorization
|
1152
|
+
DealMakerAPI.configure do |config|end
|
1153
|
+
|
1154
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
1155
|
+
id = 56 # Integer | The company id
|
1156
|
+
id_members_bulk_upload = 56 # Integer | The bulk upload id
|
1157
|
+
|
1158
|
+
begin
|
1159
|
+
# Get bulk upload record
|
1160
|
+
result = api_instance.get_members_bulk_upload(id, id_members_bulk_upload)
|
1161
|
+
p result
|
1162
|
+
rescue DealMakerAPI::ApiError => e
|
1163
|
+
puts "Error when calling CompanyApi->get_members_bulk_upload: #{e}"
|
1164
|
+
end
|
1165
|
+
```
|
1166
|
+
|
1167
|
+
#### Using the get_members_bulk_upload_with_http_info variant
|
1168
|
+
|
1169
|
+
This returns an Array which contains the response data, status code and headers.
|
1170
|
+
|
1171
|
+
> <Array(<V1EntitiesMembersBulkUpload>, Integer, Hash)> get_members_bulk_upload_with_http_info(id, id_members_bulk_upload)
|
1172
|
+
|
1173
|
+
```ruby
|
1174
|
+
begin
|
1175
|
+
# Get bulk upload record
|
1176
|
+
data, status_code, headers = api_instance.get_members_bulk_upload_with_http_info(id, id_members_bulk_upload)
|
1177
|
+
p status_code # => 2xx
|
1178
|
+
p headers # => { ... }
|
1179
|
+
p data # => <V1EntitiesMembersBulkUpload>
|
1180
|
+
rescue DealMakerAPI::ApiError => e
|
1181
|
+
puts "Error when calling CompanyApi->get_members_bulk_upload_with_http_info: #{e}"
|
1182
|
+
end
|
1183
|
+
```
|
1184
|
+
|
1185
|
+
### Parameters
|
1186
|
+
|
1187
|
+
| Name | Type | Description | Notes |
|
1188
|
+
| ---- | ---- | ----------- | ----- |
|
1189
|
+
| **id** | **Integer** | The company id | |
|
1190
|
+
| **id_members_bulk_upload** | **Integer** | The bulk upload id | |
|
1191
|
+
|
1192
|
+
### Return type
|
1193
|
+
|
1194
|
+
[**V1EntitiesMembersBulkUpload**](V1EntitiesMembersBulkUpload.md)
|
1195
|
+
|
1196
|
+
### Authorization
|
1197
|
+
|
1198
|
+
No authorization required
|
1199
|
+
|
1200
|
+
### HTTP request headers
|
1201
|
+
|
1202
|
+
- **Content-Type**: Not defined
|
1203
|
+
- **Accept**: application/json
|
1204
|
+
|
1205
|
+
|
1206
|
+
## get_members_bulk_uploads
|
1207
|
+
|
1208
|
+
> <V1EntitiesMembersBulkUploads> get_members_bulk_uploads(id)
|
1209
|
+
|
1210
|
+
Get bulk uploads records
|
1211
|
+
|
1212
|
+
Get members bulk uploads records
|
1213
|
+
|
1214
|
+
### Examples
|
1215
|
+
|
1216
|
+
```ruby
|
1217
|
+
require 'time'
|
1218
|
+
require 'DealMakerAPI'
|
1219
|
+
# setup authorization
|
1220
|
+
DealMakerAPI.configure do |config|end
|
1221
|
+
|
1222
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
1223
|
+
id = 56 # Integer | The company id
|
1224
|
+
|
1225
|
+
begin
|
1226
|
+
# Get bulk uploads records
|
1227
|
+
result = api_instance.get_members_bulk_uploads(id)
|
1228
|
+
p result
|
1229
|
+
rescue DealMakerAPI::ApiError => e
|
1230
|
+
puts "Error when calling CompanyApi->get_members_bulk_uploads: #{e}"
|
1231
|
+
end
|
1232
|
+
```
|
1233
|
+
|
1234
|
+
#### Using the get_members_bulk_uploads_with_http_info variant
|
1235
|
+
|
1236
|
+
This returns an Array which contains the response data, status code and headers.
|
1237
|
+
|
1238
|
+
> <Array(<V1EntitiesMembersBulkUploads>, Integer, Hash)> get_members_bulk_uploads_with_http_info(id)
|
1239
|
+
|
1240
|
+
```ruby
|
1241
|
+
begin
|
1242
|
+
# Get bulk uploads records
|
1243
|
+
data, status_code, headers = api_instance.get_members_bulk_uploads_with_http_info(id)
|
1244
|
+
p status_code # => 2xx
|
1245
|
+
p headers # => { ... }
|
1246
|
+
p data # => <V1EntitiesMembersBulkUploads>
|
1247
|
+
rescue DealMakerAPI::ApiError => e
|
1248
|
+
puts "Error when calling CompanyApi->get_members_bulk_uploads_with_http_info: #{e}"
|
1249
|
+
end
|
1250
|
+
```
|
1251
|
+
|
1252
|
+
### Parameters
|
1253
|
+
|
1254
|
+
| Name | Type | Description | Notes |
|
1255
|
+
| ---- | ---- | ----------- | ----- |
|
1256
|
+
| **id** | **Integer** | The company id | |
|
1257
|
+
|
1258
|
+
### Return type
|
1259
|
+
|
1260
|
+
[**V1EntitiesMembersBulkUploads**](V1EntitiesMembersBulkUploads.md)
|
1261
|
+
|
1262
|
+
### Authorization
|
1263
|
+
|
1264
|
+
No authorization required
|
1265
|
+
|
1266
|
+
### HTTP request headers
|
1267
|
+
|
1268
|
+
- **Content-Type**: Not defined
|
1269
|
+
- **Accept**: application/json
|
1270
|
+
|
1271
|
+
|
1067
1272
|
## get_shareholder_ledger
|
1068
1273
|
|
1069
1274
|
> <V1EntitiesShareholderLedger> get_shareholder_ledger(id)
|
@@ -9,6 +9,7 @@
|
|
9
9
|
| **upload_name** | **String** | The bulk upload name | |
|
10
10
|
| **send_notification** | **Boolean** | Send notification to the user | |
|
11
11
|
| **notification_message** | **String** | Notification message | |
|
12
|
+
| **json_notification_message** | **Object** | JSON notification message | |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = DealMakerAPI::CreateBulkUploadRequest.new(
|
|
20
21
|
document_type: null,
|
21
22
|
upload_name: null,
|
22
23
|
send_notification: null,
|
23
|
-
notification_message: null
|
24
|
+
notification_message: null,
|
25
|
+
json_notification_message: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DealMakerAPI::CreateMembersBulkUploadRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **csv_file** | **File** | The file csv | |
|
8
|
+
| **send_notification** | **Boolean** | Send notification to the user | [optional][default to false] |
|
9
|
+
| **offsite_shareholder** | **Boolean** | Offside shareholder | [optional][default to false] |
|
10
|
+
| **email_subject** | **String** | Email subject | [optional] |
|
11
|
+
| **email_content** | **String** | Email content | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'DealMakerAPI'
|
17
|
+
|
18
|
+
instance = DealMakerAPI::CreateMembersBulkUploadRequest.new(
|
19
|
+
csv_file: null,
|
20
|
+
send_notification: null,
|
21
|
+
offsite_shareholder: null,
|
22
|
+
email_subject: null,
|
23
|
+
email_content: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/V1EntitiesInvestor.md
CHANGED
@@ -21,6 +21,7 @@
|
|
21
21
|
| **allocated_amount** | **Float** | The amount allocated. | [optional] |
|
22
22
|
| **funds_value** | **Float** | The current amount that has been funded. | [optional] |
|
23
23
|
| **access_link** | **String** | The access link for the investor. This is the access link for the specific investment, not the user. If the same user has multiple investments, each one will have a different access link. Please note that this access link expires every hour. In order to redirect the investor into their authentication screen, use the https://app.dealmaker.tech/deals/{{deal_id}}/investors/{{investor_id}}/otp_access url. | [optional] |
|
24
|
+
| **subscription_id** | **Integer** | The investor subscription id. | [optional] |
|
24
25
|
| **subscription_agreement** | [**V1EntitiesSubscriptionAgreement**](V1EntitiesSubscriptionAgreement.md) | | [optional] |
|
25
26
|
| **attachments** | [**V1EntitiesAttachment**](V1EntitiesAttachment.md) | | [optional] |
|
26
27
|
| **background_check_searches** | [**V1EntitiesBackgroundCheckSearch**](V1EntitiesBackgroundCheckSearch.md) | | [optional] |
|
@@ -56,6 +57,7 @@ instance = DealMakerAPI::V1EntitiesInvestor.new(
|
|
56
57
|
allocated_amount: null,
|
57
58
|
funds_value: null,
|
58
59
|
access_link: null,
|
60
|
+
subscription_id: null,
|
59
61
|
subscription_agreement: null,
|
60
62
|
attachments: null,
|
61
63
|
background_check_searches: null,
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesMembersBulkUpload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The bulk upload ID | [optional] |
|
8
|
+
| **company_id** | **Integer** | The company ID | [optional] |
|
9
|
+
| **status** | **String** | The status [pending, processing, completed, failed] | [optional] |
|
10
|
+
| **total_count** | **Integer** | The number of members in the bulk upload | [optional] |
|
11
|
+
| **processed_count** | **Integer** | The number of processed members in the bulk upload | [optional] |
|
12
|
+
| **error_count** | **Integer** | The number of failed members in the bulk upload | [optional] |
|
13
|
+
| **send_notification** | **String** | Send notification to the user | [optional] |
|
14
|
+
| **offsite_shareholder** | **String** | Offside shareholder | [optional] |
|
15
|
+
| **email_subject** | **String** | Email subject | [optional] |
|
16
|
+
| **email_content** | **String** | Email content | [optional] |
|
17
|
+
| **error_details** | **String** | The error details | [optional] |
|
18
|
+
| **created_at** | **String** | The created at timestamp | [optional] |
|
19
|
+
| **updated_at** | **String** | The updated at timestamp | [optional] |
|
20
|
+
|
21
|
+
## Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'DealMakerAPI'
|
25
|
+
|
26
|
+
instance = DealMakerAPI::V1EntitiesMembersBulkUpload.new(
|
27
|
+
id: null,
|
28
|
+
company_id: null,
|
29
|
+
status: null,
|
30
|
+
total_count: null,
|
31
|
+
processed_count: null,
|
32
|
+
error_count: null,
|
33
|
+
send_notification: null,
|
34
|
+
offsite_shareholder: null,
|
35
|
+
email_subject: null,
|
36
|
+
email_content: null,
|
37
|
+
error_details: null,
|
38
|
+
created_at: null,
|
39
|
+
updated_at: null
|
40
|
+
)
|
41
|
+
```
|
42
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesMembersBulkUploads
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesMembersBulkUpload**](V1EntitiesMembersBulkUpload.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesMembersBulkUploads.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|