DealMakerAPI 0.87.0 → 0.88.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14d46335ad9cfe99a600ab9c779e08bfbed7a43b64a96cf198e2dd04ee9f733
-  data.tar.gz: 4e8510f9519829952c16737c6640c827017e9f363f5cc6d752ad6c962085b9e5
+  metadata.gz: 8070bb6ae387e51ce5530185029b8246a3befd9cb201cbfca7090d46185b9ee5
+  data.tar.gz: 720c5d04f3e5fe1bb2023415d7bbf91e85825c59c197d833384c112b55d1afd4
 SHA512:
-  metadata.gz: 151e39224e953a63479097c14a41dba18607375d58311954352cb7d77f8b27edcea9a06437690cdb0ce46db79f43371d319fd522f6ea538feeced796cff0c5c6
-  data.tar.gz: 1a7e3ffdd098c2527e6f9e6d02e2d52c1cc5a379ea612a425277095fc4bc6d207b2b3e10096aa5677be1be5478867bc9e19012f404f8cab77d836bfd33d42c31
+  metadata.gz: e4967c396b77093a9908b353e72cd4e3da11847e0b4d5e9eceaff93ad95ae59020ba22ee5657ffac68b885f6c17047cd9bceecbb20814ceb0a0094bb6aa3672c
+  data.tar.gz: 9d78e3e816371ae8754c15620e280a1ad215a3d2417f2e31de740d36100a41628fa6a4b1332c32e7987ec1555284205ccad865269ac5698f463643e3599dcd7d

data/README.md

@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.75.0
-- Package version: 0.87.0
+- Package version: 0.88.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.87.0.gem
+gem install ./DealMakerAPI-0.88.1.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.87.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.88.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'DealMakerAPI', '~> 0.87.0'
+    gem 'DealMakerAPI', '~> 0.88.1'
 
 ### Install from Git
 
@@ -420,8 +420,8 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
 *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
 *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
+*DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
 *DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
