DealMakerAPI 0.87.0 → 0.88.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (106) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -7
  3. data/docs/CompanyApi.md +67 -0
  4. data/docs/DealApi.md +0 -71
  5. data/docs/InvestorApi.md +83 -14
  6. data/docs/{CreateInvestorRequest.md → PostDealsIdInvestors.md} +2 -4
  7. data/docs/{UpdateInvestorRequest.md → PutDealsIdInvestors.md} +2 -4
  8. data/docs/V1EntitiesBulkUpload.md +1 -1
  9. data/docs/V1EntitiesDividend.md +24 -0
  10. data/docs/V1EntitiesDividends.md +18 -0
  11. data/lib/DealMakerAPI/api/company_api.rb +63 -0
  12. data/lib/DealMakerAPI/api/deal_api.rb +0 -66
  13. data/lib/DealMakerAPI/api/investor_api.rb +94 -15
  14. data/lib/DealMakerAPI/models/{create_investor_request.rb → post_deals_id_investors.rb} +5 -14
  15. data/lib/DealMakerAPI/models/{update_investor_request.rb → put_deals_id_investors.rb} +5 -14
  16. data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +35 -1
  17. data/lib/DealMakerAPI/models/v1_entities_dividend.rb +245 -0
  18. data/lib/DealMakerAPI/models/v1_entities_dividends.rb +215 -0
  19. data/lib/DealMakerAPI/version.rb +1 -1
  20. data/lib/DealMakerAPI.rb +4 -2
  21. data/spec/api/company_api_spec.rb +12 -0
  22. data/spec/api/deal_api_spec.rb +0 -13
  23. data/spec/api/investor_api_spec.rb +16 -2
  24. data/spec/models/add506c_document_request_spec.rb +3 -1
  25. data/spec/models/add_document_request_spec.rb +3 -1
  26. data/spec/models/bulk_upload_investors_request_spec.rb +3 -1
  27. data/spec/models/create_bulk_upload_detail_request_spec.rb +3 -1
  28. data/spec/models/create_bulk_upload_request_spec.rb +3 -1
  29. data/spec/models/create_company_request_spec.rb +3 -1
  30. data/spec/models/create_deal_setup_request_spec.rb +3 -1
  31. data/spec/models/create_shareholder_action_request_spec.rb +3 -1
  32. data/spec/models/edit_investor_tags_request_spec.rb +3 -1
  33. data/spec/models/generate_url_request_spec.rb +3 -1
  34. data/spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb +3 -1
  35. data/spec/models/patch_investor_profiles_corporations_spec.rb +3 -1
  36. data/spec/models/patch_investor_profiles_individuals_spec.rb +3 -1
  37. data/spec/models/patch_investor_profiles_joints_spec.rb +3 -1
  38. data/spec/models/patch_investor_profiles_trusts_spec.rb +3 -1
  39. data/spec/models/patch_investor_request_spec.rb +3 -1
  40. data/spec/models/{create_investor_request_spec.rb → post_deals_id_investors_spec.rb} +8 -12
  41. data/spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb +3 -1
  42. data/spec/models/post_investor_profiles_corporations_spec.rb +3 -1
  43. data/spec/models/post_investor_profiles_individuals_spec.rb +3 -1
  44. data/spec/models/post_investor_profiles_joints_spec.rb +3 -1
  45. data/spec/models/post_investor_profiles_trusts_spec.rb +3 -1
  46. data/spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb +3 -1
  47. data/spec/models/post_webhooks_request_spec.rb +3 -1
  48. data/spec/models/{update_investor_request_spec.rb → put_deals_id_investors_spec.rb} +8 -12
  49. data/spec/models/put_deals_id_script_tag_environment_request_spec.rb +3 -1
  50. data/spec/models/put_webhooks_id_request_spec.rb +3 -1
  51. data/spec/models/v1_entities_address_spec.rb +3 -1
  52. data/spec/models/v1_entities_addresses_spec.rb +3 -1
  53. data/spec/models/v1_entities_attachment_spec.rb +3 -1
  54. data/spec/models/v1_entities_background_check_search_spec.rb +3 -1
  55. data/spec/models/v1_entities_bulk_upload_detail_spec.rb +3 -1
  56. data/spec/models/v1_entities_bulk_upload_details_spec.rb +3 -1
  57. data/spec/models/v1_entities_bulk_upload_spec.rb +7 -1
  58. data/spec/models/v1_entities_bulk_uploads_spec.rb +3 -1
  59. data/spec/models/v1_entities_company_deal_spec.rb +3 -1
  60. data/spec/models/v1_entities_company_deals_spec.rb +3 -1
  61. data/spec/models/v1_entities_company_spec.rb +3 -1
  62. data/spec/models/v1_entities_countries_spec.rb +3 -1
  63. data/spec/models/v1_entities_country_spec.rb +3 -1
  64. data/spec/models/v1_entities_deal_enterprise_spec.rb +3 -1
  65. data/spec/models/v1_entities_deal_funding_metrics_spec.rb +3 -1
  66. data/spec/models/v1_entities_deal_investor_metrics_spec.rb +3 -1
  67. data/spec/models/v1_entities_deal_issuer_spec.rb +3 -1
  68. data/spec/models/v1_entities_deal_setup_spec.rb +3 -1
  69. data/spec/models/v1_entities_deal_setup_user_spec.rb +3 -1
  70. data/spec/models/v1_entities_deal_spec.rb +3 -1
  71. data/spec/models/v1_entities_deals_spec.rb +3 -1
  72. data/spec/models/v1_entities_dividend_spec.rb +54 -0
  73. data/spec/models/v1_entities_dividends_spec.rb +36 -0
  74. data/spec/models/v1_entities_express_wire_instruction_spec.rb +3 -1
  75. data/spec/models/v1_entities_express_wire_instructions_spec.rb +3 -1
  76. data/spec/models/v1_entities_generic_response_spec.rb +3 -1
  77. data/spec/models/v1_entities_investor_otp_access_link_spec.rb +3 -1
  78. data/spec/models/v1_entities_investor_profile_address_spec.rb +3 -1
  79. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +3 -1
  80. data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +3 -1
  81. data/spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb +3 -1
  82. data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +3 -1
  83. data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +3 -1
  84. data/spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb +3 -1
  85. data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +3 -1
  86. data/spec/models/v1_entities_investor_profile_individual_spec.rb +3 -1
  87. data/spec/models/v1_entities_investor_profile_item_spec.rb +3 -1
  88. data/spec/models/v1_entities_investor_profile_joint_spec.rb +3 -1
  89. data/spec/models/v1_entities_investor_profile_owner_spec.rb +3 -1
  90. data/spec/models/v1_entities_investor_profile_trust_spec.rb +3 -1
  91. data/spec/models/v1_entities_investor_profiles_spec.rb +3 -1
  92. data/spec/models/v1_entities_investor_spec.rb +3 -1
  93. data/spec/models/v1_entities_investor_user_spec.rb +3 -1
  94. data/spec/models/v1_entities_investors_spec.rb +3 -1
  95. data/spec/models/v1_entities_presigned_url_result_spec.rb +3 -1
  96. data/spec/models/v1_entities_shareholder_spec.rb +3 -1
  97. data/spec/models/v1_entities_shareholders_spec.rb +3 -1
  98. data/spec/models/v1_entities_shareholders_tags_spec.rb +3 -1
  99. data/spec/models/v1_entities_state_spec.rb +3 -1
  100. data/spec/models/v1_entities_subscription_agreement_spec.rb +3 -1
  101. data/spec/models/v1_entities_webhooks_deal_spec.rb +3 -1
  102. data/spec/models/v1_entities_webhooks_security_token_spec.rb +3 -1
  103. data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +3 -1
  104. data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +3 -1
  105. data/spec/models/v1_entities_webhooks_subscription_spec.rb +3 -1
  106. metadata +87 -79
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e14d46335ad9cfe99a600ab9c779e08bfbed7a43b64a96cf198e2dd04ee9f733
4
- data.tar.gz: 4e8510f9519829952c16737c6640c827017e9f363f5cc6d752ad6c962085b9e5
3
+ metadata.gz: 93e5adda2a6d5b72424dca6de26ea13e8b6678e84298c4931c17662283089957
4
+ data.tar.gz: 2e153849cd1d5da2e21a5c549a2f2db3ca4083950017cda8897c1516e40d4c71
5
5
  SHA512:
