DealMakerAPI 0.81.3 → 0.83.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -8
  3. data/docs/Add506cDocumentRequest.md +20 -0
  4. data/docs/CompanyApi.md +140 -0
  5. data/docs/CreateBulkUploadDetailRequest.md +22 -0
  6. data/docs/CreateBulkUploadRequest.md +20 -0
  7. data/docs/DefaultApi.md +136 -0
  8. data/docs/GenerateUrlRequest.md +18 -0
  9. data/docs/InvestorApi.md +139 -0
  10. data/docs/UpdateInvestorRequest.md +3 -1
  11. data/docs/UploadApi.md +74 -0
  12. data/docs/V1EntitiesBulkUpload.md +30 -0
  13. data/docs/V1EntitiesBulkUploadDetail.md +30 -0
  14. data/docs/V1EntitiesExpressWireInstruction.md +32 -0
  15. data/docs/V1EntitiesExpressWireInstructions.md +18 -0
  16. data/docs/V1EntitiesPresignedUrlResult.md +20 -0
  17. data/lib/DealMakerAPI/api/company_api.rb +154 -0
  18. data/lib/DealMakerAPI/api/default_api.rb +132 -0
  19. data/lib/DealMakerAPI/api/investor_api.rb +147 -0
  20. data/lib/DealMakerAPI/api/upload_api.rb +90 -0
  21. data/lib/DealMakerAPI/models/add506c_document_request.rb +235 -0
  22. data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +250 -0
  23. data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +240 -0
  24. data/lib/DealMakerAPI/models/generate_url_request.rb +225 -0
  25. data/lib/DealMakerAPI/models/update_investor_request.rb +14 -4
  26. data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +281 -0
  27. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +281 -0
  28. data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +291 -0
  29. data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +220 -0
  30. data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +231 -0
  31. data/lib/DealMakerAPI/version.rb +1 -1
  32. data/lib/DealMakerAPI.rb +10 -0
  33. data/spec/api/company_api_spec.rb +27 -0
  34. data/spec/api/default_api_spec.rb +25 -0
  35. data/spec/api/investor_api_spec.rb +27 -0
  36. data/spec/api/upload_api_spec.rb +47 -0
  37. data/spec/models/add506c_document_request_spec.rb +40 -0
  38. data/spec/models/create_bulk_upload_detail_request_spec.rb +46 -0
  39. data/spec/models/create_bulk_upload_request_spec.rb +40 -0
  40. data/spec/models/generate_url_request_spec.rb +34 -0
  41. data/spec/models/update_investor_request_spec.rb +6 -0
  42. data/spec/models/v1_entities_bulk_upload_detail_spec.rb +70 -0
  43. data/spec/models/v1_entities_bulk_upload_spec.rb +70 -0
  44. data/spec/models/v1_entities_express_wire_instruction_spec.rb +76 -0
  45. data/spec/models/v1_entities_express_wire_instructions_spec.rb +34 -0
  46. data/spec/models/v1_entities_presigned_url_result_spec.rb +40 -0
  47. metadata +90 -50
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ed1ce4a5ea94640b6933b822a9f1d618100b333d824a45b2c0ccebb4b0bbcd4b
4
- data.tar.gz: c86247fb20553c88ac061d00605fd2631016f90aaea7ee4294e3fe5e7c95bb3f
3
+ metadata.gz: 9cbda96527d24da7071c8241944416a5911f0ba423c199ae1e1a9a6fad8da743
4
+ data.tar.gz: 9300f5c3f1542606931accf38e7234ba7ffc2e389c1159b871a839fd7e436d64
5
5
  SHA512:
6
- metadata.gz: 16befe2873296631d99403f04a75d444592824af94018f4e6b92d759f5bfd5192152fc65f868353a65a164fb042bc60692bcf5d5139b15ed3804374edcae886e
7
- data.tar.gz: aeb797d62dbdc71e4192ef62fc1021f05a62db8efdc4ed2b8911e0e208b6fb26632bee24427ebff4e97f0d709fe3ea565ef5e4c6826aac35a248ffd374c378a2
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.81.3
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.81.3.gem
357
+ gem install ./DealMakerAPI-0.83.0.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.81.3.gem` to install the development dependencies)
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.81.3'
366
+ gem 'DealMakerAPI', '~> 0.83.0'
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
- create_company_request = DealMakerAPI::CreateCompanyRequest.new({name: 'name_example', country: 'country_example', street: 'street_example', city: 'city_example', state: 'state_example', postal_code: 'postal_code_example'}) # CreateCompanyRequest |
394
+ id = 56 # Integer | The company id
395
+ create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
395
396
 
396
397
  begin
397
- #Create new company
398
- result = api_instance.create_company(create_company_request)
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->create_company: #{e}"
402
+ puts "Exception when calling CompanyApi->create_bulk_upload: #{e}"
402
403
  end
403
404
 
404
405
  ```
@@ -409,6 +410,8 @@ 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
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
412
415
  *DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
413
416
  *DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
414
417
  *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
