DealMakerAPI 0.82.1 → 0.83.0
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/README.md +12 -5
- data/docs/Add506cDocumentRequest.md +20 -0
- data/docs/CompanyApi.md +72 -1
- data/docs/CreateBulkUploadDetailRequest.md +22 -0
- data/docs/CreateBulkUploadRequest.md +0 -2
- data/docs/InvestorApi.md +139 -0
- data/docs/UpdateInvestorRequest.md +3 -1
- data/docs/UploadApi.md +9 -8
- data/docs/V1EntitiesBulkUploadDetail.md +30 -0
- data/docs/V1EntitiesPresignedUrlResult.md +20 -0
- data/lib/DealMakerAPI/api/company_api.rb +80 -0
- data/lib/DealMakerAPI/api/investor_api.rb +147 -0
- data/lib/DealMakerAPI/api/upload_api.rb +9 -7
- data/lib/DealMakerAPI/models/add506c_document_request.rb +235 -0
- data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +250 -0
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +1 -16
- data/lib/DealMakerAPI/models/update_investor_request.rb +14 -4
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +281 -0
- data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +231 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +4 -0
- data/spec/api/company_api_spec.rb +14 -0
- data/spec/api/investor_api_spec.rb +27 -0
- data/spec/api/upload_api_spec.rb +2 -2
- data/spec/models/add506c_document_request_spec.rb +40 -0
- data/spec/models/create_bulk_upload_detail_request_spec.rb +46 -0
- data/spec/models/create_bulk_upload_request_spec.rb +0 -6
- data/spec/models/update_investor_request_spec.rb +6 -0
- data/spec/models/v1_entities_bulk_upload_detail_spec.rb +70 -0
- data/spec/models/v1_entities_presigned_url_result_spec.rb +40 -0
- metadata +18 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9cbda96527d24da7071c8241944416a5911f0ba423c199ae1e1a9a6fad8da743
|
|
4
|
+
data.tar.gz: 9300f5c3f1542606931accf38e7234ba7ffc2e389c1159b871a839fd7e436d64
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d9d5576bb064ef18bae1c7151f98528607b960d2b9f5dde0827ecc723d08660a772c77f5ccfdbffd95fd3ad57588bbe80695defaf6ab46c03a7f09ed022ee611
|
|
7
|
+
data.tar.gz: 382b9bfb6f7538b95e05f34804032ef7afb9f3e61aaf1dea82973436d4a64c755f47b20e8b04ee6f70a5c69ffb3f0cc9b6a693dad3dcb9dcbb092b119368e2ff
|
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.83.0
|
|
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.83.0.gem
|
|
358
358
|
```
|
|
359
359
|
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.83.0.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.83.0'
|
|
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({
|
|
395
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
|
396
396
|
|
|
397
397
|
begin
|
|
398
398
|
#Create bulk upload record
|
|
@@ -411,6 +411,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
411
411
|
Class | Method | HTTP request | Description
|
|
412
412
|
------------ | ------------- | ------------- | -------------
|
|
413
413
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
|
|
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
|
|
414
415
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
|
415
416
|
*DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
|
|
416
417
|
*DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
|
|
@@ -426,9 +427,11 @@ Class | Method | HTTP request | Description
|
|
|
426
427
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_security_token**](docs/DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription
|
|
427
428
|
*DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
|
|
428
429
|
*DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
|
|
430
|
+
*DealMakerAPI::InvestorApi* | [**add506c_document**](docs/InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor
|
|
429
431
|
*DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
|
|
430
432
|
*DealMakerAPI::InvestorApi* | [**create_investor**](docs/InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor
|
|
431
433
|
*DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
|
|
434
|
+
*DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
|
|
432
435
|
*DealMakerAPI::InvestorApi* | [**edit_investor_tags**](docs/InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor
|
|
433
436
|
*DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
|
|
434
437
|
*DealMakerAPI::InvestorApi* | [**get_investor_otp_link**](docs/InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor
|
|
@@ -453,7 +456,9 @@ Class | Method | HTTP request | Description
|
|
|
453
456
|
|
|
454
457
|
## Documentation for Models
|
|
455
458
|
|
|
459
|
+
- [DealMakerAPI::Add506cDocumentRequest](docs/Add506cDocumentRequest.md)
|
|
456
460
|
- [DealMakerAPI::AddDocumentRequest](docs/AddDocumentRequest.md)
|
|
461
|
+
- [DealMakerAPI::CreateBulkUploadDetailRequest](docs/CreateBulkUploadDetailRequest.md)
|
|
457
462
|
- [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
|
|
458
463
|
- [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
|
459
464
|
- [DealMakerAPI::CreateCorporationProfileRequest](docs/CreateCorporationProfileRequest.md)
|
|
@@ -477,6 +482,7 @@ Class | Method | HTTP request | Description
|
|
|
477
482
|
- [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
|
|
478
483
|
- [DealMakerAPI::V1EntitiesBackgroundCheckSearch](docs/V1EntitiesBackgroundCheckSearch.md)
|
|
479
484
|
- [DealMakerAPI::V1EntitiesBulkUpload](docs/V1EntitiesBulkUpload.md)
|
|
485
|
+
- [DealMakerAPI::V1EntitiesBulkUploadDetail](docs/V1EntitiesBulkUploadDetail.md)
|
|
480
486
|
- [DealMakerAPI::V1EntitiesCompany](docs/V1EntitiesCompany.md)
|
|
481
487
|
- [DealMakerAPI::V1EntitiesCompanyDeal](docs/V1EntitiesCompanyDeal.md)
|
|
482
488
|
- [DealMakerAPI::V1EntitiesCompanyDeals](docs/V1EntitiesCompanyDeals.md)
|
|
@@ -506,6 +512,7 @@ Class | Method | HTTP request | Description
|
|
|
506
512
|
- [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
|
|
507
513
|
- [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
|
|
508
514
|
- [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
|
|
515
|
+
- [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
|
|
509
516
|
- [DealMakerAPI::V1EntitiesShareholder](docs/V1EntitiesShareholder.md)
|
|
510
517
|
- [DealMakerAPI::V1EntitiesShareholders](docs/V1EntitiesShareholders.md)
|
|
511
518
|
- [DealMakerAPI::V1EntitiesShareholdersTags](docs/V1EntitiesShareholdersTags.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DealMakerAPI::Add506cDocumentRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file** | **File** | File to upload | |
|
|
8
|
+
| **caption** | **String** | The caption | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'DealMakerAPI'
|
|
14
|
+
|
|
15
|
+
instance = DealMakerAPI::Add506cDocumentRequest.new(
|
|
16
|
+
file: null,
|
|
17
|
+
caption: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/CompanyApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**create_bulk_upload**](CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record |
|
|
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 |
|
|
8
9
|
| [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
|
|
9
10
|
| [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
|
|
10
11
|
| [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
|
|
@@ -28,7 +29,7 @@ DealMakerAPI.configure do |config|end
|
|
|
28
29
|
|
|
29
30
|
api_instance = DealMakerAPI::CompanyApi.new
|
|
30
31
|
id = 56 # Integer | The company id
|
|
31
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({
|
|
32
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
|
32
33
|
|
|
33
34
|
begin
|
|
34
35
|
# Create bulk upload record
|
|
@@ -78,6 +79,76 @@ No authorization required
|
|
|
78
79
|
- **Accept**: application/json
|
|
79
80
|
|
|
80
81
|
|
|
82
|
+
## create_bulk_upload_detail
|
|
83
|
+
|
|
84
|
+
> <V1EntitiesBulkUploadDetail> create_bulk_upload_detail(bulk_upload_id, company_id, create_bulk_upload_detail_request)
|
|
85
|
+
|
|
86
|
+
Create a BulkUploadDetail class record
|
|
87
|
+
|
|
88
|
+
Create a BulkUploadDetail class record
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'DealMakerAPI'
|
|
95
|
+
# setup authorization
|
|
96
|
+
DealMakerAPI.configure do |config|end
|
|
97
|
+
|
|
98
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
|
99
|
+
bulk_upload_id = 'bulk_upload_id_example' # String | The Bulk upload ID from which detail is associated with
|
|
100
|
+
company_id = 56 # Integer |
|
|
101
|
+
create_bulk_upload_detail_request = DealMakerAPI::CreateBulkUploadDetailRequest.new({file_key: 'file_key_example', file_name: 'file_name_example'}) # CreateBulkUploadDetailRequest |
|
|
102
|
+
|
|
103
|
+
begin
|
|
104
|
+
# Create a BulkUploadDetail class record
|
|
105
|
+
result = api_instance.create_bulk_upload_detail(bulk_upload_id, company_id, create_bulk_upload_detail_request)
|
|
106
|
+
p result
|
|
107
|
+
rescue DealMakerAPI::ApiError => e
|
|
108
|
+
puts "Error when calling CompanyApi->create_bulk_upload_detail: #{e}"
|
|
109
|
+
end
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
#### Using the create_bulk_upload_detail_with_http_info variant
|
|
113
|
+
|
|
114
|
+
This returns an Array which contains the response data, status code and headers.
|
|
115
|
+
|
|
116
|
+
> <Array(<V1EntitiesBulkUploadDetail>, Integer, Hash)> create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request)
|
|
117
|
+
|
|
118
|
+
```ruby
|
|
119
|
+
begin
|
|
120
|
+
# Create a BulkUploadDetail class record
|
|
121
|
+
data, status_code, headers = api_instance.create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request)
|
|
122
|
+
p status_code # => 2xx
|
|
123
|
+
p headers # => { ... }
|
|
124
|
+
p data # => <V1EntitiesBulkUploadDetail>
|
|
125
|
+
rescue DealMakerAPI::ApiError => e
|
|
126
|
+
puts "Error when calling CompanyApi->create_bulk_upload_detail_with_http_info: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Parameters
|
|
131
|
+
|
|
132
|
+
| Name | Type | Description | Notes |
|
|
133
|
+
| ---- | ---- | ----------- | ----- |
|
|
134
|
+
| **bulk_upload_id** | **String** | The Bulk upload ID from which detail is associated with | |
|
|
135
|
+
| **company_id** | **Integer** | | |
|
|
136
|
+
| **create_bulk_upload_detail_request** | [**CreateBulkUploadDetailRequest**](CreateBulkUploadDetailRequest.md) | | |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**V1EntitiesBulkUploadDetail**](V1EntitiesBulkUploadDetail.md)
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
No authorization required
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: application/json
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
81
152
|
## create_company
|
|
82
153
|
|
|
83
154
|
> <V1EntitiesCompany> create_company(create_company_request)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DealMakerAPI::CreateBulkUploadDetailRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_key** | **String** | The file ID | |
|
|
8
|
+
| **file_name** | **String** | The name of the file | |
|
|
9
|
+
| **status** | **Integer** | The status of the bulk upload detail | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'DealMakerAPI'
|
|
15
|
+
|
|
16
|
+
instance = DealMakerAPI::CreateBulkUploadDetailRequest.new(
|
|
17
|
+
file_key: null,
|
|
18
|
+
file_name: null,
|
|
19
|
+
status: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **file** | **File** | The ZIP file. | |
|
|
8
7
|
| **file_identifier** | **String** | The file identifier | |
|
|
9
8
|
| **document_type** | **String** | The document type | |
|
|
10
9
|
|
|
@@ -14,7 +13,6 @@
|
|
|
14
13
|
require 'DealMakerAPI'
|
|
15
14
|
|
|
16
15
|
instance = DealMakerAPI::CreateBulkUploadRequest.new(
|
|
17
|
-
file: null,
|
|
18
16
|
file_identifier: null,
|
|
19
17
|
document_type: null
|
|
20
18
|
)
|
data/docs/InvestorApi.md
CHANGED
|
@@ -4,9 +4,11 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add506c_document**](InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor |
|
|
7
8
|
| [**add_document**](InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor |
|
|
8
9
|
| [**create_investor**](InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
|
|
9
10
|
| [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
|
|
11
|
+
| [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
|
|
10
12
|
| [**edit_investor_tags**](InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor |
|
|
11
13
|
| [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
|
|
12
14
|
| [**get_investor_otp_link**](InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor |
|
|
@@ -15,6 +17,76 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
15
17
|
| [**update_investor**](InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor |
|
|
16
18
|
|
|
17
19
|
|
|
20
|
+
## add506c_document
|
|
21
|
+
|
|
22
|
+
> <V1EntitiesInvestor> add506c_document(id, investor_id, add506c_document_request)
|
|
23
|
+
|
|
24
|
+
Add 506c document for deal investor
|
|
25
|
+
|
|
26
|
+
Add 506c document for deal investor
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'time'
|
|
32
|
+
require 'DealMakerAPI'
|
|
33
|
+
# setup authorization
|
|
34
|
+
DealMakerAPI.configure do |config|end
|
|
35
|
+
|
|
36
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
|
37
|
+
id = 56 # Integer | The deal id.
|
|
38
|
+
investor_id = 56 # Integer | The investor id.
|
|
39
|
+
add506c_document_request = DealMakerAPI::Add506cDocumentRequest.new({file: File.new('/path/to/some/file')}) # Add506cDocumentRequest |
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Add 506c document for deal investor
|
|
43
|
+
result = api_instance.add506c_document(id, investor_id, add506c_document_request)
|
|
44
|
+
p result
|
|
45
|
+
rescue DealMakerAPI::ApiError => e
|
|
46
|
+
puts "Error when calling InvestorApi->add506c_document: #{e}"
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
#### Using the add506c_document_with_http_info variant
|
|
51
|
+
|
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
|
53
|
+
|
|
54
|
+
> <Array(<V1EntitiesInvestor>, Integer, Hash)> add506c_document_with_http_info(id, investor_id, add506c_document_request)
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
begin
|
|
58
|
+
# Add 506c document for deal investor
|
|
59
|
+
data, status_code, headers = api_instance.add506c_document_with_http_info(id, investor_id, add506c_document_request)
|
|
60
|
+
p status_code # => 2xx
|
|
61
|
+
p headers # => { ... }
|
|
62
|
+
p data # => <V1EntitiesInvestor>
|
|
63
|
+
rescue DealMakerAPI::ApiError => e
|
|
64
|
+
puts "Error when calling InvestorApi->add506c_document_with_http_info: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
|
72
|
+
| **id** | **Integer** | The deal id. | |
|
|
73
|
+
| **investor_id** | **Integer** | The investor id. | |
|
|
74
|
+
| **add506c_document_request** | [**Add506cDocumentRequest**](Add506cDocumentRequest.md) | | |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
No authorization required
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: application/json
|
|
87
|
+
- **Accept**: application/json
|
|
88
|
+
|
|
89
|
+
|
|
18
90
|
## add_document
|
|
19
91
|
|
|
20
92
|
> <V1EntitiesInvestor> add_document(id, investor_id, add_document_request)
|
|
@@ -222,6 +294,73 @@ No authorization required
|
|
|
222
294
|
- **Accept**: Not defined
|
|
223
295
|
|
|
224
296
|
|
|
297
|
+
## delete_investor_profile
|
|
298
|
+
|
|
299
|
+
> delete_investor_profile(type, id)
|
|
300
|
+
|
|
301
|
+
Delete investor profile.
|
|
302
|
+
|
|
303
|
+
Deletes the investor profile.
|
|
304
|
+
|
|
305
|
+
### Examples
|
|
306
|
+
|
|
307
|
+
```ruby
|
|
308
|
+
require 'time'
|
|
309
|
+
require 'DealMakerAPI'
|
|
310
|
+
# setup authorization
|
|
311
|
+
DealMakerAPI.configure do |config|end
|
|
312
|
+
|
|
313
|
+
api_instance = DealMakerAPI::InvestorApi.new
|
|
314
|
+
type = 56 # Integer |
|
|
315
|
+
id = 56 # Integer |
|
|
316
|
+
|
|
317
|
+
begin
|
|
318
|
+
# Delete investor profile.
|
|
319
|
+
api_instance.delete_investor_profile(type, id)
|
|
320
|
+
rescue DealMakerAPI::ApiError => e
|
|
321
|
+
puts "Error when calling InvestorApi->delete_investor_profile: #{e}"
|
|
322
|
+
end
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
#### Using the delete_investor_profile_with_http_info variant
|
|
326
|
+
|
|
327
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
328
|
+
|
|
329
|
+
> <Array(nil, Integer, Hash)> delete_investor_profile_with_http_info(type, id)
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
begin
|
|
333
|
+
# Delete investor profile.
|
|
334
|
+
data, status_code, headers = api_instance.delete_investor_profile_with_http_info(type, id)
|
|
335
|
+
p status_code # => 2xx
|
|
336
|
+
p headers # => { ... }
|
|
337
|
+
p data # => nil
|
|
338
|
+
rescue DealMakerAPI::ApiError => e
|
|
339
|
+
puts "Error when calling InvestorApi->delete_investor_profile_with_http_info: #{e}"
|
|
340
|
+
end
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Parameters
|
|
344
|
+
|
|
345
|
+
| Name | Type | Description | Notes |
|
|
346
|
+
| ---- | ---- | ----------- | ----- |
|
|
347
|
+
| **type** | **Integer** | | |
|
|
348
|
+
| **id** | **Integer** | | |
|
|
349
|
+
|
|
350
|
+
### Return type
|
|
351
|
+
|
|
352
|
+
nil (empty response body)
|
|
353
|
+
|
|
354
|
+
### Authorization
|
|
355
|
+
|
|
356
|
+
No authorization required
|
|
357
|
+
|
|
358
|
+
### HTTP request headers
|
|
359
|
+
|
|
360
|
+
- **Content-Type**: Not defined
|
|
361
|
+
- **Accept**: Not defined
|
|
362
|
+
|
|
363
|
+
|
|
225
364
|
## edit_investor_tags
|
|
226
365
|
|
|
227
366
|
> <V1EntitiesInvestor> edit_investor_tags(id, investor_id, edit_investor_tags_request)
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
|
|
10
10
|
| **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
|
|
11
11
|
| **investment_value** | **Float** | The investment value of the investor. | [optional] |
|
|
12
|
+
| **notes** | **String** | The notes of the investor. | [optional] |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,7 +21,8 @@ instance = DealMakerAPI::UpdateInvestorRequest.new(
|
|
|
20
21
|
warrant_certificate_number: null,
|
|
21
22
|
allocated_amount: null,
|
|
22
23
|
allocation_unit: null,
|
|
23
|
-
investment_value: null
|
|
24
|
+
investment_value: null,
|
|
25
|
+
notes: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
26
28
|
|
data/docs/UploadApi.md
CHANGED
|
@@ -9,11 +9,11 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
9
9
|
|
|
10
10
|
## generate_url
|
|
11
11
|
|
|
12
|
-
> generate_url(generate_url_request)
|
|
12
|
+
> <V1EntitiesPresignedUrlResult> generate_url(generate_url_request)
|
|
13
13
|
|
|
14
14
|
Create a presigned URL for Amazon S3
|
|
15
15
|
|
|
16
|
-
Create a presigned URL for Amazon S3
|
|
16
|
+
Create a presigned URL for uploading file to Amazon S3 bucket
|
|
17
17
|
|
|
18
18
|
### Examples
|
|
19
19
|
|
|
@@ -28,7 +28,8 @@ generate_url_request = DealMakerAPI::GenerateUrlRequest.new({filename: 'filename
|
|
|
28
28
|
|
|
29
29
|
begin
|
|
30
30
|
# Create a presigned URL for Amazon S3
|
|
31
|
-
api_instance.generate_url(generate_url_request)
|
|
31
|
+
result = api_instance.generate_url(generate_url_request)
|
|
32
|
+
p result
|
|
32
33
|
rescue DealMakerAPI::ApiError => e
|
|
33
34
|
puts "Error when calling UploadApi->generate_url: #{e}"
|
|
34
35
|
end
|
|
@@ -36,9 +37,9 @@ end
|
|
|
36
37
|
|
|
37
38
|
#### Using the generate_url_with_http_info variant
|
|
38
39
|
|
|
39
|
-
This returns an Array which contains the response data
|
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
|
40
41
|
|
|
41
|
-
> <Array(
|
|
42
|
+
> <Array(<V1EntitiesPresignedUrlResult>, Integer, Hash)> generate_url_with_http_info(generate_url_request)
|
|
42
43
|
|
|
43
44
|
```ruby
|
|
44
45
|
begin
|
|
@@ -46,7 +47,7 @@ begin
|
|
|
46
47
|
data, status_code, headers = api_instance.generate_url_with_http_info(generate_url_request)
|
|
47
48
|
p status_code # => 2xx
|
|
48
49
|
p headers # => { ... }
|
|
49
|
-
p data # =>
|
|
50
|
+
p data # => <V1EntitiesPresignedUrlResult>
|
|
50
51
|
rescue DealMakerAPI::ApiError => e
|
|
51
52
|
puts "Error when calling UploadApi->generate_url_with_http_info: #{e}"
|
|
52
53
|
end
|
|
@@ -60,7 +61,7 @@ end
|
|
|
60
61
|
|
|
61
62
|
### Return type
|
|
62
63
|
|
|
63
|
-
|
|
64
|
+
[**V1EntitiesPresignedUrlResult**](V1EntitiesPresignedUrlResult.md)
|
|
64
65
|
|
|
65
66
|
### Authorization
|
|
66
67
|
|
|
@@ -69,5 +70,5 @@ No authorization required
|
|
|
69
70
|
### HTTP request headers
|
|
70
71
|
|
|
71
72
|
- **Content-Type**: application/json
|
|
72
|
-
- **Accept**:
|
|
73
|
+
- **Accept**: application/json
|
|
73
74
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# DealMakerAPI::V1EntitiesBulkUploadDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | The ID for the bulk upload detail | [optional] |
|
|
8
|
+
| **bulk_upload_id** | **Integer** | The bulk upload ID | [optional] |
|
|
9
|
+
| **file_key** | **String** | The generated identifier for the file | [optional] |
|
|
10
|
+
| **file_name** | **String** | The name of the file | [optional] |
|
|
11
|
+
| **status** | **Integer** | The status of the bulk upload detail | [optional] |
|
|
12
|
+
| **created_at** | **String** | The created at date | [optional] |
|
|
13
|
+
| **updated_at** | **String** | The updated at date | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'DealMakerAPI'
|
|
19
|
+
|
|
20
|
+
instance = DealMakerAPI::V1EntitiesBulkUploadDetail.new(
|
|
21
|
+
id: null,
|
|
22
|
+
bulk_upload_id: null,
|
|
23
|
+
file_key: null,
|
|
24
|
+
file_name: null,
|
|
25
|
+
status: null,
|
|
26
|
+
created_at: null,
|
|
27
|
+
updated_at: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DealMakerAPI::V1EntitiesPresignedUrlResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_key** | **String** | The file UUID generated value. | [optional] |
|
|
8
|
+
| **presigned_url** | **String** | A pre-signed url by aws for interacting with a S3 bucket. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'DealMakerAPI'
|
|
14
|
+
|
|
15
|
+
instance = DealMakerAPI::V1EntitiesPresignedUrlResult.new(
|
|
16
|
+
file_key: null,
|
|
17
|
+
presigned_url: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -93,6 +93,86 @@ module DealMakerAPI
|
|
|
93
93
|
return data, status_code, headers
|
|
94
94
|
end
|
|
95
95
|
|
|
96
|
+
# Create a BulkUploadDetail class record
|
|
97
|
+
# Create a BulkUploadDetail class record
|
|
98
|
+
# @param bulk_upload_id [String] The Bulk upload ID from which detail is associated with
|
|
99
|
+
# @param company_id [Integer]
|
|
100
|
+
# @param create_bulk_upload_detail_request [CreateBulkUploadDetailRequest]
|
|
101
|
+
# @param [Hash] opts the optional parameters
|
|
102
|
+
# @return [V1EntitiesBulkUploadDetail]
|
|
103
|
+
def create_bulk_upload_detail(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts = {})
|
|
104
|
+
data, _status_code, _headers = create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts)
|
|
105
|
+
data
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Create a BulkUploadDetail class record
|
|
109
|
+
# Create a BulkUploadDetail class record
|
|
110
|
+
# @param bulk_upload_id [String] The Bulk upload ID from which detail is associated with
|
|
111
|
+
# @param company_id [Integer]
|
|
112
|
+
# @param create_bulk_upload_detail_request [CreateBulkUploadDetailRequest]
|
|
113
|
+
# @param [Hash] opts the optional parameters
|
|
114
|
+
# @return [Array<(V1EntitiesBulkUploadDetail, Integer, Hash)>] V1EntitiesBulkUploadDetail data, response status code and response headers
|
|
115
|
+
def create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts = {})
|
|
116
|
+
if @api_client.config.debugging
|
|
117
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.create_bulk_upload_detail ...'
|
|
118
|
+
end
|
|
119
|
+
# verify the required parameter 'bulk_upload_id' is set
|
|
120
|
+
if @api_client.config.client_side_validation && bulk_upload_id.nil?
|
|
121
|
+
fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.create_bulk_upload_detail"
|
|
122
|
+
end
|
|
123
|
+
# verify the required parameter 'company_id' is set
|
|
124
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
|
125
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.create_bulk_upload_detail"
|
|
126
|
+
end
|
|
127
|
+
# verify the required parameter 'create_bulk_upload_detail_request' is set
|
|
128
|
+
if @api_client.config.client_side_validation && create_bulk_upload_detail_request.nil?
|
|
129
|
+
fail ArgumentError, "Missing the required parameter 'create_bulk_upload_detail_request' when calling CompanyApi.create_bulk_upload_detail"
|
|
130
|
+
end
|
|
131
|
+
# resource path
|
|
132
|
+
local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details'.sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_id.to_s)).sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))
|
|
133
|
+
|
|
134
|
+
# query parameters
|
|
135
|
+
query_params = opts[:query_params] || {}
|
|
136
|
+
|
|
137
|
+
# header parameters
|
|
138
|
+
header_params = opts[:header_params] || {}
|
|
139
|
+
# HTTP header 'Accept' (if needed)
|
|
140
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
141
|
+
# HTTP header 'Content-Type'
|
|
142
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
143
|
+
if !content_type.nil?
|
|
144
|
+
header_params['Content-Type'] = content_type
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# form parameters
|
|
148
|
+
form_params = opts[:form_params] || {}
|
|
149
|
+
|
|
150
|
+
# http body (model)
|
|
151
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_bulk_upload_detail_request)
|
|
152
|
+
|
|
153
|
+
# return_type
|
|
154
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUploadDetail'
|
|
155
|
+
|
|
156
|
+
# auth_names
|
|
157
|
+
auth_names = opts[:debug_auth_names] || []
|
|
158
|
+
|
|
159
|
+
new_options = opts.merge(
|
|
160
|
+
:operation => :"CompanyApi.create_bulk_upload_detail",
|
|
161
|
+
:header_params => header_params,
|
|
162
|
+
:query_params => query_params,
|
|
163
|
+
:form_params => form_params,
|
|
164
|
+
:body => post_body,
|
|
165
|
+
:auth_names => auth_names,
|
|
166
|
+
:return_type => return_type
|
|
167
|
+
)
|
|
168
|
+
|
|
169
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
170
|
+
if @api_client.config.debugging
|
|
171
|
+
@api_client.config.logger.debug "API called: CompanyApi#create_bulk_upload_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
172
|
+
end
|
|
173
|
+
return data, status_code, headers
|
|
174
|
+
end
|
|
175
|
+
|
|
96
176
|
# Create new company
|
|
97
177
|
# Creates a new company.
|
|
98
178
|
# @param create_company_request [CreateCompanyRequest]
|