6
- metadata.gz: 151e39224e953a63479097c14a41dba18607375d58311954352cb7d77f8b27edcea9a06437690cdb0ce46db79f43371d319fd522f6ea538feeced796cff0c5c6
7
- data.tar.gz: 1a7e3ffdd098c2527e6f9e6d02e2d52c1cc5a379ea612a425277095fc4bc6d207b2b3e10096aa5677be1be5478867bc9e19012f404f8cab77d836bfd33d42c31
6
+ metadata.gz: 2da04e7372992b3967552f706164f3d118e8868aeec9cecbe0ec1d3dc40939f58f21ad896aef620320afe01047c209daad9f1e763d932052531646ec0424d92b
7
+ data.tar.gz: 9e1e2058085d9b132a6604df2582e344c2c41fcb7bf158ba436c54136a50f957ed900b8173068735ce859d7dbc897f4cef368236ea9c7a17bc3f7252dcf36a7a
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.87.0
341
+ - Package version: 0.88.2
342
342
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
343
343
 
344
344
  ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
354
354
  Then either install the gem locally:
355
355
 
356
356
  ```shell
357
- gem install ./DealMakerAPI-0.87.0.gem
357
+ gem install ./DealMakerAPI-0.88.2.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.87.0.gem` to install the development dependencies)
360
+ (for development, run `gem install --dev ./DealMakerAPI-0.88.2.gem` to install the development dependencies)
361
361
 