@@ -416,15 +419,19 @@ Class | Method | HTTP request | Description
416
419
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
417
420
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
418
421
  *DealMakerAPI::DealSetupApi* | [**create_deal_setup**](docs/DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
422
+ *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
423
+ *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
424
  *DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
420
425
  *DealMakerAPI::DefaultApi* | [**get_webhooks_deal_id**](docs/DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id
421
426
  *DealMakerAPI::DefaultApi* | [**get_webhooks_deals_search**](docs/DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user
422
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
423
428
  *DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
424
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
425
431
  *DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
426
432
  *DealMakerAPI::InvestorApi* | [**create_investor**](docs/InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor
427
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.
428
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
429
436
  *DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
430
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
@@ -444,11 +451,15 @@ Class | Method | HTTP request | Description
444
451
  *DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
445
452
  *DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
446
453
  *DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
454
+ *DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
447
455
 
448
456
 
449
457
  ## Documentation for Models
450
458
 
459
+ - [DealMakerAPI::Add506cDocumentRequest](docs/Add506cDocumentRequest.md)
451
460
  - [DealMakerAPI::AddDocumentRequest](docs/AddDocumentRequest.md)
461
+ - [DealMakerAPI::CreateBulkUploadDetailRequest](docs/CreateBulkUploadDetailRequest.md)
462
+ - [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
452
463
  - [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
453
464
  - [DealMakerAPI::CreateCorporationProfileRequest](docs/CreateCorporationProfileRequest.md)
454
465
  - [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
@@ -457,6 +468,7 @@ Class | Method | HTTP request | Description
457
468
  - [DealMakerAPI::CreateJointProfileRequest](docs/CreateJointProfileRequest.md)
458
469
  - [DealMakerAPI::CreateTrustProfileRequest](docs/CreateTrustProfileRequest.md)
459
470
  - [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
471
+ - [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
460
472
  - [DealMakerAPI::PatchCorporationProfileRequest](docs/PatchCorporationProfileRequest.md)
461
473
  - [DealMakerAPI::PatchIndividualProfileRequest](docs/PatchIndividualProfileRequest.md)
462
474
  - [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
@@ -469,6 +481,8 @@ Class | Method | HTTP request | Description
469
481
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
470
482
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
471
483
  - [DealMakerAPI::V1EntitiesBackgroundCheckSearch](docs/V1EntitiesBackgroundCheckSearch.md)
484
+ - [DealMakerAPI::V1EntitiesBulkUpload](docs/V1EntitiesBulkUpload.md)
485
+ - [DealMakerAPI::V1EntitiesBulkUploadDetail](docs/V1EntitiesBulkUploadDetail.md)
472
486
  - [DealMakerAPI::V1EntitiesCompany](docs/V1EntitiesCompany.md)
473
487
  - [DealMakerAPI::V1EntitiesCompanyDeal](docs/V1EntitiesCompanyDeal.md)
474
488
  - [DealMakerAPI::V1EntitiesCompanyDeals](docs/V1EntitiesCompanyDeals.md)
@@ -480,6 +494,8 @@ Class | Method | HTTP request | Description
480
494
  - [DealMakerAPI::V1EntitiesDealSetup](docs/V1EntitiesDealSetup.md)
481
495
  - [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
482
496
  - [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
497
+ - [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
498
+ - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
483
499
  - [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
484
500
  - [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
485
501
  - [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
@@ -496,6 +512,7 @@ Class | Method | HTTP request | Description
496
512
  - [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
497
513
  - [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
498
514
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
515
+ - [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
499
516
  - [DealMakerAPI::V1EntitiesShareholder](docs/V1EntitiesShareholder.md)
500
517
  - [DealMakerAPI::V1EntitiesShareholders](docs/V1EntitiesShareholders.md)
501
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
@@ -4,11 +4,151 @@ 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 |
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 |
7
9
  | [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
8
10
  | [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
9
11
  | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
10
12
 
11
13
 
14
+ ## create_bulk_upload
15
+
16
+ > <V1EntitiesBulkUpload> create_bulk_upload(id, create_bulk_upload_request)
17
+
18
+ Create bulk upload record
19
+
20
+ Create bulk upload record
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'DealMakerAPI'
27
+ # setup authorization
28
+ DealMakerAPI.configure do |config|end
29
+
30
+ api_instance = DealMakerAPI::CompanyApi.new
31
+ id = 56 # Integer | The company id
32
+ create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
33
+
34
+ begin
35
+ # Create bulk upload record
36
+ result = api_instance.create_bulk_upload(id, create_bulk_upload_request)
37
+ p result
38
+ rescue DealMakerAPI::ApiError => e
39
+ puts "Error when calling CompanyApi->create_bulk_upload: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the create_bulk_upload_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<V1EntitiesBulkUpload>, Integer, Hash)> create_bulk_upload_with_http_info(id, create_bulk_upload_request)
48
+
49
+ ```ruby
50
+ begin
51
+ # Create bulk upload record
52
+ data, status_code, headers = api_instance.create_bulk_upload_with_http_info(id, create_bulk_upload_request)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <V1EntitiesBulkUpload>
56
+ rescue DealMakerAPI::ApiError => e
57
+ puts "Error when calling CompanyApi->create_bulk_upload_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **id** | **Integer** | The company id | |
66
+ | **create_bulk_upload_request** | [**CreateBulkUploadRequest**](CreateBulkUploadRequest.md) | | |
67
+
68
+ ### Return type
69
+
70
+ [**V1EntitiesBulkUpload**](V1EntitiesBulkUpload.md)
71
+
72
+ ### Authorization
73
+
74
+ No authorization required
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: application/json
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
+
12
152
  ## create_company
13
153
 
14
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
+
@@ -0,0 +1,20 @@
1
+ # DealMakerAPI::CreateBulkUploadRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **file_identifier** | **String** | The file identifier | |
8
+ | **document_type** | **String** | The document type | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'DealMakerAPI'
14
+
15
+ instance = DealMakerAPI::CreateBulkUploadRequest.new(
16
+ file_identifier: null,
17
+ document_type: null
18
+ )
19
+ ```
20
+
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
+