DealMakerAPI 0.83.2 → 0.84.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 +8 -6
- data/docs/BulkUploadInvestorsRequest.md +18 -0
- data/docs/CompanyApi.md +70 -70
- data/docs/CreateBulkUploadRequest.md +3 -1
- data/docs/InvestorApi.md +69 -0
- data/docs/V1EntitiesBulkUpload.md +2 -0
- data/lib/DealMakerAPI/api/company_api.rb +69 -69
- data/lib/DealMakerAPI/api/investor_api.rb +74 -0
- data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +222 -0
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +21 -4
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +11 -1
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +1 -0
- data/spec/api/company_api_spec.rb +13 -13
- data/spec/api/investor_api_spec.rb +13 -0
- data/spec/models/bulk_upload_investors_request_spec.rb +34 -0
- data/spec/models/create_bulk_upload_request_spec.rb +6 -0
- data/spec/models/v1_entities_bulk_upload_spec.rb +6 -0
- metadata +66 -62
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8bf8eeb48a326ca7564d8d90a708781da95f409252028b26806822d5a483f116
|
4
|
+
data.tar.gz: e2c021d22d82d2e66c41b08ff58f1dab555fcaee85dda4a53450bd2451c73baa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 28907bd6324770189c3eba7a2c92d42c3cd744c042281bfa59b4ef051c3fdb3002a393b9de21d9809e24a8981b0746241ef3c5c8821252c89acdfbade2d27882
|
7
|
+
data.tar.gz: 767d37b855e7560595dd2728778413cf3cbeac6206a647eead2d5478d70a1da2f1fe03a34fe221375904f7b3d696cfb47daa455ac5802e7e4a43f23bc6046cec
|
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.
|
341
|
+
- Package version: 0.84.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.84.1.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.84.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.84.1'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -392,7 +392,7 @@ DealMakerAPI.configure do |config|end
|
|
392
392
|
|
393
393
|
api_instance = DealMakerAPI::CompanyApi.new
|
394
394
|
id = 56 # Integer | The company id
|
395
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
395
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example'}) # CreateBulkUploadRequest |
|
396
396
|
|
397
397
|
begin
|
398
398
|
#Create bulk upload record
|
@@ -414,10 +414,10 @@ Class | Method | HTTP request | Description
|
|
414
414
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload_detail**](docs/CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record
|
415
415
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
416
416
|
*DealMakerAPI::CompanyApi* | [**get_bulk_upload_details**](docs/CompanyApi.md#get_bulk_upload_details) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Return full list of bulk upload details order by status desc and id asc
|
417
|
-
*DealMakerAPI::CompanyApi* | [**get_bulk_upload_details_by_status**](docs/CompanyApi.md#get_bulk_upload_details_by_status) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status | Return bulk upload details grouped by status
|
418
417
|
*DealMakerAPI::CompanyApi* | [**get_bulk_uploads**](docs/CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads
|
419
418
|
*DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
|
420
419
|
*DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
|
420
|
+
*DealMakerAPI::CompanyApi* | [**get_details_errors_grouped**](docs/CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status
|
421
421
|
*DealMakerAPI::DealApi* | [**get_analytics_dashboard_info**](docs/DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info
|
422
422
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
423
423
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
@@ -432,6 +432,7 @@ Class | Method | HTTP request | Description
|
|
432
432
|
*DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
|
433
433
|
*DealMakerAPI::InvestorApi* | [**add506c_document**](docs/InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor
|
434
434
|
*DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
|
435
|
+
*DealMakerAPI::InvestorApi* | [**bulk_upload_investors**](docs/InvestorApi.md#bulk_upload_investors) | **POST** /deals/{id}/investors/bulk_upload | Bulk upload investors for deal investor
|
435
436
|
*DealMakerAPI::InvestorApi* | [**create_investor**](docs/InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor
|
436
437
|
*DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
|
437
438
|
*DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
|
@@ -461,6 +462,7 @@ Class | Method | HTTP request | Description
|
|
461
462
|
|
462
463
|
- [DealMakerAPI::Add506cDocumentRequest](docs/Add506cDocumentRequest.md)
|
463
464
|
- [DealMakerAPI::AddDocumentRequest](docs/AddDocumentRequest.md)
|
465
|
+
- [DealMakerAPI::BulkUploadInvestorsRequest](docs/BulkUploadInvestorsRequest.md)
|
464
466
|
- [DealMakerAPI::CreateBulkUploadDetailRequest](docs/CreateBulkUploadDetailRequest.md)
|
465
467
|
- [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
|
466
468
|
- [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::BulkUploadInvestorsRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **import_file** | **File** | The CSV file with data to upload. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::BulkUploadInvestorsRequest.new(
|
15
|
+
import_file: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/CompanyApi.md
CHANGED
@@ -8,10 +8,10 @@ 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
|
| [**get_bulk_upload_details**](CompanyApi.md#get_bulk_upload_details) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Return full list of bulk upload details order by status desc and id asc |
|
11
|
-
| [**get_bulk_upload_details_by_status**](CompanyApi.md#get_bulk_upload_details_by_status) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status | Return bulk upload details grouped by status |
|
12
11
|
| [**get_bulk_uploads**](CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads |
|
13
12
|
| [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
|
14
13
|
| [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
|
14
|
+
| [**get_details_errors_grouped**](CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status |
|
15
15
|
|
16
16
|
|
17
17
|
## create_bulk_upload
|
@@ -32,7 +32,7 @@ DealMakerAPI.configure do |config|end
|
|
32
32
|
|
33
33
|
api_instance = DealMakerAPI::CompanyApi.new
|
34
34
|
id = 56 # Integer | The company id
|
35
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
35
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example'}) # CreateBulkUploadRequest |
|
36
36
|
|
37
37
|
begin
|
38
38
|
# Create bulk upload record
|
@@ -286,74 +286,6 @@ No authorization required
|
|
286
286
|
- **Accept**: application/json
|
287
287
|
|
288
288
|
|
289
|
-
## get_bulk_upload_details_by_status
|
290
|
-
|
291
|
-
> <V1EntitiesBulkUploadDetails> get_bulk_upload_details_by_status(company_id, bulk_upload_id)
|
292
|
-
|
293
|
-
Return bulk upload details grouped by status
|
294
|
-
|
295
|
-
Return bulk upload details grouped by status
|
296
|
-
|
297
|
-
### Examples
|
298
|
-
|
299
|
-
```ruby
|
300
|
-
require 'time'
|
301
|
-
require 'DealMakerAPI'
|
302
|
-
# setup authorization
|
303
|
-
DealMakerAPI.configure do |config|end
|
304
|
-
|
305
|
-
api_instance = DealMakerAPI::CompanyApi.new
|
306
|
-
company_id = 56 # Integer |
|
307
|
-
bulk_upload_id = 56 # Integer |
|
308
|
-
|
309
|
-
begin
|
310
|
-
# Return bulk upload details grouped by status
|
311
|
-
result = api_instance.get_bulk_upload_details_by_status(company_id, bulk_upload_id)
|
312
|
-
p result
|
313
|
-
rescue DealMakerAPI::ApiError => e
|
314
|
-
puts "Error when calling CompanyApi->get_bulk_upload_details_by_status: #{e}"
|
315
|
-
end
|
316
|
-
```
|
317
|
-
|
318
|
-
#### Using the get_bulk_upload_details_by_status_with_http_info variant
|
319
|
-
|
320
|
-
This returns an Array which contains the response data, status code and headers.
|
321
|
-
|
322
|
-
> <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id)
|
323
|
-
|
324
|
-
```ruby
|
325
|
-
begin
|
326
|
-
# Return bulk upload details grouped by status
|
327
|
-
data, status_code, headers = api_instance.get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id)
|
328
|
-
p status_code # => 2xx
|
329
|
-
p headers # => { ... }
|
330
|
-
p data # => <V1EntitiesBulkUploadDetails>
|
331
|
-
rescue DealMakerAPI::ApiError => e
|
332
|
-
puts "Error when calling CompanyApi->get_bulk_upload_details_by_status_with_http_info: #{e}"
|
333
|
-
end
|
334
|
-
```
|
335
|
-
|
336
|
-
### Parameters
|
337
|
-
|
338
|
-
| Name | Type | Description | Notes |
|
339
|
-
| ---- | ---- | ----------- | ----- |
|
340
|
-
| **company_id** | **Integer** | | |
|
341
|
-
| **bulk_upload_id** | **Integer** | | |
|
342
|
-
|
343
|
-
### Return type
|
344
|
-
|
345
|
-
[**V1EntitiesBulkUploadDetails**](V1EntitiesBulkUploadDetails.md)
|
346
|
-
|
347
|
-
### Authorization
|
348
|
-
|
349
|
-
No authorization required
|
350
|
-
|
351
|
-
### HTTP request headers
|
352
|
-
|
353
|
-
- **Content-Type**: Not defined
|
354
|
-
- **Accept**: application/json
|
355
|
-
|
356
|
-
|
357
289
|
## get_bulk_uploads
|
358
290
|
|
359
291
|
> <V1EntitiesBulkUploads> get_bulk_uploads(id, opts)
|
@@ -565,3 +497,71 @@ No authorization required
|
|
565
497
|
- **Content-Type**: Not defined
|
566
498
|
- **Accept**: application/json
|
567
499
|
|
500
|
+
|
501
|
+
## get_details_errors_grouped
|
502
|
+
|
503
|
+
> <V1EntitiesBulkUploadDetails> get_details_errors_grouped(company_id, bulk_upload_id)
|
504
|
+
|
505
|
+
Return bulk upload details grouped by status
|
506
|
+
|
507
|
+
Return bulk upload details grouped by status
|
508
|
+
|
509
|
+
### Examples
|
510
|
+
|
511
|
+
```ruby
|
512
|
+
require 'time'
|
513
|
+
require 'DealMakerAPI'
|
514
|
+
# setup authorization
|
515
|
+
DealMakerAPI.configure do |config|end
|
516
|
+
|
517
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
518
|
+
company_id = 56 # Integer |
|
519
|
+
bulk_upload_id = 56 # Integer |
|
520
|
+
|
521
|
+
begin
|
522
|
+
# Return bulk upload details grouped by status
|
523
|
+
result = api_instance.get_details_errors_grouped(company_id, bulk_upload_id)
|
524
|
+
p result
|
525
|
+
rescue DealMakerAPI::ApiError => e
|
526
|
+
puts "Error when calling CompanyApi->get_details_errors_grouped: #{e}"
|
527
|
+
end
|
528
|
+
```
|
529
|
+
|
530
|
+
#### Using the get_details_errors_grouped_with_http_info variant
|
531
|
+
|
532
|
+
This returns an Array which contains the response data, status code and headers.
|
533
|
+
|
534
|
+
> <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_details_errors_grouped_with_http_info(company_id, bulk_upload_id)
|
535
|
+
|
536
|
+
```ruby
|
537
|
+
begin
|
538
|
+
# Return bulk upload details grouped by status
|
539
|
+
data, status_code, headers = api_instance.get_details_errors_grouped_with_http_info(company_id, bulk_upload_id)
|
540
|
+
p status_code # => 2xx
|
541
|
+
p headers # => { ... }
|
542
|
+
p data # => <V1EntitiesBulkUploadDetails>
|
543
|
+
rescue DealMakerAPI::ApiError => e
|
544
|
+
puts "Error when calling CompanyApi->get_details_errors_grouped_with_http_info: #{e}"
|
545
|
+
end
|
546
|
+
```
|
547
|
+
|
548
|
+
### Parameters
|
549
|
+
|
550
|
+
| Name | Type | Description | Notes |
|
551
|
+
| ---- | ---- | ----------- | ----- |
|
552
|
+
| **company_id** | **Integer** | | |
|
553
|
+
| **bulk_upload_id** | **Integer** | | |
|
554
|
+
|
555
|
+
### Return type
|
556
|
+
|
557
|
+
[**V1EntitiesBulkUploadDetails**](V1EntitiesBulkUploadDetails.md)
|
558
|
+
|
559
|
+
### Authorization
|
560
|
+
|
561
|
+
No authorization required
|
562
|
+
|
563
|
+
### HTTP request headers
|
564
|
+
|
565
|
+
- **Content-Type**: Not defined
|
566
|
+
- **Accept**: application/json
|
567
|
+
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **file_identifier** | **String** | The file identifier | |
|
8
8
|
| **document_type** | **String** | The document type | |
|
9
|
+
| **upload_name** | **String** | The bulk upload name | |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'DealMakerAPI'
|
|
14
15
|
|
15
16
|
instance = DealMakerAPI::CreateBulkUploadRequest.new(
|
16
17
|
file_identifier: null,
|
17
|
-
document_type: null
|
18
|
+
document_type: null,
|
19
|
+
upload_name: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
data/docs/InvestorApi.md
CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**add506c_document**](InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor |
|
8
8
|
| [**add_document**](InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor |
|
9
|
+
| [**bulk_upload_investors**](InvestorApi.md#bulk_upload_investors) | **POST** /deals/{id}/investors/bulk_upload | Bulk upload investors for deal investor |
|
9
10
|
| [**create_investor**](InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
|
10
11
|
| [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
|
11
12
|
| [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
|
@@ -157,6 +158,74 @@ No authorization required
|
|
157
158
|
- **Accept**: application/json
|
158
159
|
|
159
160
|
|
161
|
+
## bulk_upload_investors
|
162
|
+
|
163
|
+
> <V1EntitiesInvestor> bulk_upload_investors(id, bulk_upload_investors_request)
|
164
|
+
|
165
|
+
Bulk upload investors for deal investor
|
166
|
+
|
167
|
+
Bulk upload investors
|
168
|
+
|
169
|
+
### Examples
|
170
|
+
|
171
|
+
```ruby
|
172
|
+
require 'time'
|
173
|
+
require 'DealMakerAPI'
|
174
|
+
# setup authorization
|
175
|
+
DealMakerAPI.configure do |config|end
|
176
|
+
|
177
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
178
|
+
id = 56 # Integer | The deal id.
|
179
|
+
bulk_upload_investors_request = DealMakerAPI::BulkUploadInvestorsRequest.new({import_file: File.new('/path/to/some/file')}) # BulkUploadInvestorsRequest |
|
180
|
+
|
181
|
+
begin
|
182
|
+
# Bulk upload investors for deal investor
|
183
|
+
result = api_instance.bulk_upload_investors(id, bulk_upload_investors_request)
|
184
|
+
p result
|
185
|
+
rescue DealMakerAPI::ApiError => e
|
186
|
+
puts "Error when calling InvestorApi->bulk_upload_investors: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
#### Using the bulk_upload_investors_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
193
|
+
|
194
|
+
> <Array(<V1EntitiesInvestor>, Integer, Hash)> bulk_upload_investors_with_http_info(id, bulk_upload_investors_request)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# Bulk upload investors for deal investor
|
199
|
+
data, status_code, headers = api_instance.bulk_upload_investors_with_http_info(id, bulk_upload_investors_request)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => <V1EntitiesInvestor>
|
203
|
+
rescue DealMakerAPI::ApiError => e
|
204
|
+
puts "Error when calling InvestorApi->bulk_upload_investors_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **id** | **Integer** | The deal id. | |
|
213
|
+
| **bulk_upload_investors_request** | [**BulkUploadInvestorsRequest**](BulkUploadInvestorsRequest.md) | | |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
No authorization required
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: application/json
|
226
|
+
- **Accept**: application/json
|
227
|
+
|
228
|
+
|
160
229
|
## create_investor
|
161
230
|
|
162
231
|
> <V1EntitiesInvestor> create_investor(id, create_investor_request)
|
@@ -8,6 +8,7 @@
|
|
8
8
|
| **company_id** | **Integer** | The company ID | [optional] |
|
9
9
|
| **file_identifier** | **String** | The file identifier [shareholder, investor] | [optional] |
|
10
10
|
| **document_type** | **String** | The document type [drs_statement, shareholder_statement, book_entry_statement] | [optional] |
|
11
|
+
| **upload_name** | **String** | The bulk upload name | [optional] |
|
11
12
|
| **status** | **String** | The status [pending, processing, completed, failed] | [optional] |
|
12
13
|
| **created_at** | **String** | The created at timestamp | [optional] |
|
13
14
|
| **updated_at** | **String** | The updated at timestamp | [optional] |
|
@@ -22,6 +23,7 @@ instance = DealMakerAPI::V1EntitiesBulkUpload.new(
|
|
22
23
|
company_id: null,
|
23
24
|
file_identifier: null,
|
24
25
|
document_type: null,
|
26
|
+
upload_name: null,
|
25
27
|
status: null,
|
26
28
|
created_at: null,
|
27
29
|
updated_at: null
|
@@ -310,75 +310,6 @@ module DealMakerAPI
|
|
310
310
|
return data, status_code, headers
|
311
311
|
end
|
312
312
|
|
313
|
-
# Return bulk upload details grouped by status
|
314
|
-
# Return bulk upload details grouped by status
|
315
|
-
# @param company_id [Integer]
|
316
|
-
# @param bulk_upload_id [Integer]
|
317
|
-
# @param [Hash] opts the optional parameters
|
318
|
-
# @return [V1EntitiesBulkUploadDetails]
|
319
|
-
def get_bulk_upload_details_by_status(company_id, bulk_upload_id, opts = {})
|
320
|
-
data, _status_code, _headers = get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id, opts)
|
321
|
-
data
|
322
|
-
end
|
323
|
-
|
324
|
-
# Return bulk upload details grouped by status
|
325
|
-
# Return bulk upload details grouped by status
|
326
|
-
# @param company_id [Integer]
|
327
|
-
# @param bulk_upload_id [Integer]
|
328
|
-
# @param [Hash] opts the optional parameters
|
329
|
-
# @return [Array<(V1EntitiesBulkUploadDetails, Integer, Hash)>] V1EntitiesBulkUploadDetails data, response status code and response headers
|
330
|
-
def get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id, opts = {})
|
331
|
-
if @api_client.config.debugging
|
332
|
-
@api_client.config.logger.debug 'Calling API: CompanyApi.get_bulk_upload_details_by_status ...'
|
333
|
-
end
|
334
|
-
# verify the required parameter 'company_id' is set
|
335
|
-
if @api_client.config.client_side_validation && company_id.nil?
|
336
|
-
fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_bulk_upload_details_by_status"
|
337
|
-
end
|
338
|
-
# verify the required parameter 'bulk_upload_id' is set
|
339
|
-
if @api_client.config.client_side_validation && bulk_upload_id.nil?
|
340
|
-
fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.get_bulk_upload_details_by_status"
|
341
|
-
end
|
342
|
-
# resource path
|
343
|
-
local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_id.to_s))
|
344
|
-
|
345
|
-
# query parameters
|
346
|
-
query_params = opts[:query_params] || {}
|
347
|
-
|
348
|
-
# header parameters
|
349
|
-
header_params = opts[:header_params] || {}
|
350
|
-
# HTTP header 'Accept' (if needed)
|
351
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
352
|
-
|
353
|
-
# form parameters
|
354
|
-
form_params = opts[:form_params] || {}
|
355
|
-
|
356
|
-
# http body (model)
|
357
|
-
post_body = opts[:debug_body]
|
358
|
-
|
359
|
-
# return_type
|
360
|
-
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUploadDetails'
|
361
|
-
|
362
|
-
# auth_names
|
363
|
-
auth_names = opts[:debug_auth_names] || []
|
364
|
-
|
365
|
-
new_options = opts.merge(
|
366
|
-
:operation => :"CompanyApi.get_bulk_upload_details_by_status",
|
367
|
-
:header_params => header_params,
|
368
|
-
:query_params => query_params,
|
369
|
-
:form_params => form_params,
|
370
|
-
:body => post_body,
|
371
|
-
:auth_names => auth_names,
|
372
|
-
:return_type => return_type
|
373
|
-
)
|
374
|
-
|
375
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
376
|
-
if @api_client.config.debugging
|
377
|
-
@api_client.config.logger.debug "API called: CompanyApi#get_bulk_upload_details_by_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
378
|
-
end
|
379
|
-
return data, status_code, headers
|
380
|
-
end
|
381
|
-
|
382
313
|
# Return bulk uploads
|
383
314
|
# Return bulk uploads
|
384
315
|
# @param id [Integer]
|
@@ -579,5 +510,74 @@ module DealMakerAPI
|
|
579
510
|
end
|
580
511
|
return data, status_code, headers
|
581
512
|
end
|
513
|
+
|
514
|
+
# Return bulk upload details grouped by status
|
515
|
+
# Return bulk upload details grouped by status
|
516
|
+
# @param company_id [Integer]
|
517
|
+
# @param bulk_upload_id [Integer]
|
518
|
+
# @param [Hash] opts the optional parameters
|
519
|
+
# @return [V1EntitiesBulkUploadDetails]
|
520
|
+
def get_details_errors_grouped(company_id, bulk_upload_id, opts = {})
|
521
|
+
data, _status_code, _headers = get_details_errors_grouped_with_http_info(company_id, bulk_upload_id, opts)
|
522
|
+
data
|
523
|
+
end
|
524
|
+
|
525
|
+
# Return bulk upload details grouped by status
|
526
|
+
# Return bulk upload details grouped by status
|
527
|
+
# @param company_id [Integer]
|
528
|
+
# @param bulk_upload_id [Integer]
|
529
|
+
# @param [Hash] opts the optional parameters
|
530
|
+
# @return [Array<(V1EntitiesBulkUploadDetails, Integer, Hash)>] V1EntitiesBulkUploadDetails data, response status code and response headers
|
531
|
+
def get_details_errors_grouped_with_http_info(company_id, bulk_upload_id, opts = {})
|
532
|
+
if @api_client.config.debugging
|
533
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_details_errors_grouped ...'
|
534
|
+
end
|
535
|
+
# verify the required parameter 'company_id' is set
|
536
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
537
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_details_errors_grouped"
|
538
|
+
end
|
539
|
+
# verify the required parameter 'bulk_upload_id' is set
|
540
|
+
if @api_client.config.client_side_validation && bulk_upload_id.nil?
|
541
|
+
fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.get_details_errors_grouped"
|
542
|
+
end
|
543
|
+
# resource path
|
544
|
+
local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_id.to_s))
|
545
|
+
|
546
|
+
# query parameters
|
547
|
+
query_params = opts[:query_params] || {}
|
548
|
+
|
549
|
+
# header parameters
|
550
|
+
header_params = opts[:header_params] || {}
|
551
|
+
# HTTP header 'Accept' (if needed)
|
552
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
553
|
+
|
554
|
+
# form parameters
|
555
|
+
form_params = opts[:form_params] || {}
|
556
|
+
|
557
|
+
# http body (model)
|
558
|
+
post_body = opts[:debug_body]
|
559
|
+
|
560
|
+
# return_type
|
561
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUploadDetails'
|
562
|
+
|
563
|
+
# auth_names
|
564
|
+
auth_names = opts[:debug_auth_names] || []
|
565
|
+
|
566
|
+
new_options = opts.merge(
|
567
|
+
:operation => :"CompanyApi.get_details_errors_grouped",
|
568
|
+
:header_params => header_params,
|
569
|
+
:query_params => query_params,
|
570
|
+
:form_params => form_params,
|
571
|
+
:body => post_body,
|
572
|
+
:auth_names => auth_names,
|
573
|
+
:return_type => return_type
|
574
|
+
)
|
575
|
+
|
576
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
577
|
+
if @api_client.config.debugging
|
578
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_details_errors_grouped\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
579
|
+
end
|
580
|
+
return data, status_code, headers
|
581
|
+
end
|
582
582
|
end
|
583
583
|
end
|
@@ -179,6 +179,80 @@ module DealMakerAPI
|
|
179
179
|
return data, status_code, headers
|
180
180
|
end
|
181
181
|
|
182
|
+
# Bulk upload investors for deal investor
|
183
|
+
# Bulk upload investors
|
184
|
+
# @param id [Integer] The deal id.
|
185
|
+
# @param bulk_upload_investors_request [BulkUploadInvestorsRequest]
|
186
|
+
# @param [Hash] opts the optional parameters
|
187
|
+
# @return [V1EntitiesInvestor]
|
188
|
+
def bulk_upload_investors(id, bulk_upload_investors_request, opts = {})
|
189
|
+
data, _status_code, _headers = bulk_upload_investors_with_http_info(id, bulk_upload_investors_request, opts)
|
190
|
+
data
|
191
|
+
end
|
192
|
+
|
193
|
+
# Bulk upload investors for deal investor
|
194
|
+
# Bulk upload investors
|
195
|
+
# @param id [Integer] The deal id.
|
196
|
+
# @param bulk_upload_investors_request [BulkUploadInvestorsRequest]
|
197
|
+
# @param [Hash] opts the optional parameters
|
198
|
+
# @return [Array<(V1EntitiesInvestor, Integer, Hash)>] V1EntitiesInvestor data, response status code and response headers
|
199
|
+
def bulk_upload_investors_with_http_info(id, bulk_upload_investors_request, opts = {})
|
200
|
+
if @api_client.config.debugging
|
201
|
+
@api_client.config.logger.debug 'Calling API: InvestorApi.bulk_upload_investors ...'
|
202
|
+
end
|
203
|
+
# verify the required parameter 'id' is set
|
204
|
+
if @api_client.config.client_side_validation && id.nil?
|
205
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InvestorApi.bulk_upload_investors"
|
206
|
+
end
|
207
|
+
# verify the required parameter 'bulk_upload_investors_request' is set
|
208
|
+
if @api_client.config.client_side_validation && bulk_upload_investors_request.nil?
|
209
|
+
fail ArgumentError, "Missing the required parameter 'bulk_upload_investors_request' when calling InvestorApi.bulk_upload_investors"
|
210
|
+
end
|
211
|
+
# resource path
|
212
|
+
local_var_path = '/deals/{id}/investors/bulk_upload'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
213
|
+
|
214
|
+
# query parameters
|
215
|
+
query_params = opts[:query_params] || {}
|
216
|
+
|
217
|
+
# header parameters
|
218
|
+
header_params = opts[:header_params] || {}
|
219
|
+
# HTTP header 'Accept' (if needed)
|
220
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
221
|
+
# HTTP header 'Content-Type'
|
222
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
223
|
+
if !content_type.nil?
|
224
|
+
header_params['Content-Type'] = content_type
|
225
|
+
end
|
226
|
+
|
227
|
+
# form parameters
|
228
|
+
form_params = opts[:form_params] || {}
|
229
|
+
|
230
|
+
# http body (model)
|
231
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(bulk_upload_investors_request)
|
232
|
+
|
233
|
+
# return_type
|
234
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesInvestor'
|
235
|
+
|
236
|
+
# auth_names
|
237
|
+
auth_names = opts[:debug_auth_names] || []
|
238
|
+
|
239
|
+
new_options = opts.merge(
|
240
|
+
:operation => :"InvestorApi.bulk_upload_investors",
|
241
|
+
:header_params => header_params,
|
242
|
+
:query_params => query_params,
|
243
|
+
:form_params => form_params,
|
244
|
+
:body => post_body,
|
245
|
+
:auth_names => auth_names,
|
246
|
+
:return_type => return_type
|
247
|
+
)
|
248
|
+
|
249
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
250
|
+
if @api_client.config.debugging
|
251
|
+
@api_client.config.logger.debug "API called: InvestorApi#bulk_upload_investors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
252
|
+
end
|
253
|
+
return data, status_code, headers
|
254
|
+
end
|
255
|
+
|
182
256
|
# Create a deal investor
|
183
257
|
# Create a single deal investor.
|
184
258
|
# @param id [Integer] The deal id.
|