-*DealMakerAPI::DealApi* | [**get_analytics_dashboard_info**](docs/DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info
 *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
 *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
 *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
 *DealMakerAPI::InvestorApi* | [**delete_document**](docs/InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor
 *DealMakerAPI::InvestorApi* | [**delete_investor_profile**](docs/InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile.
 *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
+*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
 *DealMakerAPI::InvestorApi* | [**get_investor**](docs/InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id
 *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
 *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
  - [DealMakerAPI::CreateBulkUploadRequest](docs/CreateBulkUploadRequest.md)
  - [DealMakerAPI::CreateCompanyRequest](docs/CreateCompanyRequest.md)
  - [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
- - [DealMakerAPI::CreateInvestorRequest](docs/CreateInvestorRequest.md)
  - [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
  - [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
  - [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
@@ -482,6 +482,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::PatchInvestorProfilesJoints](docs/PatchInvestorProfilesJoints.md)
  - [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
  - [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
+ - [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
  - [DealMakerAPI::PostInvestorProfilesCorporations](docs/PostInvestorProfilesCorporations.md)
  - [DealMakerAPI::PostInvestorProfilesCorporationsBeneficialOwnersInner](docs/PostInvestorProfilesCorporationsBeneficialOwnersInner.md)
  - [DealMakerAPI::PostInvestorProfilesIndividuals](docs/PostInvestorProfilesIndividuals.md)
@@ -489,9 +490,9 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::PostInvestorProfilesTrusts](docs/PostInvestorProfilesTrusts.md)
  - [DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner](docs/PostInvestorProfilesTrustsTrusteesInner.md)
  - [DealMakerAPI::PostWebhooksRequest](docs/PostWebhooksRequest.md)
+ - [DealMakerAPI::PutDealsIdInvestors](docs/PutDealsIdInvestors.md)
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
- - [DealMakerAPI::UpdateInvestorRequest](docs/UpdateInvestorRequest.md)
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -513,6 +514,8 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::V1EntitiesDealSetup](docs/V1EntitiesDealSetup.md)
  - [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
  - [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
+ - [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
+ - [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
  - [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
  - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
  - [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)

data/docs/CompanyApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
 | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
 | [**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 |
+| [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
 
 
 ## create_bulk_upload
@@ -713,3 +714,69 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## get_dividends
+
+> <V1EntitiesDividends> get_dividends(company_id)
+
+Return dividends
+
+Return dividends associated with a shareholder
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::CompanyApi.new
+company_id = 56 # Integer | 
+
+begin
+  # Return dividends
+  result = api_instance.get_dividends(company_id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_dividends: #{e}"
+end
+```
+
+#### Using the get_dividends_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesDividends>, Integer, Hash)> get_dividends_with_http_info(company_id)
+
+```ruby
+begin
+  # Return dividends
+  data, status_code, headers = api_instance.get_dividends_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesDividends>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling CompanyApi->get_dividends_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesDividends**](V1EntitiesDividends.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DealApi.md

@@ -4,81 +4,10 @@ All URIs are relative to *http://api.dealmaker.tech*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_analytics_dashboard_info**](DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info |
 | [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
 | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
 
 
-## get_analytics_dashboard_info
-
-> Object get_analytics_dashboard_info(id, opts)
-
-Get Analytics Dashboard Info
-
-Get Analytics Dashboard Info
-
-### Examples
-
-```ruby
-require 'time'
-require 'DealMakerAPI'
-# setup authorization
-DealMakerAPI.configure do |config|end
-
-api_instance = DealMakerAPI::DealApi.new
-id = 56 # Integer | The deal id.
-opts = {
-  dashboard_key: 'dashboard_key_example' # String | The dashboard key.
-}
-
-begin
-  # Get Analytics Dashboard Info
-  result = api_instance.get_analytics_dashboard_info(id, opts)
-  p result
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->get_analytics_dashboard_info: #{e}"
-end
-```
-
-#### Using the get_analytics_dashboard_info_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> get_analytics_dashboard_info_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Analytics Dashboard Info
-  data, status_code, headers = api_instance.get_analytics_dashboard_info_with_http_info(id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->get_analytics_dashboard_info_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | The deal id. |  |
-| **dashboard_key** | **String** | The dashboard key. | [optional] |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## get_deal
 
 > <V1EntitiesDeal> get_deal(id)

data/docs/InvestorApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**delete_document**](InvestorApi.md#delete_document) | **DELETE** /deals/{id}/investors/{investor_id}/delete_document/{document_id} | Delete document for deal investor |
 | [**delete_investor_profile**](InvestorApi.md#delete_investor_profile) | **DELETE** /investor_profiles/{type}/{id} | Delete investor profile. |
 | [**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 |
+| [**get_enforcements**](InvestorApi.md#get_enforcements) | **GET** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements | Get enforcements for a background search |
 | [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
 | [**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 |
 | [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
@@ -228,7 +229,7 @@ No authorization required
 
 ## create_investor
 
-> <V1EntitiesInvestor> create_investor(id, create_investor_request)
+> <V1EntitiesInvestor> create_investor(id, deals_id_investors)
 
 Create a deal investor
 
@@ -244,11 +245,11 @@ DealMakerAPI.configure do |config|end
 
 api_instance = DealMakerAPI::InvestorApi.new
 id = 56 # Integer | The deal id.
-create_investor_request = DealMakerAPI::CreateInvestorRequest.new({email: 'email_example'}) # CreateInvestorRequest | 
+deals_id_investors = DealMakerAPI::PostDealsIdInvestors.new({email: 'email_example'}) # PostDealsIdInvestors | 
 
 begin
   # Create a deal investor
-  result = api_instance.create_investor(id, create_investor_request)
+  result = api_instance.create_investor(id, deals_id_investors)
   p result
 rescue DealMakerAPI::ApiError => e
   puts "Error when calling InvestorApi->create_investor: #{e}"
@@ -259,12 +260,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, create_investor_request)
+> <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, deals_id_investors)
 
 ```ruby
 begin
   # Create a deal investor
-  data, status_code, headers = api_instance.create_investor_with_http_info(id, create_investor_request)
+  data, status_code, headers = api_instance.create_investor_with_http_info(id, deals_id_investors)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <V1EntitiesInvestor>
@@ -278,7 +279,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The deal id. |  |
-| **create_investor_request** | [**CreateInvestorRequest**](CreateInvestorRequest.md) |  |  |
+| **deals_id_investors** | [**PostDealsIdInvestors**](PostDealsIdInvestors.md) |  |  |
 
 ### Return type
 
@@ -500,6 +501,76 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_enforcements
+
+> <V1EntitiesInvestor> get_enforcements(id, investor_id, search_entity_id)
+
+Get enforcements for a background search
+
+Get enforcements for a background search
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::InvestorApi.new
+id = 56 # Integer | 
+investor_id = 56 # Integer | 
+search_entity_id = 56 # Integer | 
+
+begin
+  # Get enforcements for a background search
+  result = api_instance.get_enforcements(id, investor_id, search_entity_id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling InvestorApi->get_enforcements: #{e}"
+end
+```
+
+#### Using the get_enforcements_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesInvestor>, Integer, Hash)> get_enforcements_with_http_info(id, investor_id, search_entity_id)
+
+```ruby
+begin
+  # Get enforcements for a background search
+  data, status_code, headers = api_instance.get_enforcements_with_http_info(id, investor_id, search_entity_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesInvestor>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling InvestorApi->get_enforcements_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **investor_id** | **Integer** |  |  |
+| **search_entity_id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_investor
 
 > <V1EntitiesInvestor> get_investor(id, investor_id)
@@ -786,7 +857,7 @@ No authorization required
 
 ## update_investor
 
-> <V1EntitiesInvestor> update_investor(id, investor_id, opts)
+> <V1EntitiesInvestor> update_investor(id, investor_id, deals_id_investors)
 
 Update a deal investor
 
@@ -803,13 +874,11 @@ DealMakerAPI.configure do |config|end
 api_instance = DealMakerAPI::InvestorApi.new
 id = 56 # Integer | The deal id.
 investor_id = 56 # Integer | The investor id.
-opts = {
-  update_investor_request: DealMakerAPI::UpdateInvestorRequest.new # UpdateInvestorRequest | 
-}
+deals_id_investors = DealMakerAPI::PutDealsIdInvestors.new # PutDealsIdInvestors | 
 
 begin
   # Update a deal investor
-  result = api_instance.update_investor(id, investor_id, opts)
+  result = api_instance.update_investor(id, investor_id, deals_id_investors)
   p result
 rescue DealMakerAPI::ApiError => e
   puts "Error when calling InvestorApi->update_investor: #{e}"
@@ -820,12 +889,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1EntitiesInvestor>, Integer, Hash)> update_investor_with_http_info(id, investor_id, opts)
+> <Array(<V1EntitiesInvestor>, Integer, Hash)> update_investor_with_http_info(id, investor_id, deals_id_investors)
 
 ```ruby
 begin
   # Update a deal investor
-  data, status_code, headers = api_instance.update_investor_with_http_info(id, investor_id, opts)
+  data, status_code, headers = api_instance.update_investor_with_http_info(id, investor_id, deals_id_investors)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <V1EntitiesInvestor>
@@ -840,7 +909,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | The deal id. |  |
 | **investor_id** | **Integer** | The investor id. |  |
-| **update_investor_request** | [**UpdateInvestorRequest**](UpdateInvestorRequest.md) |  | [optional] |
+| **deals_id_investors** | [**PutDealsIdInvestors**](PutDealsIdInvestors.md) |  |  |
 
 ### Return type
 

data/docs/{CreateInvestorRequest.md → PostDealsIdInvestors.md}

@@ -1,4 +1,4 @@
-# DealMakerAPI::CreateInvestorRequest
+# DealMakerAPI::PostDealsIdInvestors
 
 ## Properties
 
@@ -14,7 +14,6 @@
 | **warrant_expiry_date** | **Date** | The warrant expiry date of the investor. | [optional] |
 | **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
 | **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
-| **investment_value** | **Float** | The investment value of the investor. | [optional] |
 | **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
 | **state** | **String** | The initial state of the investor. | [optional][default to 'invited'] |
 
@@ -23,7 +22,7 @@
 ```ruby
 require 'DealMakerAPI'
 
-instance = DealMakerAPI::CreateInvestorRequest.new(
+instance = DealMakerAPI::PostDealsIdInvestors.new(
   email: null,
   investor_profile_id: null,
   tags: null,
@@ -34,7 +33,6 @@ instance = DealMakerAPI::CreateInvestorRequest.new(
   warrant_expiry_date: null,
   warrant_certificate_number: null,
   allocated_amount: null,
-  investment_value: null,
   allocation_unit: null,
   state: null
 )

data/docs/{UpdateInvestorRequest.md → PutDealsIdInvestors.md}

@@ -1,4 +1,4 @@
-# DealMakerAPI::UpdateInvestorRequest
+# DealMakerAPI::PutDealsIdInvestors
 
 ## Properties
 
@@ -8,7 +8,6 @@
 | **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
 | **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
 | **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
-| **investment_value** | **Float** | The investment value of the investor. | [optional] |
 | **notes** | **String** | The notes of the investor. | [optional] |
 
 ## Example
@@ -16,12 +15,11 @@
 ```ruby
 require 'DealMakerAPI'
 
-instance = DealMakerAPI::UpdateInvestorRequest.new(
+instance = DealMakerAPI::PutDealsIdInvestors.new(
   warrant_expiry_date: null,
   warrant_certificate_number: null,
   allocated_amount: null,
   allocation_unit: null,
-  investment_value: null,
   notes: null
 )
 ```

data/docs/V1EntitiesBulkUpload.md

@@ -7,7 +7,7 @@
 | **id** | **Integer** | The bulk upload ID | [optional] |
 | **company_id** | **Integer** | The company ID | [optional] |
 | **file_identifier** | **String** | The file identifier [shareholder, investor] | [optional] |
-| **document_type** | **String** | The document type [drs_statement, shareholder_statement, book_entry_statement] | [optional] |
+| **document_type** | **String** | The document type  | [optional] |
 | **upload_name** | **String** | The bulk upload name | [optional] |
 | **files_count** | **Integer** | The number of files in the bulk upload | [optional] |
 | **errors_count** | **Integer** | The number of errors in the bulk upload | [optional] |

data/docs/V1EntitiesDividend.md

@@ -0,0 +1,24 @@
+# DealMakerAPI::V1EntitiesDividend
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The dividend ID. | [optional] |
+| **filename** | **String** | The dividend filename. | [optional] |
+| **created_at** | **String** | The created at timestamp | [optional] |
+| **statement_link** | **String** | The dividend statement link. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDividend.new(
+  id: null,
+  filename: null,
+  created_at: null,
+  statement_link: null
+)
+```
+

data/docs/V1EntitiesDividends.md

@@ -0,0 +1,18 @@
+# DealMakerAPI::V1EntitiesDividends
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**V1EntitiesDividend**](V1EntitiesDividend.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::V1EntitiesDividends.new(
+  items: null
+)
+```
+

data/lib/DealMakerAPI/api/company_api.rb

@@ -737,5 +737,68 @@ module DealMakerAPI
       end
       return data, status_code, headers
     end
+
+    # Return dividends
+    # Return dividends associated with a shareholder
+    # @param company_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [V1EntitiesDividends]
+    def get_dividends(company_id, opts = {})
+      data, _status_code, _headers = get_dividends_with_http_info(company_id, opts)
+      data
+    end
+
+    # Return dividends
+    # Return dividends associated with a shareholder
+    # @param company_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EntitiesDividends, Integer, Hash)>] V1EntitiesDividends data, response status code and response headers
+    def get_dividends_with_http_info(company_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompanyApi.get_dividends ...'
+      end
+      # verify the required parameter 'company_id' is set
+      if @api_client.config.client_side_validation && company_id.nil?
+        fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_dividends"
+      end
+      # resource path
+      local_var_path = '/companies/{company_id}/portal/dividends'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesDividends'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CompanyApi.get_dividends",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#get_dividends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end