362
362
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
363
363
 
364
364
  Finally add this to the Gemfile:
365
365
 
366
- gem 'DealMakerAPI', '~> 0.87.0'
366
+ gem 'DealMakerAPI', '~> 0.88.2'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -420,8 +420,8 @@ Class | Method | HTTP request | Description
420
420
  *DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
421
421
  *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
422
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
423
+ *DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
423
424
  *DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
424
- *DealMakerAPI::DealApi* | [**get_analytics_dashboard_info**](docs/DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info
425
425
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
426
426
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
427
427
  *DealMakerAPI::DealSetupApi* | [**create_deal_setup**](docs/DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
@@ -441,6 +441,7 @@ Class | Method | HTTP request | Description
441
441
  *DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
442
442
  *DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
443
443
  *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
444
+ *DealMakerAPI::InvestorApi* | [**get_enforcements**](docs/InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search
444
445
  *DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
445
446
  *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
446
447
  *DealMakerAPI::InvestorApi* | [**list_investors**](docs/InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors
@@ -472,7 +473,6 @@ Class | Method | HTTP request | Description
472
473
  - [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
473
474
  - [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
474
475
  - [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
475
- - [DealMakerAPI::CreateInvestorRequest](docs/CreateInvestorRequest.md)
476
476
  - [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
477
477
  - [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
478
478
  - [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
@@ -482,6 +482,7 @@ Class | Method | HTTP request | Description
482
482
  - [DealMakerAPI::PatchInvestorProfilesJoints](docs/PatchInvestorProfilesJoints.md)
483
483
  - [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
484
484
  - [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
485
+ - [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
485
486
  - [DealMakerAPI::PostInvestorProfilesCorporations](docs/PostInvestorProfilesCorporations.md)
486
487
  - [DealMakerAPI::PostInvestorProfilesCorporationsBeneficialOwnersInner](docs/PostInvestorProfilesCorporationsBeneficialOwnersInner.md)
487
488
  - [DealMakerAPI::PostInvestorProfilesIndividuals](docs/PostInvestorProfilesIndividuals.md)
@@ -489,9 +490,9 @@ Class | Method | HTTP request | Description
489
490
  - [DealMakerAPI::PostInvestorProfilesTrusts](docs/PostInvestorProfilesTrusts.md)
490
491
  - [DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner](docs/PostInvestorProfilesTrustsTrusteesInner.md)
491
492
  - [DealMakerAPI::PostWebhooksRequest](docs/PostWebhooksRequest.md)
493
+ - [DealMakerAPI::PutDealsIdInvestors](docs/PutDealsIdInvestors.md)
492
494
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
493
495
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
494
- - [DealMakerAPI::UpdateInvestorRequest](docs/UpdateInvestorRequest.md)
495
496
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
496
497
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
497
498
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -513,6 +514,8 @@ Class | Method | HTTP request | Description
513
514
  - [DealMakerAPI::V1EntitiesDealSetup](docs/V1EntitiesDealSetup.md)
514
515
  - [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
515
516
  - [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
517
+ - [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
518
+ - [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
516
519
  - [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
517
520
  - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
518
521
  - [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
data/docs/CompanyApi.md CHANGED
@@ -14,6 +14,7 @@ All URIs are relative to *http://api.dealmaker.tech*
14
14
  | [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
15
15
  | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
16
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 |
17
+ | [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
17
18
 
18
19
 
19
20
  ## create_bulk_upload
@@ -713,3 +714,69 @@ No authorization required
713
714
  - **Content-Type**: Not defined
714
715
  - **Accept**: application/json
715
716
 
717
+
718
+ ## get_dividends
719
+
720
+ > <V1EntitiesDividends> get_dividends(company_id)
721
+
722
+ Return dividends
723
+
724
+ Return dividends associated with a shareholder
725
+
726
+ ### Examples
727
+
728
+ ```ruby
729
+ require 'time'
730
+ require 'DealMakerAPI'
731
+ # setup authorization
732
+ DealMakerAPI.configure do |config|end
733
+
734
+ api_instance = DealMakerAPI::CompanyApi.new
735
+ company_id = 56 # Integer |
736
+
737
+ begin
738
+ # Return dividends
739
+ result = api_instance.get_dividends(company_id)
740
+ p result
741
+ rescue DealMakerAPI::ApiError => e
742
+ puts "Error when calling CompanyApi->get_dividends: #{e}"
743
+ end
744
+ ```
745
+
746
+ #### Using the get_dividends_with_http_info variant
747
+
748
+ This returns an Array which contains the response data, status code and headers.
749
+
750
+ > <Array(<V1EntitiesDividends>, Integer, Hash)> get_dividends_with_http_info(company_id)
751
+
752
+ ```ruby
753
+ begin
754
+ # Return dividends
755
+ data, status_code, headers = api_instance.get_dividends_with_http_info(company_id)
756
+ p status_code # => 2xx
757
+ p headers # => { ... }
758
+ p data # => <V1EntitiesDividends>
759
+ rescue DealMakerAPI::ApiError => e
760
+ puts "Error when calling CompanyApi->get_dividends_with_http_info: #{e}"
761
+ end
762
+ ```
763
+
764
+ ### Parameters
765
+
766
+ | Name | Type | Description | Notes |
767
+ | ---- | ---- | ----------- | ----- |
768
+ | **company_id** | **Integer** | | |
769
+
770
+ ### Return type
771
+
772
+ [**V1EntitiesDividends**](V1EntitiesDividends.md)
773
+
774
+ ### Authorization
775
+
776
+ No authorization required
777
+
778
+ ### HTTP request headers
779
+
780
+ - **Content-Type**: Not defined
781
+ - **Accept**: application/json
782
+
data/docs/DealApi.md CHANGED
@@ -4,81 +4,10 @@ All URIs are relative to *http://api.dealmaker.tech*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_analytics_dashboard_info**](DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info |
8
7
  | [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
9
8
  | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
10
9
 
11
10
 
12
- ## get_analytics_dashboard_info
13
-
14
- > Object get_analytics_dashboard_info(id, opts)
15
-
16
- Get Analytics Dashboard Info
17
-
18
- Get Analytics Dashboard Info
19
-
20
- ### Examples
21
-
22
- ```ruby
23
- require 'time'
24
- require 'DealMakerAPI'
25
- # setup authorization
26
- DealMakerAPI.configure do |config|end
27
-
28
- api_instance = DealMakerAPI::DealApi.new
29
- id = 56 # Integer | The deal id.
30
- opts = {
31
- dashboard_key: 'dashboard_key_example' # String | The dashboard key.
32
- }
33
-
34
- begin
35
- # Get Analytics Dashboard Info
36
- result = api_instance.get_analytics_dashboard_info(id, opts)
37
- p result
38
- rescue DealMakerAPI::ApiError => e
39
- puts "Error when calling DealApi->get_analytics_dashboard_info: #{e}"
40
- end
41
- ```
42
-
43
- #### Using the get_analytics_dashboard_info_with_http_info variant
44
-
45
- This returns an Array which contains the response data, status code and headers.
46
-
47
- > <Array(Object, Integer, Hash)> get_analytics_dashboard_info_with_http_info(id, opts)
48
-
49
- ```ruby
50
- begin
51
- # Get Analytics Dashboard Info
52
- data, status_code, headers = api_instance.get_analytics_dashboard_info_with_http_info(id, opts)
53
- p status_code # => 2xx
54
- p headers # => { ... }
55
- p data # => Object
56
- rescue DealMakerAPI::ApiError => e
57
- puts "Error when calling DealApi->get_analytics_dashboard_info_with_http_info: #{e}"
58
- end
59
- ```
60
-
61
- ### Parameters
62
-
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **id** | **Integer** | The deal id. | |
66
- | **dashboard_key** | **String** | The dashboard key. | [optional] |
67
-
68
- ### Return type
69
-
70
- **Object**
71
-
72
- ### Authorization
73
-
74
- No authorization required
75
-
76
- ### HTTP request headers
77
-
78
- - **Content-Type**: Not defined
79
- - **Accept**: application/json
80
-
81
-
82
11
  ## get_deal
83
12
 
84
13
  > <V1EntitiesDeal> get_deal(id)
data/docs/InvestorApi.md CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *http://api.dealmaker.tech*
11
11
  | [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
12
12
  | [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
13
13
  | [**edit_investor_tags**](InvestorApi.md#edit_investor_tags) | **POST** /deals/{id}/investors/{investor_id}/edit_tags | Append or replace tag(s) for a specific investor |
14
+ | [**get_enforcements**](InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search |
14
15
  | [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
15
16
  | [**get_investor_otp_link**](InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor |
16
17
  | [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
@@ -228,7 +229,7 @@ No authorization required
228
229
 
229
230
  ## create_investor
230
231
 
231
- > <V1EntitiesInvestor> create_investor(id, create_investor_request)
232
+ > <V1EntitiesInvestor> create_investor(id, deals_id_investors)
232
233
 
233
234
  Create a deal investor
234
235
 
@@ -244,11 +245,11 @@ DealMakerAPI.configure do |config|end
244
245
 
245
246
  api_instance = DealMakerAPI::InvestorApi.new
246
247
  id = 56 # Integer | The deal id.
247
- create_investor_request = DealMakerAPI::CreateInvestorRequest.new({email: 'email_example'}) # CreateInvestorRequest |
248
+ deals_id_investors = DealMakerAPI::PostDealsIdInvestors.new({email: 'email_example'}) # PostDealsIdInvestors |
248
249
 
249
250
  begin
250
251
  # Create a deal investor
251
- result = api_instance.create_investor(id, create_investor_request)
252
+ result = api_instance.create_investor(id, deals_id_investors)
252
253
  p result
253
254
  rescue DealMakerAPI::ApiError => e
254
255
  puts "Error when calling InvestorApi->create_investor: #{e}"
@@ -259,12 +260,12 @@ end
259
260
 
260
261
  This returns an Array which contains the response data, status code and headers.
261
262
 
262
- > <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, create_investor_request)
263
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, deals_id_investors)
263
264
 
264
265
  ```ruby
265
266
  begin
266
267
  # Create a deal investor
267
- data, status_code, headers = api_instance.create_investor_with_http_info(id, create_investor_request)
268
+ data, status_code, headers = api_instance.create_investor_with_http_info(id, deals_id_investors)
268
269
  p status_code # => 2xx
269
270
  p headers # => { ... }
270
271
  p data # => <V1EntitiesInvestor>
@@ -278,7 +279,7 @@ end
278
279
  | Name | Type | Description | Notes |
279
280
  | ---- | ---- | ----------- | ----- |
280
281
  | **id** | **Integer** | The deal id. | |
281
- | **create_investor_request** | [**CreateInvestorRequest**](CreateInvestorRequest.md) | | |
282
+ | **deals_id_investors** | [**PostDealsIdInvestors**](PostDealsIdInvestors.md) | | |
282
283
 
283
284
  ### Return type
284
285
 
@@ -500,6 +501,76 @@ No authorization required
500
501
  - **Accept**: application/json
501
502
 
502
503
 
504
+ ## get_enforcements
505
+
506
+ > <V1EntitiesInvestor> get_enforcements(id, investor_id, search_entity_id)
507
+
508
+ Get enforcements for a background search
509
+
510
+ Get enforcements for a background search
511
+
512
+ ### Examples
513
+
514
+ ```ruby
515
+ require 'time'
516
+ require 'DealMakerAPI'
517
+ # setup authorization
518
+ DealMakerAPI.configure do |config|end
519
+
520
+ api_instance = DealMakerAPI::InvestorApi.new
521
+ id = 56 # Integer |
522
+ investor_id = 56 # Integer |
523
+ search_entity_id = 56 # Integer |
524
+
525
+ begin
526
+ # Get enforcements for a background search
527
+ result = api_instance.get_enforcements(id, investor_id, search_entity_id)
528
+ p result
529
+ rescue DealMakerAPI::ApiError => e
530
+ puts "Error when calling InvestorApi->get_enforcements: #{e}"
531
+ end
532
+ ```
533
+
534
+ #### Using the get_enforcements_with_http_info variant
535
+
536
+ This returns an Array which contains the response data, status code and headers.
537
+
538
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> get_enforcements_with_http_info(id, investor_id, search_entity_id)
539
+
540
+ ```ruby
541
+ begin
542
+ # Get enforcements for a background search
543
+ data, status_code, headers = api_instance.get_enforcements_with_http_info(id, investor_id, search_entity_id)
544
+ p status_code # => 2xx
545
+ p headers # => { ... }
546
+ p data # => <V1EntitiesInvestor>
547
+ rescue DealMakerAPI::ApiError => e
548
+ puts "Error when calling InvestorApi->get_enforcements_with_http_info: #{e}"
549
+ end
550
+ ```
551
+
552
+ ### Parameters
553
+
554
+ | Name | Type | Description | Notes |
555
+ | ---- | ---- | ----------- | ----- |
556
+ | **id** | **Integer** | | |
557
+ | **investor_id** | **Integer** | | |
558
+ | **search_entity_id** | **Integer** | | |
559
+
560
+ ### Return type
561
+
562
+ [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
563
+
564
+ ### Authorization
565
+
566
+ No authorization required
567
+
568
+ ### HTTP request headers
569
+
570
+ - **Content-Type**: Not defined
571
+ - **Accept**: application/json
572
+
573
+
503
574
  ## get_investor
504
575
 
505
576
  > <V1EntitiesInvestor> get_investor(id, investor_id)
@@ -786,7 +857,7 @@ No authorization required
786
857
 
787
858
  ## update_investor
788
859
 
789
- > <V1EntitiesInvestor> update_investor(id, investor_id, opts)
860
+ > <V1EntitiesInvestor> update_investor(id, investor_id, deals_id_investors)
790
861
 
791
862
  Update a deal investor
792
863
 
@@ -803,13 +874,11 @@ DealMakerAPI.configure do |config|end
803
874
  api_instance = DealMakerAPI::InvestorApi.new
804
875
  id = 56 # Integer | The deal id.
805
876
  investor_id = 56 # Integer | The investor id.
806
- opts = {
807
- update_investor_request: DealMakerAPI::UpdateInvestorRequest.new # UpdateInvestorRequest |
808
- }
877
+ deals_id_investors = DealMakerAPI::PutDealsIdInvestors.new # PutDealsIdInvestors |
809
878
 
810
879
  begin
811
880
  # Update a deal investor
812
- result = api_instance.update_investor(id, investor_id, opts)
881
+ result = api_instance.update_investor(id, investor_id, deals_id_investors)
813
882
  p result
814
883
  rescue DealMakerAPI::ApiError => e
815
884
  puts "Error when calling InvestorApi->update_investor: #{e}"
@@ -820,12 +889,12 @@ end
820
889
 
821
890
  This returns an Array which contains the response data, status code and headers.
822
891
 
823
- > <Array(<V1EntitiesInvestor>, Integer, Hash)> update_investor_with_http_info(id, investor_id, opts)
892
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> update_investor_with_http_info(id, investor_id, deals_id_investors)
824
893
 
825
894
  ```ruby
826
895
  begin
827
896
  # Update a deal investor
828
- data, status_code, headers = api_instance.update_investor_with_http_info(id, investor_id, opts)
897
+ data, status_code, headers = api_instance.update_investor_with_http_info(id, investor_id, deals_id_investors)
829
898
  p status_code # => 2xx
830
899
  p headers # => { ... }
831
900
  p data # => <V1EntitiesInvestor>
@@ -840,7 +909,7 @@ end
840
909
  | ---- | ---- | ----------- | ----- |
841
910
  | **id** | **Integer** | The deal id. | |
842
911
  | **investor_id** | **Integer** | The investor id. | |
843
- | **update_investor_request** | [**UpdateInvestorRequest**](UpdateInvestorRequest.md) | | [optional] |
912
+ | **deals_id_investors** | [**PutDealsIdInvestors**](PutDealsIdInvestors.md) | | |
844
913
 
845
914
  ### Return type
846
915
 
@@ -1,4 +1,4 @@
1
- # DealMakerAPI::CreateInvestorRequest
1
+ # DealMakerAPI::PostDealsIdInvestors
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,6 @@
14
14
  | **warrant_expiry_date** | **Date** | The warrant expiry date of the investor. | [optional] |
15
15
  | **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
16
16
  | **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
17
- | **investment_value** | **Float** | The investment value of the investor. | [optional] |
18
17
  | **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to &#39;securities&#39;] |
19
18
  | **state** | **String** | The initial state of the investor. | [optional][default to &#39;invited&#39;] |
20
19
 
@@ -23,7 +22,7 @@
23
22
  ```ruby
24
23
  require 'DealMakerAPI'
25
24
 
26
- instance = DealMakerAPI::CreateInvestorRequest.new(
25
+ instance = DealMakerAPI::PostDealsIdInvestors.new(
27
26
  email: null,
28
27
  investor_profile_id: null,
29
28
  tags: null,
@@ -34,7 +33,6 @@ instance = DealMakerAPI::CreateInvestorRequest.new(
34
33
  warrant_expiry_date: null,
35
34
  warrant_certificate_number: null,
36
35
  allocated_amount: null,
37
- investment_value: null,
38
36
  allocation_unit: null,
39
37
  state: null
40
38
  )
@@ -1,4 +1,4 @@
1
- # DealMakerAPI::UpdateInvestorRequest
1
+ # DealMakerAPI::PutDealsIdInvestors
2
2
 
3
3
  ## Properties
4
4
 
@@ -8,7 +8,6 @@
8
8
  | **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
9
9
  | **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
10
10
  | **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to &#39;securities&#39;] |
11
- | **investment_value** | **Float** | The investment value of the investor. | [optional] |
12
11
  | **notes** | **String** | The notes of the investor. | [optional] |
13
12
 
14
13
  ## Example
@@ -16,12 +15,11 @@
16
15
  ```ruby
17
16
  require 'DealMakerAPI'
18
17
 
19
- instance = DealMakerAPI::UpdateInvestorRequest.new(
18
+ instance = DealMakerAPI::PutDealsIdInvestors.new(
20
19
  warrant_expiry_date: null,
21
20
  warrant_certificate_number: null,
22
21
  allocated_amount: null,
23
22
  allocation_unit: null,
24
- investment_value: null,
25
23
  notes: null
26
24
  )
27
25
  ```
@@ -7,7 +7,7 @@
7
7
  | **id** | **Integer** | The bulk upload ID | [optional] |
8
8
  | **company_id** | **Integer** | The company ID | [optional] |
9
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] |
10
+ | **document_type** | **String** | The document type | [optional] |
11
11
  | **upload_name** | **String** | The bulk upload name | [optional] |
12
12
  | **files_count** | **Integer** | The number of files in the bulk upload | [optional] |
13
13
  | **errors_count** | **Integer** | The number of errors in the bulk upload | [optional] |
@@ -0,0 +1,24 @@
1
+ # DealMakerAPI::V1EntitiesDividend
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | The dividend ID. | [optional] |
8
+ | **filename** | **String** | The dividend filename. | [optional] |
9
+ | **created_at** | **String** | The created at timestamp | [optional] |
10
+ | **statement_link** | **String** | The dividend statement link. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'DealMakerAPI'
16
+
17
+ instance = DealMakerAPI::V1EntitiesDividend.new(
18
+ id: null,
19
+ filename: null,
20
+ created_at: null,
21
+ statement_link: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::V1EntitiesDividends
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**V1EntitiesDividend**](V1EntitiesDividend.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::V1EntitiesDividends.new(
15
+ items: null
16
+ )
17
+ ```
18
+
@@ -737,5 +737,68 @@ module DealMakerAPI
737
737
  end
738
738
  return data, status_code, headers
739
739
  end
740
+
741
+ # Return dividends
742
+ # Return dividends associated with a shareholder
743
+ # @param company_id [Integer]
744
+ # @param [Hash] opts the optional parameters
745
+ # @return [V1EntitiesDividends]
746
+ def get_dividends(company_id, opts = {})
747
+ data, _status_code, _headers = get_dividends_with_http_info(company_id, opts)
748
+ data
749
+ end
750
+
751
+ # Return dividends
752
+ # Return dividends associated with a shareholder
753
+ # @param company_id [Integer]
754
+ # @param [Hash] opts the optional parameters
755
+ # @return [Array<(V1EntitiesDividends, Integer, Hash)>] V1EntitiesDividends data, response status code and response headers
756
+ def get_dividends_with_http_info(company_id, opts = {})
757
+ if @api_client.config.debugging
758
+ @api_client.config.logger.debug 'Calling API: CompanyApi.get_dividends ...'
759
+ end
760
+ # verify the required parameter 'company_id' is set
761
+ if @api_client.config.client_side_validation && company_id.nil?
762
+ fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_dividends"
763
+ end
764
+ # resource path
765
+ local_var_path = '/companies/{company_id}/portal/dividends'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))
766
+
767
+ # query parameters
768
+ query_params = opts[:query_params] || {}
769
+
770
+ # header parameters
771
+ header_params = opts[:header_params] || {}
772
+ # HTTP header 'Accept' (if needed)
773
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
774
+
775
+ # form parameters
776
+ form_params = opts[:form_params] || {}
777
+
778
+ # http body (model)
779
+ post_body = opts[:debug_body]
780
+
781
+ # return_type
782
+ return_type = opts[:debug_return_type] || 'V1EntitiesDividends'
783
+
784
+ # auth_names
785
+ auth_names = opts[:debug_auth_names] || []
786
+
787
+ new_options = opts.merge(
788
+ :operation => :"CompanyApi.get_dividends",
789
+ :header_params => header_params,
790
+ :query_params => query_params,
791
+ :form_params => form_params,
792
+ :body => post_body,
793
+ :auth_names => auth_names,
794
+ :return_type => return_type
795
+ )
796
+
797
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
798
+ if @api_client.config.debugging
799
+ @api_client.config.logger.debug "API called: CompanyApi#get_dividends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
800
+ end
801
+ return data, status_code, headers
802
+ end
740
803
  end
741
804
  end