DealMakerAPI 0.83.3 → 0.84.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -6
  3. data/docs/BulkUploadInvestorsRequest.md +18 -0
  4. data/docs/CompanyApi.md +178 -30
  5. data/docs/CreateShareholderActionRequest.md +20 -0
  6. data/docs/DealsApi.md +75 -0
  7. data/docs/InvestorApi.md +69 -0
  8. data/docs/PutDealsIdScriptTagEnvironmentRequest.md +18 -0
  9. data/docs/V1EntitiesBulkUpload.md +6 -0
  10. data/docs/V1EntitiesBulkUploadDetail.md +2 -0
  11. data/docs/V1EntitiesDealIssuer.md +3 -1
  12. data/docs/V1EntitiesGenericResponse.md +20 -0
  13. data/docs/V1EntitiesInvestor.md +1 -1
  14. data/lib/DealMakerAPI/api/company_api.rb +191 -33
  15. data/lib/DealMakerAPI/api/deals_api.rb +94 -0
  16. data/lib/DealMakerAPI/api/investor_api.rb +74 -0
  17. data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +222 -0
  18. data/lib/DealMakerAPI/models/create_individual_profile_request.rb +2 -2
  19. data/lib/DealMakerAPI/models/create_joint_profile_request.rb +2 -2
  20. data/lib/DealMakerAPI/models/create_shareholder_action_request.rb +239 -0
  21. data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +2 -2
  22. data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +2 -2
  23. data/lib/DealMakerAPI/models/put_deals_id_script_tag_environment_request.rb +222 -0
  24. data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +31 -1
  25. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +11 -1
  26. data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +14 -4
  27. data/lib/DealMakerAPI/models/v1_entities_generic_response.rb +226 -0
  28. data/lib/DealMakerAPI/models/v1_entities_investor.rb +1 -1
  29. data/lib/DealMakerAPI/version.rb +1 -1
  30. data/lib/DealMakerAPI.rb +5 -0
  31. data/spec/api/company_api_spec.rb +40 -10
  32. data/spec/api/deals_api_spec.rb +48 -0
  33. data/spec/api/investor_api_spec.rb +13 -0
  34. data/spec/models/bulk_upload_investors_request_spec.rb +34 -0
  35. data/spec/models/create_individual_profile_request_spec.rb +1 -1
  36. data/spec/models/create_joint_profile_request_spec.rb +1 -1
  37. data/spec/models/create_shareholder_action_request_spec.rb +40 -0
  38. data/spec/models/patch_individual_profile_request_spec.rb +1 -1
  39. data/spec/models/patch_joint_profile_request_spec.rb +1 -1
  40. data/spec/models/put_deals_id_script_tag_environment_request_spec.rb +34 -0
  41. data/spec/models/v1_entities_bulk_upload_detail_spec.rb +6 -0
  42. data/spec/models/v1_entities_bulk_upload_spec.rb +18 -0
  43. data/spec/models/v1_entities_deal_issuer_spec.rb +6 -0
  44. data/spec/models/v1_entities_generic_response_spec.rb +40 -0
  45. metadata +82 -62
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 11d72fc324c0c232b2d318959a5544bfd10d15fce4c5d16bb4eb6287c6a87f2b
4
- data.tar.gz: c97056a777e441ab5dc616e48b8c0229130df7124e862f8b7f839189a5690770
3
+ metadata.gz: 050e62b940c2cd84e5fc23491c1fb88b064a416f231c8c1d69ae815348033d99
4
+ data.tar.gz: b7a4d15633e1bd751a4780599d87654a5e880bb8fe89039d8a2e844a338a2fe1
5
5
  SHA512:
