DealMakerAPI 0.84.1 → 0.85.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 +12 -6
- data/docs/BulkUploadInvestorsRequest.md +3 -1
- data/docs/CompanyApi.md +162 -14
- data/docs/CreateBulkUploadRequest.md +5 -1
- data/docs/CreateCorporationProfileRequest.md +2 -2
- data/docs/CreateShareholderActionRequest.md +20 -0
- data/docs/CreateTrustProfileRequest.md +2 -2
- data/docs/DealsApi.md +75 -0
- data/docs/InvestorProfileApi.md +6 -8
- data/docs/PatchCorporationProfileRequest.md +27 -1
- data/docs/PutDealsIdScriptTagEnvironmentRequest.md +18 -0
- data/docs/V1EntitiesBulkUpload.md +6 -0
- data/docs/V1EntitiesBulkUploadDetail.md +2 -0
- data/docs/V1EntitiesDealIssuer.md +3 -1
- data/docs/V1EntitiesGenericResponse.md +20 -0
- data/docs/V1EntitiesInvestor.md +1 -1
- data/lib/DealMakerAPI/api/company_api.rb +171 -13
- data/lib/DealMakerAPI/api/deals_api.rb +94 -0
- data/lib/DealMakerAPI/api/investor_profile_api.rb +10 -6
- data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +14 -4
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +38 -4
- data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +8 -8
- data/lib/DealMakerAPI/models/create_individual_profile_request.rb +2 -2
- data/lib/DealMakerAPI/models/create_joint_profile_request.rb +2 -2
- data/lib/DealMakerAPI/models/create_shareholder_action_request.rb +239 -0
- data/lib/DealMakerAPI/models/create_trust_profile_request.rb +8 -8
- data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +167 -4
- data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +2 -2
- data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +2 -2
- data/lib/DealMakerAPI/models/put_deals_id_script_tag_environment_request.rb +222 -0
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +31 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +11 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +14 -4
- data/lib/DealMakerAPI/models/v1_entities_generic_response.rb +226 -0
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +1 -1
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +4 -0
- data/spec/api/company_api_spec.rb +34 -4
- data/spec/api/deals_api_spec.rb +48 -0
- data/spec/api/investor_profile_api_spec.rb +1 -1
- data/spec/models/bulk_upload_investors_request_spec.rb +6 -0
- data/spec/models/create_bulk_upload_request_spec.rb +12 -0
- data/spec/models/create_corporation_profile_request_spec.rb +1 -1
- data/spec/models/create_individual_profile_request_spec.rb +1 -1
- data/spec/models/create_joint_profile_request_spec.rb +1 -1
- data/spec/models/create_shareholder_action_request_spec.rb +40 -0
- data/spec/models/create_trust_profile_request_spec.rb +1 -1
- data/spec/models/patch_corporation_profile_request_spec.rb +78 -0
- data/spec/models/patch_individual_profile_request_spec.rb +1 -1
- data/spec/models/patch_joint_profile_request_spec.rb +1 -1
- data/spec/models/put_deals_id_script_tag_environment_request_spec.rb +34 -0
- data/spec/models/v1_entities_bulk_upload_detail_spec.rb +6 -0
- data/spec/models/v1_entities_bulk_upload_spec.rb +18 -0
- data/spec/models/v1_entities_deal_issuer_spec.rb +6 -0
- data/spec/models/v1_entities_generic_response_spec.rb +40 -0
- metadata +80 -64
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cb37ad585e33d769b70459e36987626c1e9c00be5f396336aabd2dbc7ddb4e8d
|
4
|
+
data.tar.gz: c74756141f3f486d16ef845ba1ef180048ecc246965413f63c590d2bb9e211fc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1814189fc6909ceedfad3fae0122a7e8d410f7afa98e0f173b93c050c747e3df2629deb14d6b031b9dc82bed7ce9eb3513ef077d4351fadc92358df384b5d977
|
7
|
+
data.tar.gz: 9745cca984f31ee38e5bc47583afd17cfaf9df686748b3b0f77d6f264810fed5f8b5273c799d21edcfd67c0d381bea8868fd32de810a98442fede4aaf1ef3121
|
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.85.2
|
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.85.2.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.85.2.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.85.2'
|
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', upload_name: 'upload_name_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', send_notification: false, notification_message: 'notification_message_example'}) # CreateBulkUploadRequest |
|
396
396
|
|
397
397
|
begin
|
398
398
|
#Create bulk upload record
|
@@ -413,7 +413,9 @@ Class | Method | HTTP request | Description
|
|
413
413
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
|
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
|
-
*DealMakerAPI::CompanyApi* | [**
|
416
|
+
*DealMakerAPI::CompanyApi* | [**create_shareholder_action**](docs/CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action
|
417
|
+
*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
|
418
|
+
*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
|
417
419
|
*DealMakerAPI::CompanyApi* | [**get_bulk_uploads**](docs/CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads
|
418
420
|
*DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
|
419
421
|
*DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
|
@@ -422,6 +424,7 @@ Class | Method | HTTP request | Description
|
|
422
424
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
423
425
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
424
426
|
*DealMakerAPI::DealSetupApi* | [**create_deal_setup**](docs/DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
|
427
|
+
*DealMakerAPI::DealsApi* | [**put_deals_id_script_tag_environment**](docs/DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal.
|
425
428
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal
|
426
429
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_investors_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal
|
427
430
|
*DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
|
@@ -471,6 +474,7 @@ Class | Method | HTTP request | Description
|
|
471
474
|
- [DealMakerAPI::CreateIndividualProfileRequest](docs/CreateIndividualProfileRequest.md)
|
472
475
|
- [DealMakerAPI::CreateInvestorRequest](docs/CreateInvestorRequest.md)
|
473
476
|
- [DealMakerAPI::CreateJointProfileRequest](docs/CreateJointProfileRequest.md)
|
477
|
+
- [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
|
474
478
|
- [DealMakerAPI::CreateTrustProfileRequest](docs/CreateTrustProfileRequest.md)
|
475
479
|
- [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
|
476
480
|
- [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
|
@@ -480,6 +484,7 @@ Class | Method | HTTP request | Description
|
|
480
484
|
- [DealMakerAPI::PatchJointProfileRequest](docs/PatchJointProfileRequest.md)
|
481
485
|
- [DealMakerAPI::PatchTrustProfileRequest](docs/PatchTrustProfileRequest.md)
|
482
486
|
- [DealMakerAPI::PostWebhooksRequest](docs/PostWebhooksRequest.md)
|
487
|
+
- [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
|
483
488
|
- [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
|
484
489
|
- [DealMakerAPI::UpdateInvestorRequest](docs/UpdateInvestorRequest.md)
|
485
490
|
- [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
|
@@ -503,6 +508,7 @@ Class | Method | HTTP request | Description
|
|
503
508
|
- [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
|
504
509
|
- [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
|
505
510
|
- [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
|
511
|
+
- [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
|
506
512
|
- [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
|
507
513
|
- [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
|
508
514
|
- [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **import_file** | **File** | The CSV file with data to upload. | |
|
8
|
+
| **alerts_email** | **String** | The email to send alerts to. | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'DealMakerAPI'
|
13
14
|
|
14
15
|
instance = DealMakerAPI::BulkUploadInvestorsRequest.new(
|
15
|
-
import_file: null
|
16
|
+
import_file: null,
|
17
|
+
alerts_email: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/CompanyApi.md
CHANGED
@@ -7,7 +7,9 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
7
7
|
| [**create_bulk_upload**](CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record |
|
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_shareholder_action**](CompanyApi.md#create_shareholder_action) | **POST** /companies/{company_id}/shareholders/{shareholder_id}/actions | Create a shareholder action |
|
11
|
+
| [**get_bulk_upload**](CompanyApi.md#get_bulk_upload) | **GET** /companies/{id}/documents/bulk_uploads/{bulk_upload_id} | Return a given bulk upload by id |
|
12
|
+
| [**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 |
|
11
13
|
| [**get_bulk_uploads**](CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads |
|
12
14
|
| [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
|
13
15
|
| [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
|
@@ -32,7 +34,7 @@ DealMakerAPI.configure do |config|end
|
|
32
34
|
|
33
35
|
api_instance = DealMakerAPI::CompanyApi.new
|
34
36
|
id = 56 # Integer | The company id
|
35
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example'}) # CreateBulkUploadRequest |
|
37
|
+
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 |
|
36
38
|
|
37
39
|
begin
|
38
40
|
# Create bulk upload record
|
@@ -218,13 +220,159 @@ No authorization required
|
|
218
220
|
- **Accept**: application/json
|
219
221
|
|
220
222
|
|
221
|
-
##
|
223
|
+
## create_shareholder_action
|
222
224
|
|
223
|
-
> <
|
225
|
+
> <V1EntitiesGenericResponse> create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request)
|
224
226
|
|
225
|
-
|
227
|
+
Create a shareholder action
|
226
228
|
|
227
|
-
|
229
|
+
Create a shareholder action
|
230
|
+
|
231
|
+
### Examples
|
232
|
+
|
233
|
+
```ruby
|
234
|
+
require 'time'
|
235
|
+
require 'DealMakerAPI'
|
236
|
+
# setup authorization
|
237
|
+
DealMakerAPI.configure do |config|end
|
238
|
+
|
239
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
240
|
+
company_id = 56 # Integer | The company id
|
241
|
+
shareholder_id = 56 # Integer | The shareholder id
|
242
|
+
create_shareholder_action_request = DealMakerAPI::CreateShareholderActionRequest.new({request_type: 'request_type_example', description: 'description_example'}) # CreateShareholderActionRequest |
|
243
|
+
|
244
|
+
begin
|
245
|
+
# Create a shareholder action
|
246
|
+
result = api_instance.create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request)
|
247
|
+
p result
|
248
|
+
rescue DealMakerAPI::ApiError => e
|
249
|
+
puts "Error when calling CompanyApi->create_shareholder_action: #{e}"
|
250
|
+
end
|
251
|
+
```
|
252
|
+
|
253
|
+
#### Using the create_shareholder_action_with_http_info variant
|
254
|
+
|
255
|
+
This returns an Array which contains the response data, status code and headers.
|
256
|
+
|
257
|
+
> <Array(<V1EntitiesGenericResponse>, Integer, Hash)> create_shareholder_action_with_http_info(company_id, shareholder_id, create_shareholder_action_request)
|
258
|
+
|
259
|
+
```ruby
|
260
|
+
begin
|
261
|
+
# Create a shareholder action
|
262
|
+
data, status_code, headers = api_instance.create_shareholder_action_with_http_info(company_id, shareholder_id, create_shareholder_action_request)
|
263
|
+
p status_code # => 2xx
|
264
|
+
p headers # => { ... }
|
265
|
+
p data # => <V1EntitiesGenericResponse>
|
266
|
+
rescue DealMakerAPI::ApiError => e
|
267
|
+
puts "Error when calling CompanyApi->create_shareholder_action_with_http_info: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
### Parameters
|
272
|
+
|
273
|
+
| Name | Type | Description | Notes |
|
274
|
+
| ---- | ---- | ----------- | ----- |
|
275
|
+
| **company_id** | **Integer** | The company id | |
|
276
|
+
| **shareholder_id** | **Integer** | The shareholder id | |
|
277
|
+
| **create_shareholder_action_request** | [**CreateShareholderActionRequest**](CreateShareholderActionRequest.md) | | |
|
278
|
+
|
279
|
+
### Return type
|
280
|
+
|
281
|
+
[**V1EntitiesGenericResponse**](V1EntitiesGenericResponse.md)
|
282
|
+
|
283
|
+
### Authorization
|
284
|
+
|
285
|
+
No authorization required
|
286
|
+
|
287
|
+
### HTTP request headers
|
288
|
+
|
289
|
+
- **Content-Type**: application/json
|
290
|
+
- **Accept**: application/json
|
291
|
+
|
292
|
+
|
293
|
+
## get_bulk_upload
|
294
|
+
|
295
|
+
> <V1EntitiesBulkUpload> get_bulk_upload(id, bulk_upload_id, opts)
|
296
|
+
|
297
|
+
Return a given bulk upload by id
|
298
|
+
|
299
|
+
Return a given bulk upload by id
|
300
|
+
|
301
|
+
### Examples
|
302
|
+
|
303
|
+
```ruby
|
304
|
+
require 'time'
|
305
|
+
require 'DealMakerAPI'
|
306
|
+
# setup authorization
|
307
|
+
DealMakerAPI.configure do |config|end
|
308
|
+
|
309
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
310
|
+
id = 56 # Integer |
|
311
|
+
bulk_upload_id = 56 # Integer |
|
312
|
+
opts = {
|
313
|
+
page: 56, # Integer | Page offset to fetch.
|
314
|
+
per_page: 56, # Integer | Number of results to return per page.
|
315
|
+
offset: 56 # Integer | Pad a number of results.
|
316
|
+
}
|
317
|
+
|
318
|
+
begin
|
319
|
+
# Return a given bulk upload by id
|
320
|
+
result = api_instance.get_bulk_upload(id, bulk_upload_id, opts)
|
321
|
+
p result
|
322
|
+
rescue DealMakerAPI::ApiError => e
|
323
|
+
puts "Error when calling CompanyApi->get_bulk_upload: #{e}"
|
324
|
+
end
|
325
|
+
```
|
326
|
+
|
327
|
+
#### Using the get_bulk_upload_with_http_info variant
|
328
|
+
|
329
|
+
This returns an Array which contains the response data, status code and headers.
|
330
|
+
|
331
|
+
> <Array(<V1EntitiesBulkUpload>, Integer, Hash)> get_bulk_upload_with_http_info(id, bulk_upload_id, opts)
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
begin
|
335
|
+
# Return a given bulk upload by id
|
336
|
+
data, status_code, headers = api_instance.get_bulk_upload_with_http_info(id, bulk_upload_id, opts)
|
337
|
+
p status_code # => 2xx
|
338
|
+
p headers # => { ... }
|
339
|
+
p data # => <V1EntitiesBulkUpload>
|
340
|
+
rescue DealMakerAPI::ApiError => e
|
341
|
+
puts "Error when calling CompanyApi->get_bulk_upload_with_http_info: #{e}"
|
342
|
+
end
|
343
|
+
```
|
344
|
+
|
345
|
+
### Parameters
|
346
|
+
|
347
|
+
| Name | Type | Description | Notes |
|
348
|
+
| ---- | ---- | ----------- | ----- |
|
349
|
+
| **id** | **Integer** | | |
|
350
|
+
| **bulk_upload_id** | **Integer** | | |
|
351
|
+
| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
|
352
|
+
| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
|
353
|
+
| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
|
354
|
+
|
355
|
+
### Return type
|
356
|
+
|
357
|
+
[**V1EntitiesBulkUpload**](V1EntitiesBulkUpload.md)
|
358
|
+
|
359
|
+
### Authorization
|
360
|
+
|
361
|
+
No authorization required
|
362
|
+
|
363
|
+
### HTTP request headers
|
364
|
+
|
365
|
+
- **Content-Type**: Not defined
|
366
|
+
- **Accept**: application/json
|
367
|
+
|
368
|
+
|
369
|
+
## get_bulk_upload_details_errors
|
370
|
+
|
371
|
+
> <V1EntitiesBulkUploadDetails> get_bulk_upload_details_errors(company_id, bulk_upload_id)
|
372
|
+
|
373
|
+
Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc
|
374
|
+
|
375
|
+
Returns a full list of details with errors of the given bulk upload
|
228
376
|
|
229
377
|
### Examples
|
230
378
|
|
@@ -239,29 +387,29 @@ company_id = 56 # Integer |
|
|
239
387
|
bulk_upload_id = 56 # Integer |
|
240
388
|
|
241
389
|
begin
|
242
|
-
#
|
243
|
-
result = api_instance.
|
390
|
+
# Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc
|
391
|
+
result = api_instance.get_bulk_upload_details_errors(company_id, bulk_upload_id)
|
244
392
|
p result
|
245
393
|
rescue DealMakerAPI::ApiError => e
|
246
|
-
puts "Error when calling CompanyApi->
|
394
|
+
puts "Error when calling CompanyApi->get_bulk_upload_details_errors: #{e}"
|
247
395
|
end
|
248
396
|
```
|
249
397
|
|
250
|
-
#### Using the
|
398
|
+
#### Using the get_bulk_upload_details_errors_with_http_info variant
|
251
399
|
|
252
400
|
This returns an Array which contains the response data, status code and headers.
|
253
401
|
|
254
|
-
> <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)>
|
402
|
+
> <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_errors_with_http_info(company_id, bulk_upload_id)
|
255
403
|
|
256
404
|
```ruby
|
257
405
|
begin
|
258
|
-
#
|
259
|
-
data, status_code, headers = api_instance.
|
406
|
+
# Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc
|
407
|
+
data, status_code, headers = api_instance.get_bulk_upload_details_errors_with_http_info(company_id, bulk_upload_id)
|
260
408
|
p status_code # => 2xx
|
261
409
|
p headers # => { ... }
|
262
410
|
p data # => <V1EntitiesBulkUploadDetails>
|
263
411
|
rescue DealMakerAPI::ApiError => e
|
264
|
-
puts "Error when calling CompanyApi->
|
412
|
+
puts "Error when calling CompanyApi->get_bulk_upload_details_errors_with_http_info: #{e}"
|
265
413
|
end
|
266
414
|
```
|
267
415
|
|
@@ -7,6 +7,8 @@
|
|
7
7
|
| **file_identifier** | **String** | The file identifier | |
|
8
8
|
| **document_type** | **String** | The document type | |
|
9
9
|
| **upload_name** | **String** | The bulk upload name | |
|
10
|
+
| **send_notification** | **Boolean** | Send notification to the user | |
|
11
|
+
| **notification_message** | **String** | Notification message | |
|
10
12
|
|
11
13
|
## Example
|
12
14
|
|
@@ -16,7 +18,9 @@ require 'DealMakerAPI'
|
|
16
18
|
instance = DealMakerAPI::CreateBulkUploadRequest.new(
|
17
19
|
file_identifier: null,
|
18
20
|
document_type: null,
|
19
|
-
upload_name: null
|
21
|
+
upload_name: null,
|
22
|
+
send_notification: null,
|
23
|
+
notification_message: null
|
20
24
|
)
|
21
25
|
```
|
22
26
|
|
@@ -35,7 +35,7 @@
|
|
35
35
|
| **beneficial_owners_suffix** | **Array<String>** | The list of suffixes for the beneficial owners. | [optional] |
|
36
36
|
| **beneficial_owners_country** | **Array<String>** | The list of countries for the beneficial owners (required for beneficial owner 1). | [optional] |
|
37
37
|
| **beneficial_owners_street_address** | **Array<String>** | The list of street addresses for the beneficial owners (required for beneficial owner 1). | [optional] |
|
38
|
-
| **
|
38
|
+
| **beneficial_owners_unit2** | **Array<String>** | The list of street address line 2 for the beneficial owners. | [optional] |
|
39
39
|
| **beneficial_owners_city** | **Array<String>** | The list of cities for the beneficial owners (required for beneficial owner 1). | [optional] |
|
40
40
|
| **beneficial_owners_region** | **Array<String>** | The list of region or states for the beneficial owners (required for beneficial owner 1). | [optional] |
|
41
41
|
| **beneficial_owners_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the beneficial owners (required for beneficial owner 1). | [optional] |
|
@@ -79,7 +79,7 @@ instance = DealMakerAPI::CreateCorporationProfileRequest.new(
|
|
79
79
|
beneficial_owners_suffix: null,
|
80
80
|
beneficial_owners_country: null,
|
81
81
|
beneficial_owners_street_address: null,
|
82
|
-
|
82
|
+
beneficial_owners_unit2: null,
|
83
83
|
beneficial_owners_city: null,
|
84
84
|
beneficial_owners_region: null,
|
85
85
|
beneficial_owners_postal_code: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::CreateShareholderActionRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **request_type** | **String** | The request type of the shareholder action | |
|
8
|
+
| **description** | **String** | The description of the shareholder action | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::CreateShareholderActionRequest.new(
|
16
|
+
request_type: null,
|
17
|
+
description: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -24,7 +24,7 @@
|
|
24
24
|
| **trustees_suffix** | **Array<String>** | The list of suffixes for the trustees. | [optional] |
|
25
25
|
| **trustees_country** | **Array<String>** | The list of countries for the trustees (required for trustee 1). | [optional] |
|
26
26
|
| **trustees_street_address** | **Array<String>** | The list of street addresses for the trustees (required for trustee 1). | [optional] |
|
27
|
-
| **
|
27
|
+
| **trustees_unit2** | **Array<String>** | The list of street address line 2 for the trustees. | [optional] |
|
28
28
|
| **trustees_city** | **Array<String>** | The list of cities for the trustees (required for trustee 1). | [optional] |
|
29
29
|
| **trustees_region** | **Array<String>** | The list of regions or states for the trustees (required for trustee 1). | [optional] |
|
30
30
|
| **trustees_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the trustees (required) for trustee 1. | [optional] |
|
@@ -57,7 +57,7 @@ instance = DealMakerAPI::CreateTrustProfileRequest.new(
|
|
57
57
|
trustees_suffix: null,
|
58
58
|
trustees_country: null,
|
59
59
|
trustees_street_address: null,
|
60
|
-
|
60
|
+
trustees_unit2: null,
|
61
61
|
trustees_city: null,
|
62
62
|
trustees_region: null,
|
63
63
|
trustees_postal_code: null,
|
data/docs/DealsApi.md
ADDED
@@ -0,0 +1,75 @@
|
|
1
|
+
# DealMakerAPI::DealsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**put_deals_id_script_tag_environment**](DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal. |
|
8
|
+
|
9
|
+
|
10
|
+
## put_deals_id_script_tag_environment
|
11
|
+
|
12
|
+
> put_deals_id_script_tag_environment(id, put_deals_id_script_tag_environment_request)
|
13
|
+
|
14
|
+
Update script tag environment for the deal.
|
15
|
+
|
16
|
+
Update script tag environment for the deal.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'DealMakerAPI'
|
23
|
+
# setup authorization
|
24
|
+
DealMakerAPI.configure do |config|end
|
25
|
+
|
26
|
+
api_instance = DealMakerAPI::DealsApi.new
|
27
|
+
id = 56 # Integer | The deal id.
|
28
|
+
put_deals_id_script_tag_environment_request = DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest.new({is_production: false}) # PutDealsIdScriptTagEnvironmentRequest |
|
29
|
+
|
30
|
+
begin
|
31
|
+
# Update script tag environment for the deal.
|
32
|
+
api_instance.put_deals_id_script_tag_environment(id, put_deals_id_script_tag_environment_request)
|
33
|
+
rescue DealMakerAPI::ApiError => e
|
34
|
+
puts "Error when calling DealsApi->put_deals_id_script_tag_environment: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the put_deals_id_script_tag_environment_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
41
|
+
|
42
|
+
> <Array(nil, Integer, Hash)> put_deals_id_script_tag_environment_with_http_info(id, put_deals_id_script_tag_environment_request)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
# Update script tag environment for the deal.
|
47
|
+
data, status_code, headers = api_instance.put_deals_id_script_tag_environment_with_http_info(id, put_deals_id_script_tag_environment_request)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => nil
|
51
|
+
rescue DealMakerAPI::ApiError => e
|
52
|
+
puts "Error when calling DealsApi->put_deals_id_script_tag_environment_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **id** | **Integer** | The deal id. | |
|
61
|
+
| **put_deals_id_script_tag_environment_request** | [**PutDealsIdScriptTagEnvironmentRequest**](PutDealsIdScriptTagEnvironmentRequest.md) | | |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
nil (empty response body)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json
|
74
|
+
- **Accept**: Not defined
|
75
|
+
|
data/docs/InvestorProfileApi.md
CHANGED
@@ -497,7 +497,7 @@ No authorization required
|
|
497
497
|
|
498
498
|
## patch_corporation_profile
|
499
499
|
|
500
|
-
> <V1EntitiesInvestorProfileCorporation> patch_corporation_profile(investor_profile_id,
|
500
|
+
> <V1EntitiesInvestorProfileCorporation> patch_corporation_profile(investor_profile_id, patch_corporation_profile_request)
|
501
501
|
|
502
502
|
Patch a corporation investor profile
|
503
503
|
|
@@ -513,13 +513,11 @@ DealMakerAPI.configure do |config|end
|
|
513
513
|
|
514
514
|
api_instance = DealMakerAPI::InvestorProfileApi.new
|
515
515
|
investor_profile_id = 56 # Integer |
|
516
|
-
|
517
|
-
patch_corporation_profile_request: DealMakerAPI::PatchCorporationProfileRequest.new # PatchCorporationProfileRequest |
|
518
|
-
}
|
516
|
+
patch_corporation_profile_request = DealMakerAPI::PatchCorporationProfileRequest.new({beneficial_owners_index: [37]}) # PatchCorporationProfileRequest |
|
519
517
|
|
520
518
|
begin
|
521
519
|
# Patch a corporation investor profile
|
522
|
-
result = api_instance.patch_corporation_profile(investor_profile_id,
|
520
|
+
result = api_instance.patch_corporation_profile(investor_profile_id, patch_corporation_profile_request)
|
523
521
|
p result
|
524
522
|
rescue DealMakerAPI::ApiError => e
|
525
523
|
puts "Error when calling InvestorProfileApi->patch_corporation_profile: #{e}"
|
@@ -530,12 +528,12 @@ end
|
|
530
528
|
|
531
529
|
This returns an Array which contains the response data, status code and headers.
|
532
530
|
|
533
|
-
> <Array(<V1EntitiesInvestorProfileCorporation>, Integer, Hash)> patch_corporation_profile_with_http_info(investor_profile_id,
|
531
|
+
> <Array(<V1EntitiesInvestorProfileCorporation>, Integer, Hash)> patch_corporation_profile_with_http_info(investor_profile_id, patch_corporation_profile_request)
|
534
532
|
|
535
533
|
```ruby
|
536
534
|
begin
|
537
535
|
# Patch a corporation investor profile
|
538
|
-
data, status_code, headers = api_instance.patch_corporation_profile_with_http_info(investor_profile_id,
|
536
|
+
data, status_code, headers = api_instance.patch_corporation_profile_with_http_info(investor_profile_id, patch_corporation_profile_request)
|
539
537
|
p status_code # => 2xx
|
540
538
|
p headers # => { ... }
|
541
539
|
p data # => <V1EntitiesInvestorProfileCorporation>
|
@@ -549,7 +547,7 @@ end
|
|
549
547
|
| Name | Type | Description | Notes |
|
550
548
|
| ---- | ---- | ----------- | ----- |
|
551
549
|
| **investor_profile_id** | **Integer** | | |
|
552
|
-
| **patch_corporation_profile_request** | [**PatchCorporationProfileRequest**](PatchCorporationProfileRequest.md) | |
|
550
|
+
| **patch_corporation_profile_request** | [**PatchCorporationProfileRequest**](PatchCorporationProfileRequest.md) | | |
|
553
551
|
|
554
552
|
### Return type
|
555
553
|
|
@@ -29,6 +29,19 @@
|
|
29
29
|
| **signing_officer_postal_code** | **String** | Signing officer postal code or zipcode. | [optional] |
|
30
30
|
| **signing_officer_date_of_birth** | **String** | Signing officer date of birth. | [optional] |
|
31
31
|
| **signing_officer_taxpayer_id** | **String** | The taxpayer identification number of the investor profile. | [optional] |
|
32
|
+
| **beneficial_owners_index** | **Array<Integer>** | The index of the beneficial owner. | |
|
33
|
+
| **beneficial_owners__delete** | **Array<Boolean>** | If true, this entry will be cleared. | [optional] |
|
34
|
+
| **beneficial_owners_first_name** | **Array<String>** | The list of first names for the beneficial owners (required for beneficial owner 1). | [optional] |
|
35
|
+
| **beneficial_owners_last_name** | **Array<String>** | The list of last names for the beneficial owners (required for beneficial owner 1). | [optional] |
|
36
|
+
| **beneficial_owners_suffix** | **Array<String>** | The list of suffixes for the beneficial owners. | [optional] |
|
37
|
+
| **beneficial_owners_country** | **Array<String>** | The list of countries for the beneficial owners (required for beneficial owner 1). | [optional] |
|
38
|
+
| **beneficial_owners_street_address** | **Array<String>** | The list of street addresses for the beneficial owners (required for beneficial owner 1). | [optional] |
|
39
|
+
| **beneficial_owners_unit2** | **Array<String>** | The list of street address line 2 for the beneficial owners. | [optional] |
|
40
|
+
| **beneficial_owners_city** | **Array<String>** | The list of cities for the beneficial owners (required for beneficial owner 1). | [optional] |
|
41
|
+
| **beneficial_owners_region** | **Array<String>** | The list of region or states for the beneficial owners (required for beneficial owner 1). | [optional] |
|
42
|
+
| **beneficial_owners_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the beneficial owners (required for beneficial owner 1). | [optional] |
|
43
|
+
| **beneficial_owners_date_of_birth** | **Array<String>** | The list of dates of birth for the beneficial owners (required for beneficial owner 1). | [optional] |
|
44
|
+
| **beneficial_owners_taxpayer_id** | **Array<String>** | The list of taxpayer identification numbers for the beneficial owners (required for beneficial owner 1). | [optional] |
|
32
45
|
|
33
46
|
## Example
|
34
47
|
|
@@ -60,7 +73,20 @@ instance = DealMakerAPI::PatchCorporationProfileRequest.new(
|
|
60
73
|
signing_officer_region: null,
|
61
74
|
signing_officer_postal_code: null,
|
62
75
|
signing_officer_date_of_birth: null,
|
63
|
-
signing_officer_taxpayer_id: null
|
76
|
+
signing_officer_taxpayer_id: null,
|
77
|
+
beneficial_owners_index: null,
|
78
|
+
beneficial_owners__delete: null,
|
79
|
+
beneficial_owners_first_name: null,
|
80
|
+
beneficial_owners_last_name: null,
|
81
|
+
beneficial_owners_suffix: null,
|
82
|
+
beneficial_owners_country: null,
|
83
|
+
beneficial_owners_street_address: null,
|
84
|
+
beneficial_owners_unit2: null,
|
85
|
+
beneficial_owners_city: null,
|
86
|
+
beneficial_owners_region: null,
|
87
|
+
beneficial_owners_postal_code: null,
|
88
|
+
beneficial_owners_date_of_birth: null,
|
89
|
+
beneficial_owners_taxpayer_id: null
|
64
90
|
)
|
65
91
|
```
|
66
92
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **is_production** | **Boolean** | True if environment is production. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest.new(
|
15
|
+
is_production: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -9,6 +9,9 @@
|
|
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
11
|
| **upload_name** | **String** | The bulk upload name | [optional] |
|
12
|
+
| **files_count** | **Integer** | The number of files in the bulk upload | [optional] |
|
13
|
+
| **errors_count** | **Integer** | The number of errors in the bulk upload | [optional] |
|
14
|
+
| **success_count** | **Integer** | The number of succeeded files in the bulk upload | [optional] |
|
12
15
|
| **status** | **String** | The status [pending, processing, completed, failed] | [optional] |
|
13
16
|
| **created_at** | **String** | The created at timestamp | [optional] |
|
14
17
|
| **updated_at** | **String** | The updated at timestamp | [optional] |
|
@@ -24,6 +27,9 @@ instance = DealMakerAPI::V1EntitiesBulkUpload.new(
|
|
24
27
|
file_identifier: null,
|
25
28
|
document_type: null,
|
26
29
|
upload_name: null,
|
30
|
+
files_count: null,
|
31
|
+
errors_count: null,
|
32
|
+
success_count: null,
|
27
33
|
status: null,
|
28
34
|
created_at: null,
|
29
35
|
updated_at: null
|
@@ -9,6 +9,7 @@
|
|
9
9
|
| **file_key** | **String** | The generated identifier for the file | [optional] |
|
10
10
|
| **file_name** | **String** | The name of the file | [optional] |
|
11
11
|
| **status** | **Integer** | The status of the bulk upload detail | [optional] |
|
12
|
+
| **readable_status** | **String** | The readable status of the bulk upload detail | [optional] |
|
12
13
|
| **created_at** | **String** | The created at date | [optional] |
|
13
14
|
| **updated_at** | **String** | The updated at date | [optional] |
|
14
15
|
|
@@ -23,6 +24,7 @@ instance = DealMakerAPI::V1EntitiesBulkUploadDetail.new(
|
|
23
24
|
file_key: null,
|
24
25
|
file_name: null,
|
25
26
|
status: null,
|
27
|
+
readable_status: null,
|
26
28
|
created_at: null,
|
27
29
|
updated_at: null
|
28
30
|
)
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **Integer** | The issuer's unique id. | [optional] |
|
8
8
|
| **name** | **String** | The issuer name. | [optional] |
|
9
|
+
| **logo** | **String** | The issuer's logo. | [optional] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'DealMakerAPI'
|
|
14
15
|
|
15
16
|
instance = DealMakerAPI::V1EntitiesDealIssuer.new(
|
16
17
|
id: null,
|
17
|
-
name: null
|
18
|
+
name: null,
|
19
|
+
logo: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|