DealMakerAPI 0.81.2 → 0.82.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 +18 -8
- data/docs/CompanyApi.md +69 -0
- data/docs/CreateBulkUploadRequest.md +22 -0
- data/docs/DefaultApi.md +136 -0
- data/docs/GenerateUrlRequest.md +18 -0
- data/docs/UploadApi.md +73 -0
- data/docs/V1EntitiesBulkUpload.md +30 -0
- data/docs/V1EntitiesExpressWireInstruction.md +32 -0
- data/docs/V1EntitiesExpressWireInstructions.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +74 -0
- data/lib/DealMakerAPI/api/default_api.rb +132 -0
- data/lib/DealMakerAPI/api/upload_api.rb +88 -0
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +255 -0
- data/lib/DealMakerAPI/models/generate_url_request.rb +225 -0
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +281 -0
- data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +291 -0
- data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +220 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +6 -0
- data/spec/api/company_api_spec.rb +13 -0
- data/spec/api/default_api_spec.rb +25 -0
- data/spec/api/upload_api_spec.rb +47 -0
- data/spec/models/create_bulk_upload_request_spec.rb +46 -0
- data/spec/models/generate_url_request_spec.rb +34 -0
- data/spec/models/v1_entities_bulk_upload_spec.rb +70 -0
- data/spec/models/v1_entities_express_wire_instruction_spec.rb +76 -0
- data/spec/models/v1_entities_express_wire_instructions_spec.rb +34 -0
- metadata +74 -50
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 187ebf5b27b43537933d17db2b87f594aa7563f3134fe0b282e380cc57caf06b
|
4
|
+
data.tar.gz: 2792f0f75b1b527c5dd4393443c61db03729c0d7911bf886b164288abe4387ab
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c9979f28572407e8b1a1c7a5504514ba27a08573d84a613a185955334a4eb27f4737d14f28840a9e15084dbab647bd36d3a1a74fd088ed09e8b04e7c6c3539ca
|
7
|
+
data.tar.gz: e2564b46bf65c41ca32cd46bb679a1dc04a294f99f3f93c1bf16654042de1e2a7ec0d2ec0c9693a4f17f05914c456f3df86d8e8e941d7461ca4d217e7df649bf
|
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.82.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.82.1.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.82.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.82.1'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -391,14 +391,15 @@ require 'DealMakerAPI'
|
|
391
391
|
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: File.new('/path/to/some/file'), file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
395
396
|
|
396
397
|
begin
|
397
|
-
#Create
|
398
|
-
result = api_instance.
|
398
|
+
#Create bulk upload record
|
399
|
+
result = api_instance.create_bulk_upload(id, create_bulk_upload_request)
|
399
400
|
p result
|
400
401
|
rescue DealMakerAPI::ApiError => e
|
401
|
-
puts "Exception when calling CompanyApi->
|
402
|
+
puts "Exception when calling CompanyApi->create_bulk_upload: #{e}"
|
402
403
|
end
|
403
404
|
|
404
405
|
```
|
@@ -409,6 +410,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
409
410
|
|
410
411
|
Class | Method | HTTP request | Description
|
411
412
|
------------ | ------------- | ------------- | -------------
|
413
|
+
*DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
|
412
414
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
413
415
|
*DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
|
414
416
|
*DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
|
@@ -416,6 +418,8 @@ Class | Method | HTTP request | Description
|
|
416
418
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
417
419
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
418
420
|
*DealMakerAPI::DealSetupApi* | [**create_deal_setup**](docs/DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
|
421
|
+
*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
|
422
|
+
*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
|
419
423
|
*DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
|
420
424
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_deal_id**](docs/DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id
|
421
425
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_deals_search**](docs/DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user
|
@@ -444,11 +448,13 @@ Class | Method | HTTP request | Description
|
|
444
448
|
*DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
|
445
449
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
446
450
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
|
451
|
+
*DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
|
447
452
|
|
448
453
|
|
449
454
|
## Documentation for Models
|
450
455
|
|
451
456
|
- [DealMakerAPI::AddDocumentRequest](docs/AddDocumentRequest.md)
|
457
|
+
- [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
|
452
458
|
- [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
453
459
|
- [DealMakerAPI::CreateCorporationProfileRequest](docs/CreateCorporationProfileRequest.md)
|
454
460
|
- [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
|
@@ -457,6 +463,7 @@ Class | Method | HTTP request | Description
|
|
457
463
|
- [DealMakerAPI::CreateJointProfileRequest](docs/CreateJointProfileRequest.md)
|
458
464
|
- [DealMakerAPI::CreateTrustProfileRequest](docs/CreateTrustProfileRequest.md)
|
459
465
|
- [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
|
466
|
+
- [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
|
460
467
|
- [DealMakerAPI::PatchCorporationProfileRequest](docs/PatchCorporationProfileRequest.md)
|
461
468
|
- [DealMakerAPI::PatchIndividualProfileRequest](docs/PatchIndividualProfileRequest.md)
|
462
469
|
- [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
|
@@ -469,6 +476,7 @@ Class | Method | HTTP request | Description
|
|
469
476
|
- [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
|
470
477
|
- [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
|
471
478
|
- [DealMakerAPI::V1EntitiesBackgroundCheckSearch](docs/V1EntitiesBackgroundCheckSearch.md)
|
479
|
+
- [DealMakerAPI::V1EntitiesBulkUpload](docs/V1EntitiesBulkUpload.md)
|
472
480
|
- [DealMakerAPI::V1EntitiesCompany](docs/V1EntitiesCompany.md)
|
473
481
|
- [DealMakerAPI::V1EntitiesCompanyDeal](docs/V1EntitiesCompanyDeal.md)
|
474
482
|
- [DealMakerAPI::V1EntitiesCompanyDeals](docs/V1EntitiesCompanyDeals.md)
|
@@ -480,6 +488,8 @@ Class | Method | HTTP request | Description
|
|
480
488
|
- [DealMakerAPI::V1EntitiesDealSetup](docs/V1EntitiesDealSetup.md)
|
481
489
|
- [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
|
482
490
|
- [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
|
491
|
+
- [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
|
492
|
+
- [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
|
483
493
|
- [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
|
484
494
|
- [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
|
485
495
|
- [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
|
data/docs/CompanyApi.md
CHANGED
@@ -4,11 +4,80 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_bulk_upload**](CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record |
|
7
8
|
| [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
|
8
9
|
| [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
|
9
10
|
| [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
|
10
11
|
|
11
12
|
|
13
|
+
## create_bulk_upload
|
14
|
+
|
15
|
+
> <V1EntitiesBulkUpload> create_bulk_upload(id, create_bulk_upload_request)
|
16
|
+
|
17
|
+
Create bulk upload record
|
18
|
+
|
19
|
+
Create bulk upload record
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'DealMakerAPI'
|
26
|
+
# setup authorization
|
27
|
+
DealMakerAPI.configure do |config|end
|
28
|
+
|
29
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
30
|
+
id = 56 # Integer | The company id
|
31
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file: File.new('/path/to/some/file'), file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Create bulk upload record
|
35
|
+
result = api_instance.create_bulk_upload(id, create_bulk_upload_request)
|
36
|
+
p result
|
37
|
+
rescue DealMakerAPI::ApiError => e
|
38
|
+
puts "Error when calling CompanyApi->create_bulk_upload: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the create_bulk_upload_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<V1EntitiesBulkUpload>, Integer, Hash)> create_bulk_upload_with_http_info(id, create_bulk_upload_request)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Create bulk upload record
|
51
|
+
data, status_code, headers = api_instance.create_bulk_upload_with_http_info(id, create_bulk_upload_request)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <V1EntitiesBulkUpload>
|
55
|
+
rescue DealMakerAPI::ApiError => e
|
56
|
+
puts "Error when calling CompanyApi->create_bulk_upload_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **id** | **Integer** | The company id | |
|
65
|
+
| **create_bulk_upload_request** | [**CreateBulkUploadRequest**](CreateBulkUploadRequest.md) | | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**V1EntitiesBulkUpload**](V1EntitiesBulkUpload.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
No authorization required
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: application/json
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
80
|
+
|
12
81
|
## create_company
|
13
82
|
|
14
83
|
> <V1EntitiesCompany> create_company(create_company_request)
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DealMakerAPI::CreateBulkUploadRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **file** | **File** | The ZIP file. | |
|
8
|
+
| **file_identifier** | **String** | The file identifier | |
|
9
|
+
| **document_type** | **String** | The document type | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'DealMakerAPI'
|
15
|
+
|
16
|
+
instance = DealMakerAPI::CreateBulkUploadRequest.new(
|
17
|
+
file: null,
|
18
|
+
file_identifier: null,
|
19
|
+
document_type: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/DefaultApi.md
CHANGED
@@ -4,6 +4,8 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](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 |
|
8
|
+
| [**get_deals_id_investors_payments_express_wire_instructions**](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 |
|
7
9
|
| [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
|
8
10
|
| [**get_webhooks_deal_id**](DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id |
|
9
11
|
| [**get_webhooks_deals_search**](DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user |
|
@@ -12,6 +14,140 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
12
14
|
| [**put_webhooks_id**](DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals |
|
13
15
|
|
14
16
|
|
17
|
+
## get_deals_id_investors_investor_id_payments_express_wire_instructions
|
18
|
+
|
19
|
+
> <V1EntitiesExpressWireInstruction> get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id)
|
20
|
+
|
21
|
+
Displays the express wire instructions for an investor on a deal
|
22
|
+
|
23
|
+
Get express wire instructions
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'DealMakerAPI'
|
30
|
+
# setup authorization
|
31
|
+
DealMakerAPI.configure do |config|end
|
32
|
+
|
33
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
34
|
+
id = 56 # Integer |
|
35
|
+
investor_id = 56 # Integer |
|
36
|
+
|
37
|
+
begin
|
38
|
+
# Displays the express wire instructions for an investor on a deal
|
39
|
+
result = api_instance.get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id)
|
40
|
+
p result
|
41
|
+
rescue DealMakerAPI::ApiError => e
|
42
|
+
puts "Error when calling DefaultApi->get_deals_id_investors_investor_id_payments_express_wire_instructions: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
#### Using the get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
49
|
+
|
50
|
+
> <Array(<V1EntitiesExpressWireInstruction>, Integer, Hash)> get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info(id, investor_id)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# Displays the express wire instructions for an investor on a deal
|
55
|
+
data, status_code, headers = api_instance.get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info(id, investor_id)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => <V1EntitiesExpressWireInstruction>
|
59
|
+
rescue DealMakerAPI::ApiError => e
|
60
|
+
puts "Error when calling DefaultApi->get_deals_id_investors_investor_id_payments_express_wire_instructions_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **id** | **Integer** | | |
|
69
|
+
| **investor_id** | **Integer** | | |
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
[**V1EntitiesExpressWireInstruction**](V1EntitiesExpressWireInstruction.md)
|
74
|
+
|
75
|
+
### Authorization
|
76
|
+
|
77
|
+
No authorization required
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: Not defined
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
## get_deals_id_investors_payments_express_wire_instructions
|
86
|
+
|
87
|
+
> <V1EntitiesExpressWireInstructions> get_deals_id_investors_payments_express_wire_instructions(id)
|
88
|
+
|
89
|
+
Displays the express wire instructions for all the investors on a deal
|
90
|
+
|
91
|
+
Get list of express wire instructions
|
92
|
+
|
93
|
+
### Examples
|
94
|
+
|
95
|
+
```ruby
|
96
|
+
require 'time'
|
97
|
+
require 'DealMakerAPI'
|
98
|
+
# setup authorization
|
99
|
+
DealMakerAPI.configure do |config|end
|
100
|
+
|
101
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
102
|
+
id = 56 # Integer |
|
103
|
+
|
104
|
+
begin
|
105
|
+
# Displays the express wire instructions for all the investors on a deal
|
106
|
+
result = api_instance.get_deals_id_investors_payments_express_wire_instructions(id)
|
107
|
+
p result
|
108
|
+
rescue DealMakerAPI::ApiError => e
|
109
|
+
puts "Error when calling DefaultApi->get_deals_id_investors_payments_express_wire_instructions: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
#### Using the get_deals_id_investors_payments_express_wire_instructions_with_http_info variant
|
114
|
+
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
116
|
+
|
117
|
+
> <Array(<V1EntitiesExpressWireInstructions>, Integer, Hash)> get_deals_id_investors_payments_express_wire_instructions_with_http_info(id)
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
begin
|
121
|
+
# Displays the express wire instructions for all the investors on a deal
|
122
|
+
data, status_code, headers = api_instance.get_deals_id_investors_payments_express_wire_instructions_with_http_info(id)
|
123
|
+
p status_code # => 2xx
|
124
|
+
p headers # => { ... }
|
125
|
+
p data # => <V1EntitiesExpressWireInstructions>
|
126
|
+
rescue DealMakerAPI::ApiError => e
|
127
|
+
puts "Error when calling DefaultApi->get_deals_id_investors_payments_express_wire_instructions_with_http_info: #{e}"
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
### Parameters
|
132
|
+
|
133
|
+
| Name | Type | Description | Notes |
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
135
|
+
| **id** | **Integer** | | |
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
[**V1EntitiesExpressWireInstructions**](V1EntitiesExpressWireInstructions.md)
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
No authorization required
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: Not defined
|
148
|
+
- **Accept**: application/json
|
149
|
+
|
150
|
+
|
15
151
|
## get_webhooks
|
16
152
|
|
17
153
|
> <V1EntitiesWebhooksSubscription> get_webhooks(opts)
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::GenerateUrlRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **filename** | **String** | The name of the file to be uploaded to S3. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::GenerateUrlRequest.new(
|
15
|
+
filename: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/UploadApi.md
ADDED
@@ -0,0 +1,73 @@
|
|
1
|
+
# DealMakerAPI::UploadApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**generate_url**](UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3 |
|
8
|
+
|
9
|
+
|
10
|
+
## generate_url
|
11
|
+
|
12
|
+
> generate_url(generate_url_request)
|
13
|
+
|
14
|
+
Create a presigned URL for Amazon S3
|
15
|
+
|
16
|
+
Create a presigned URL for Amazon S3
|
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::UploadApi.new
|
27
|
+
generate_url_request = DealMakerAPI::GenerateUrlRequest.new({filename: 'filename_example'}) # GenerateUrlRequest |
|
28
|
+
|
29
|
+
begin
|
30
|
+
# Create a presigned URL for Amazon S3
|
31
|
+
api_instance.generate_url(generate_url_request)
|
32
|
+
rescue DealMakerAPI::ApiError => e
|
33
|
+
puts "Error when calling UploadApi->generate_url: #{e}"
|
34
|
+
end
|
35
|
+
```
|
36
|
+
|
37
|
+
#### Using the generate_url_with_http_info variant
|
38
|
+
|
39
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
40
|
+
|
41
|
+
> <Array(nil, Integer, Hash)> generate_url_with_http_info(generate_url_request)
|
42
|
+
|
43
|
+
```ruby
|
44
|
+
begin
|
45
|
+
# Create a presigned URL for Amazon S3
|
46
|
+
data, status_code, headers = api_instance.generate_url_with_http_info(generate_url_request)
|
47
|
+
p status_code # => 2xx
|
48
|
+
p headers # => { ... }
|
49
|
+
p data # => nil
|
50
|
+
rescue DealMakerAPI::ApiError => e
|
51
|
+
puts "Error when calling UploadApi->generate_url_with_http_info: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
| Name | Type | Description | Notes |
|
58
|
+
| ---- | ---- | ----------- | ----- |
|
59
|
+
| **generate_url_request** | [**GenerateUrlRequest**](GenerateUrlRequest.md) | | |
|
60
|
+
|
61
|
+
### Return type
|
62
|
+
|
63
|
+
nil (empty response body)
|
64
|
+
|
65
|
+
### Authorization
|
66
|
+
|
67
|
+
No authorization required
|
68
|
+
|
69
|
+
### HTTP request headers
|
70
|
+
|
71
|
+
- **Content-Type**: application/json
|
72
|
+
- **Accept**: Not defined
|
73
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesBulkUpload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The bulk upload ID | [optional] |
|
8
|
+
| **company_id** | **Integer** | The company ID | [optional] |
|
9
|
+
| **file_identifier** | **String** | The file identifier [shareholder, investor] | [optional] |
|
10
|
+
| **document_type** | **String** | The document type [drs_statement, shareholder_statement, book_entry_statement] | [optional] |
|
11
|
+
| **status** | **String** | The status [pending, processing, completed, failed] | [optional] |
|
12
|
+
| **created_at** | **String** | The created at timestamp | [optional] |
|
13
|
+
| **updated_at** | **String** | The updated at timestamp | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'DealMakerAPI'
|
19
|
+
|
20
|
+
instance = DealMakerAPI::V1EntitiesBulkUpload.new(
|
21
|
+
id: null,
|
22
|
+
company_id: null,
|
23
|
+
file_identifier: null,
|
24
|
+
document_type: null,
|
25
|
+
status: null,
|
26
|
+
created_at: null,
|
27
|
+
updated_at: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesExpressWireInstruction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **investor_id** | **String** | The id of the investor | [optional] |
|
8
|
+
| **bank_name** | **String** | Name of the bank for the payment | [optional] |
|
9
|
+
| **bank_address** | **String** | Address of the bank for the payment | [optional] |
|
10
|
+
| **beneficiary_address** | **String** | Address of the beneficiary for the payment | [optional] |
|
11
|
+
| **beneficiary_name** | **String** | Name of the beneficiary for the payment | [optional] |
|
12
|
+
| **account_number** | **String** | Account number for the payment | [optional] |
|
13
|
+
| **aba_routing** | **String** | Aba routing number for the payment | [optional] |
|
14
|
+
| **swift_code** | **String** | Swift code for the payment | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'DealMakerAPI'
|
20
|
+
|
21
|
+
instance = DealMakerAPI::V1EntitiesExpressWireInstruction.new(
|
22
|
+
investor_id: null,
|
23
|
+
bank_name: null,
|
24
|
+
bank_address: null,
|
25
|
+
beneficiary_address: null,
|
26
|
+
beneficiary_name: null,
|
27
|
+
account_number: null,
|
28
|
+
aba_routing: null,
|
29
|
+
swift_code: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesExpressWireInstructions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesExpressWireInstruction**](V1EntitiesExpressWireInstruction.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesExpressWireInstructions.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -19,6 +19,80 @@ module DealMakerAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Create bulk upload record
|
23
|
+
# Create bulk upload record
|
24
|
+
# @param id [Integer] The company id
|
25
|
+
# @param create_bulk_upload_request [CreateBulkUploadRequest]
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [V1EntitiesBulkUpload]
|
28
|
+
def create_bulk_upload(id, create_bulk_upload_request, opts = {})
|
29
|
+
data, _status_code, _headers = create_bulk_upload_with_http_info(id, create_bulk_upload_request, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Create bulk upload record
|
34
|
+
# Create bulk upload record
|
35
|
+
# @param id [Integer] The company id
|
36
|
+
# @param create_bulk_upload_request [CreateBulkUploadRequest]
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(V1EntitiesBulkUpload, Integer, Hash)>] V1EntitiesBulkUpload data, response status code and response headers
|
39
|
+
def create_bulk_upload_with_http_info(id, create_bulk_upload_request, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.create_bulk_upload ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'id' is set
|
44
|
+
if @api_client.config.client_side_validation && id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.create_bulk_upload"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'create_bulk_upload_request' is set
|
48
|
+
if @api_client.config.client_side_validation && create_bulk_upload_request.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'create_bulk_upload_request' when calling CompanyApi.create_bulk_upload"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/companies/{id}/documents/bulk_uploads'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
63
|
+
if !content_type.nil?
|
64
|
+
header_params['Content-Type'] = content_type
|
65
|
+
end
|
66
|
+
|
67
|
+
# form parameters
|
68
|
+
form_params = opts[:form_params] || {}
|
69
|
+
|
70
|
+
# http body (model)
|
71
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_bulk_upload_request)
|
72
|
+
|
73
|
+
# return_type
|
74
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUpload'
|
75
|
+
|
76
|
+
# auth_names
|
77
|
+
auth_names = opts[:debug_auth_names] || []
|
78
|
+
|
79
|
+
new_options = opts.merge(
|
80
|
+
:operation => :"CompanyApi.create_bulk_upload",
|
81
|
+
:header_params => header_params,
|
82
|
+
:query_params => query_params,
|
83
|
+
:form_params => form_params,
|
84
|
+
:body => post_body,
|
85
|
+
:auth_names => auth_names,
|
86
|
+
:return_type => return_type
|
87
|
+
)
|
88
|
+
|
89
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
90
|
+
if @api_client.config.debugging
|
91
|
+
@api_client.config.logger.debug "API called: CompanyApi#create_bulk_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
92
|
+
end
|
93
|
+
return data, status_code, headers
|
94
|
+
end
|
95
|
+
|
22
96
|
# Create new company
|
23
97
|
# Creates a new company.
|
24
98
|
# @param create_company_request [CreateCompanyRequest]
|