6
- metadata.gz: a81f17e42b94f664b584876f60fe0af58aebd58ed1ffd6898afd2dba703240f9eb1c78aa75d19c9be9fe0b7e6091cb93df64b25225bb1e6eb45fc4b738a5ce56
7
- data.tar.gz: 13a6eb47dec0dd9b29e599a4aa7a14c520d8f031ce65d53516d2484d08172f72b86fdbdb38e7e6fd8b4ed698148784f473ea951d8f205a12b1d528314c045609
6
+ metadata.gz: d00f8c7f676a643c046d85fe35ff7afb5368f54b2d431cdd5666be216ae4e3318ab47a2c470f6a5022df5ad33d5c907c8a22e1fc682d38fa77224083db34c808
7
+ data.tar.gz: 78a6d322ad75ee8882101e87b7e230fb533273a2a81dea24ec704b0a9bba862046f27eda462be54fc58b52c6d53f2df8ecefa949217a76fea9f84660a2e72dd0
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.83.3
341
+ - Package version: 0.84.4
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.83.3.gem
357
+ gem install ./DealMakerAPI-0.84.4.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.83.3.gem` to install the development dependencies)
360
+ (for development, run `gem install --dev ./DealMakerAPI-0.84.4.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.83.3'
366
+ gem 'DealMakerAPI', '~> 0.84.4'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -413,15 +413,18 @@ 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* | [**get_bulk_upload_details**](docs/CompanyApi.md#get_bulk_upload_details) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Return full list of bulk upload details order by status desc and id asc
417
- *DealMakerAPI::CompanyApi* | [**get_bulk_upload_details_by_status**](docs/CompanyApi.md#get_bulk_upload_details_by_status) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status | Return bulk upload details grouped by status
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
418
419
  *DealMakerAPI::CompanyApi* | [**get_bulk_uploads**](docs/CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads
419
420
  *DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
420
421
  *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
422
+ *DealMakerAPI::CompanyApi* | [**get_details_errors_grouped**](docs/CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status
421
423
  *DealMakerAPI::DealApi* | [**get_analytics_dashboard_info**](docs/DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info
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
@@ -432,6 +435,7 @@ Class | Method | HTTP request | Description
432
435
  *DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
433
436
  *DealMakerAPI::InvestorApi* | [**add506c_document**](docs/InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor
434
437
  *DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
438
+ *DealMakerAPI::InvestorApi* | [**bulk_upload_investors**](docs/InvestorApi.md#bulk_upload_investors) | **POST** /deals/{id}/investors/bulk_upload | Bulk upload investors for deal investor
435
439
  *DealMakerAPI::InvestorApi* | [**create_investor**](docs/InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor
436
440
  *DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
437
441
  *DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
@@ -461,6 +465,7 @@ Class | Method | HTTP request | Description
461
465
 
462
466
  - [DealMakerAPI::Add506cDocumentRequest](docs/Add506cDocumentRequest.md)
463
467
  - [DealMakerAPI::AddDocumentRequest](docs/AddDocumentRequest.md)
468
+ - [DealMakerAPI::BulkUploadInvestorsRequest](docs/BulkUploadInvestorsRequest.md)
464
469
  - [DealMakerAPI::CreateBulkUploadDetailRequest](docs/CreateBulkUploadDetailRequest.md)
465
470
  - [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
466
471
  - [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
@@ -469,6 +474,7 @@ Class | Method | HTTP request | Description
469
474
  - [DealMakerAPI::CreateIndividualProfileRequest](docs/CreateIndividualProfileRequest.md)
470
475
  - [DealMakerAPI::CreateInvestorRequest](docs/CreateInvestorRequest.md)
471
476
  - [DealMakerAPI::CreateJointProfileRequest](docs/CreateJointProfileRequest.md)
477
+ - [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
472
478
  - [DealMakerAPI::CreateTrustProfileRequest](docs/CreateTrustProfileRequest.md)
473
479
  - [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
474
480
  - [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
@@ -478,6 +484,7 @@ Class | Method | HTTP request | Description
478
484
  - [DealMakerAPI::PatchJointProfileRequest](docs/PatchJointProfileRequest.md)
479
485
  - [DealMakerAPI::PatchTrustProfileRequest](docs/PatchTrustProfileRequest.md)
480
486
  - [DealMakerAPI::PostWebhooksRequest](docs/PostWebhooksRequest.md)
487
+ - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
481
488
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
482
489
  - [DealMakerAPI::UpdateInvestorRequest](docs/UpdateInvestorRequest.md)
483
490
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
@@ -501,6 +508,7 @@ Class | Method | HTTP request | Description
501
508
  - [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
502
509
  - [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
503
510
  - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
511
+ - [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
504
512
  - [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
505
513
  - [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
506
514
  - [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::BulkUploadInvestorsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **import_file** | **File** | The CSV file with data to upload. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::BulkUploadInvestorsRequest.new(
15
+ import_file: null
16
+ )
17
+ ```
18
+
data/docs/CompanyApi.md CHANGED
@@ -7,11 +7,13 @@ 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
- | [**get_bulk_upload_details**](CompanyApi.md#get_bulk_upload_details) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Return full list of bulk upload details order by status desc and id asc |
11
- | [**get_bulk_upload_details_by_status**](CompanyApi.md#get_bulk_upload_details_by_status) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status | Return bulk upload details grouped by status |
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 |
12
13
  | [**get_bulk_uploads**](CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads |
13
14
  | [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
14
15
  | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
16
+ | [**get_details_errors_grouped**](CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status |
15
17
 
16
18
 
17
19
  ## create_bulk_upload
@@ -218,13 +220,13 @@ No authorization required
218
220
  - **Accept**: application/json
219
221
 
220
222
 
221
- ## get_bulk_upload_details
223
+ ## create_shareholder_action
222
224
 
223
- > <V1EntitiesBulkUploadDetails> get_bulk_upload_details(company_id, bulk_upload_id)
225
+ > <V1EntitiesGenericResponse> create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request)
224
226
 
225
- Return full list of bulk upload details order by status desc and id asc
227
+ Create a shareholder action
226
228
 
227
- Return full list of bulk upload details
229
+ Create a shareholder action
228
230
 
229
231
  ### Examples
230
232
 
@@ -235,33 +237,108 @@ require 'DealMakerAPI'
235
237
  DealMakerAPI.configure do |config|end
236
238
 
237
239
  api_instance = DealMakerAPI::CompanyApi.new
238
- company_id = 56 # Integer |
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 |
239
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
+ }
240
317
 
241
318
  begin
242
- # Return full list of bulk upload details order by status desc and id asc
243
- result = api_instance.get_bulk_upload_details(company_id, bulk_upload_id)
319
+ # Return a given bulk upload by id
320
+ result = api_instance.get_bulk_upload(id, bulk_upload_id, opts)
244
321
  p result
245
322
  rescue DealMakerAPI::ApiError => e
246
- puts "Error when calling CompanyApi->get_bulk_upload_details: #{e}"
323
+ puts "Error when calling CompanyApi->get_bulk_upload: #{e}"
247
324
  end
248
325
  ```
249
326
 
250
- #### Using the get_bulk_upload_details_with_http_info variant
327
+ #### Using the get_bulk_upload_with_http_info variant
251
328
 
252
329
  This returns an Array which contains the response data, status code and headers.
253
330
 
254
- > <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_with_http_info(company_id, bulk_upload_id)
331
+ > <Array(<V1EntitiesBulkUpload>, Integer, Hash)> get_bulk_upload_with_http_info(id, bulk_upload_id, opts)
255
332
 
256
333
  ```ruby
257
334
  begin
258
- # Return full list of bulk upload details order by status desc and id asc
259
- data, status_code, headers = api_instance.get_bulk_upload_details_with_http_info(company_id, bulk_upload_id)
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)
260
337
  p status_code # => 2xx
261
338
  p headers # => { ... }
262
- p data # => <V1EntitiesBulkUploadDetails>
339
+ p data # => <V1EntitiesBulkUpload>
263
340
  rescue DealMakerAPI::ApiError => e
264
- puts "Error when calling CompanyApi->get_bulk_upload_details_with_http_info: #{e}"
341
+ puts "Error when calling CompanyApi->get_bulk_upload_with_http_info: #{e}"
265
342
  end
266
343
  ```
267
344
 
@@ -269,12 +346,15 @@ end
269
346
 
270
347
  | Name | Type | Description | Notes |
271
348
  | ---- | ---- | ----------- | ----- |
272
- | **company_id** | **Integer** | | |
349
+ | **id** | **Integer** | | |
273
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] |
274
354
 
275
355
  ### Return type
276
356
 
277
- [**V1EntitiesBulkUploadDetails**](V1EntitiesBulkUploadDetails.md)
357
+ [**V1EntitiesBulkUpload**](V1EntitiesBulkUpload.md)
278
358
 
279
359
  ### Authorization
280
360
 
@@ -286,13 +366,13 @@ No authorization required
286
366
  - **Accept**: application/json
287
367
 
288
368
 
289
- ## get_bulk_upload_details_by_status
369
+ ## get_bulk_upload_details_errors
290
370
 
291
- > <V1EntitiesBulkUploadDetails> get_bulk_upload_details_by_status(company_id, bulk_upload_id)
371
+ > <V1EntitiesBulkUploadDetails> get_bulk_upload_details_errors(company_id, bulk_upload_id)
292
372
 
293
- Return bulk upload details grouped by status
373
+ Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc
294
374
 
295
- Return bulk upload details grouped by status
375
+ Returns a full list of details with errors of the given bulk upload
296
376
 
297
377
  ### Examples
298
378
 
@@ -307,29 +387,29 @@ company_id = 56 # Integer |
307
387
  bulk_upload_id = 56 # Integer |
308
388
 
309
389
  begin
310
- # Return bulk upload details grouped by status
311
- result = api_instance.get_bulk_upload_details_by_status(company_id, bulk_upload_id)
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)
312
392
  p result
313
393
  rescue DealMakerAPI::ApiError => e
314
- puts "Error when calling CompanyApi->get_bulk_upload_details_by_status: #{e}"
394
+ puts "Error when calling CompanyApi->get_bulk_upload_details_errors: #{e}"
315
395
  end
316
396
  ```
317
397
 
318
- #### Using the get_bulk_upload_details_by_status_with_http_info variant
398
+ #### Using the get_bulk_upload_details_errors_with_http_info variant
319
399
 
320
400
  This returns an Array which contains the response data, status code and headers.
321
401
 
322
- > <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id)
402
+ > <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_errors_with_http_info(company_id, bulk_upload_id)
323
403
 
324
404
  ```ruby
325
405
  begin
326
- # Return bulk upload details grouped by status
327
- data, status_code, headers = api_instance.get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id)
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)
328
408
  p status_code # => 2xx
329
409
  p headers # => { ... }
330
410
  p data # => <V1EntitiesBulkUploadDetails>
331
411
  rescue DealMakerAPI::ApiError => e
332
- puts "Error when calling CompanyApi->get_bulk_upload_details_by_status_with_http_info: #{e}"
412
+ puts "Error when calling CompanyApi->get_bulk_upload_details_errors_with_http_info: #{e}"
333
413
  end
334
414
  ```
335
415
 
@@ -565,3 +645,71 @@ No authorization required
565
645
  - **Content-Type**: Not defined
566
646
  - **Accept**: application/json
567
647
 
648
+
649
+ ## get_details_errors_grouped
650
+
651
+ > <V1EntitiesBulkUploadDetails> get_details_errors_grouped(company_id, bulk_upload_id)
652
+
653
+ Return bulk upload details grouped by status
654
+
655
+ Return bulk upload details grouped by status
656
+
657
+ ### Examples
658
+
659
+ ```ruby
660
+ require 'time'
661
+ require 'DealMakerAPI'
662
+ # setup authorization
663
+ DealMakerAPI.configure do |config|end
664
+
665
+ api_instance = DealMakerAPI::CompanyApi.new
666
+ company_id = 56 # Integer |
667
+ bulk_upload_id = 56 # Integer |
668
+
669
+ begin
670
+ # Return bulk upload details grouped by status
671
+ result = api_instance.get_details_errors_grouped(company_id, bulk_upload_id)
672
+ p result
673
+ rescue DealMakerAPI::ApiError => e
674
+ puts "Error when calling CompanyApi->get_details_errors_grouped: #{e}"
675
+ end
676
+ ```
677
+
678
+ #### Using the get_details_errors_grouped_with_http_info variant
679
+
680
+ This returns an Array which contains the response data, status code and headers.
681
+
682
+ > <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_details_errors_grouped_with_http_info(company_id, bulk_upload_id)
683
+
684
+ ```ruby
685
+ begin
686
+ # Return bulk upload details grouped by status
687
+ data, status_code, headers = api_instance.get_details_errors_grouped_with_http_info(company_id, bulk_upload_id)
688
+ p status_code # => 2xx
689
+ p headers # => { ... }
690
+ p data # => <V1EntitiesBulkUploadDetails>
691
+ rescue DealMakerAPI::ApiError => e
692
+ puts "Error when calling CompanyApi->get_details_errors_grouped_with_http_info: #{e}"
693
+ end
694
+ ```
695
+
696
+ ### Parameters
697
+
698
+ | Name | Type | Description | Notes |
699
+ | ---- | ---- | ----------- | ----- |
700
+ | **company_id** | **Integer** | | |
701
+ | **bulk_upload_id** | **Integer** | | |
702
+
703
+ ### Return type
704
+
705
+ [**V1EntitiesBulkUploadDetails**](V1EntitiesBulkUploadDetails.md)
706
+
707
+ ### Authorization
708
+
709
+ No authorization required
710
+
711
+ ### HTTP request headers
712
+
713
+ - **Content-Type**: Not defined
714
+ - **Accept**: application/json
715
+
@@ -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
+
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/InvestorApi.md CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *http://api.dealmaker.tech*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**add506c_document**](InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor |
8
8
  | [**add_document**](InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor |
9
+ | [**bulk_upload_investors**](InvestorApi.md#bulk_upload_investors) | **POST** /deals/{id}/investors/bulk_upload | Bulk upload investors for deal investor |
9
10
  | [**create_investor**](InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
10
11
  | [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
11
12
  | [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
@@ -157,6 +158,74 @@ No authorization required
157
158
  - **Accept**: application/json
158
159
 
159
160
 
161
+ ## bulk_upload_investors
162
+
163
+ > <V1EntitiesInvestor> bulk_upload_investors(id, bulk_upload_investors_request)
164
+
165
+ Bulk upload investors for deal investor
166
+
167
+ Bulk upload investors
168
+
169
+ ### Examples
170
+
171
+ ```ruby
172
+ require 'time'
173
+ require 'DealMakerAPI'
174
+ # setup authorization
175
+ DealMakerAPI.configure do |config|end
176
+
177
+ api_instance = DealMakerAPI::InvestorApi.new
178
+ id = 56 # Integer | The deal id.
179
+ bulk_upload_investors_request = DealMakerAPI::BulkUploadInvestorsRequest.new({import_file: File.new('/path/to/some/file')}) # BulkUploadInvestorsRequest |
180
+
181
+ begin
182
+ # Bulk upload investors for deal investor
183
+ result = api_instance.bulk_upload_investors(id, bulk_upload_investors_request)
184
+ p result
185
+ rescue DealMakerAPI::ApiError => e
186
+ puts "Error when calling InvestorApi->bulk_upload_investors: #{e}"
187
+ end
188
+ ```
189
+
190
+ #### Using the bulk_upload_investors_with_http_info variant
191
+
192
+ This returns an Array which contains the response data, status code and headers.
193
+
194
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> bulk_upload_investors_with_http_info(id, bulk_upload_investors_request)
195
+
196
+ ```ruby
197
+ begin
198
+ # Bulk upload investors for deal investor
199
+ data, status_code, headers = api_instance.bulk_upload_investors_with_http_info(id, bulk_upload_investors_request)
200
+ p status_code # => 2xx
201
+ p headers # => { ... }
202
+ p data # => <V1EntitiesInvestor>
203
+ rescue DealMakerAPI::ApiError => e
204
+ puts "Error when calling InvestorApi->bulk_upload_investors_with_http_info: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ | Name | Type | Description | Notes |
211
+ | ---- | ---- | ----------- | ----- |
212
+ | **id** | **Integer** | The deal id. | |
213
+ | **bulk_upload_investors_request** | [**BulkUploadInvestorsRequest**](BulkUploadInvestorsRequest.md) | | |
214
+
215
+ ### Return type
216
+
217
+ [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
218
+
219
+ ### Authorization
220
+
221
+ No authorization required
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: application/json
226
+ - **Accept**: application/json
227
+
228
+
160
229
  ## create_investor
161
230
 
162
231
  > <V1EntitiesInvestor> create_investor(id, create_investor_request)
@@ -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
  )