DealMakerAPI 0.96.0 → 0.96.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/DealMakerAPI.gemspec +1 -1
- data/README.md +7 -4
- data/docs/CompanyApi.md +67 -0
- data/docs/V1EntitiesEmailEvent.md +30 -0
- data/docs/V1EntitiesEmailEvents.md +20 -0
- data/lib/DealMakerAPI/api/company_api.rb +64 -1
- data/lib/DealMakerAPI/api/country_api.rb +1 -1
- data/lib/DealMakerAPI/api/custom_emails_api.rb +1 -1
- data/lib/DealMakerAPI/api/deal_api.rb +1 -1
- data/lib/DealMakerAPI/api/deals_api.rb +1 -1
- data/lib/DealMakerAPI/api/default_api.rb +1 -1
- data/lib/DealMakerAPI/api/incentive_plan_api.rb +1 -1
- data/lib/DealMakerAPI/api/investor_api.rb +1 -1
- data/lib/DealMakerAPI/api/investor_profile_api.rb +1 -1
- data/lib/DealMakerAPI/api/shareholder_api.rb +1 -1
- data/lib/DealMakerAPI/api/upload_api.rb +1 -1
- data/lib/DealMakerAPI/api/user_api.rb +1 -1
- data/lib/DealMakerAPI/api/users_api.rb +1 -1
- data/lib/DealMakerAPI/api_client.rb +1 -1
- data/lib/DealMakerAPI/api_error.rb +1 -1
- data/lib/DealMakerAPI/configuration.rb +1 -1
- data/lib/DealMakerAPI/models/add506c_document_request.rb +1 -1
- data/lib/DealMakerAPI/models/add_document_request.rb +1 -1
- data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_company_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_deal_setup_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_shareholder_action_request.rb +1 -1
- data/lib/DealMakerAPI/models/edit_investor_tags_request.rb +1 -1
- data/lib/DealMakerAPI/models/generate_url_request.rb +1 -1
- data/lib/DealMakerAPI/models/get_access_token_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_deal_incentive_plan_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_corporations.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_individuals.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_joints.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_request.rb +1 -1
- data/lib/DealMakerAPI/models/post_deal_incentive_plan_request.rb +1 -1
- data/lib/DealMakerAPI/models/post_deals_id_investors.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_corporations.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_individuals.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_joints.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_managed.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_trusts.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner.rb +1 -1
- data/lib/DealMakerAPI/models/post_webhooks_request.rb +1 -1
- data/lib/DealMakerAPI/models/put_deals_id_investors.rb +1 -1
- data/lib/DealMakerAPI/models/put_deals_id_script_tag_environment_request.rb +1 -1
- data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +1 -1
- data/lib/DealMakerAPI/models/run_background_search_request.rb +1 -1
- data/lib/DealMakerAPI/models/send_portal_invite_request.rb +1 -1
- data/lib/DealMakerAPI/models/update_user_password_request.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_address.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_addresses.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_attachment.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_beefree_access_token.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_details.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_uploads.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_countries.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_country.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_incentive_plan.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_incentive_plans_incentive_tier.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_price_details.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_dividend.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_dividends.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_email_event.rb +275 -0
- data/lib/DealMakerAPI/models/v1_entities_email_events.rb +225 -0
- data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_generic_response.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_otp_access_link.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficial_owner.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_provider.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_signing_officer.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trustee.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_id.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_managed.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_owner.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investors.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_money_entity.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholders.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholders_tags.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_state.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +1 -1
- data/lib/DealMakerAPI/version.rb +2 -2
- data/lib/DealMakerAPI.rb +3 -1
- data/spec/api/company_api_spec.rb +13 -1
- data/spec/api/country_api_spec.rb +1 -1
- data/spec/api/custom_emails_api_spec.rb +1 -1
- data/spec/api/deal_api_spec.rb +1 -1
- data/spec/api/deals_api_spec.rb +1 -1
- data/spec/api/default_api_spec.rb +1 -1
- data/spec/api/incentive_plan_api_spec.rb +1 -1
- data/spec/api/investor_api_spec.rb +1 -1
- data/spec/api/investor_profile_api_spec.rb +1 -1
- data/spec/api/shareholder_api_spec.rb +1 -1
- data/spec/api/upload_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/models/add506c_document_request_spec.rb +1 -1
- data/spec/models/add_document_request_spec.rb +1 -1
- data/spec/models/bulk_upload_investors_request_spec.rb +1 -1
- data/spec/models/create_bulk_upload_detail_request_spec.rb +1 -1
- data/spec/models/create_bulk_upload_request_spec.rb +1 -1
- data/spec/models/create_company_request_spec.rb +1 -1
- data/spec/models/create_deal_setup_request_spec.rb +1 -1
- data/spec/models/create_shareholder_action_request_spec.rb +1 -1
- data/spec/models/edit_investor_tags_request_spec.rb +1 -1
- data/spec/models/generate_url_request_spec.rb +1 -1
- data/spec/models/get_access_token_request_spec.rb +1 -1
- data/spec/models/patch_deal_incentive_plan_request_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_corporations_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_individuals_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_joints_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_trusts_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb +1 -1
- data/spec/models/patch_investor_request_spec.rb +1 -1
- data/spec/models/post_deal_incentive_plan_request_spec.rb +1 -1
- data/spec/models/post_deals_id_investors_spec.rb +1 -1
- data/spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb +1 -1
- data/spec/models/post_investor_profiles_corporations_spec.rb +1 -1
- data/spec/models/post_investor_profiles_individuals_spec.rb +1 -1
- data/spec/models/post_investor_profiles_joints_spec.rb +1 -1
- data/spec/models/post_investor_profiles_managed_spec.rb +1 -1
- data/spec/models/post_investor_profiles_trusts_spec.rb +1 -1
- data/spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb +1 -1
- data/spec/models/post_webhooks_request_spec.rb +1 -1
- data/spec/models/put_deals_id_investors_spec.rb +1 -1
- data/spec/models/put_deals_id_script_tag_environment_request_spec.rb +1 -1
- data/spec/models/put_webhooks_id_request_spec.rb +1 -1
- data/spec/models/run_background_search_request_spec.rb +1 -1
- data/spec/models/send_portal_invite_request_spec.rb +1 -1
- data/spec/models/update_user_password_request_spec.rb +1 -1
- data/spec/models/v1_entities_address_spec.rb +1 -1
- data/spec/models/v1_entities_addresses_spec.rb +1 -1
- data/spec/models/v1_entities_attachment_spec.rb +1 -1
- data/spec/models/v1_entities_background_check_search_spec.rb +1 -1
- data/spec/models/v1_entities_beefree_access_token_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_upload_detail_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_upload_details_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_upload_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_uploads_spec.rb +1 -1
- data/spec/models/v1_entities_company_deal_spec.rb +1 -1
- data/spec/models/v1_entities_company_deals_spec.rb +1 -1
- data/spec/models/v1_entities_company_spec.rb +1 -1
- data/spec/models/v1_entities_countries_spec.rb +1 -1
- data/spec/models/v1_entities_country_spec.rb +1 -1
- data/spec/models/v1_entities_deal_enterprise_spec.rb +1 -1
- data/spec/models/v1_entities_deal_funding_metrics_spec.rb +1 -1
- data/spec/models/v1_entities_deal_investor_metrics_spec.rb +1 -1
- data/spec/models/v1_entities_deal_issuer_spec.rb +1 -1
- data/spec/models/v1_entities_deal_setup_spec.rb +1 -1
- data/spec/models/v1_entities_deal_setup_user_spec.rb +1 -1
- data/spec/models/v1_entities_deal_spec.rb +1 -1
- data/spec/models/v1_entities_deals_incentive_plan_spec.rb +1 -1
- data/spec/models/v1_entities_deals_incentive_plans_incentive_tier_spec.rb +1 -1
- data/spec/models/v1_entities_deals_price_details_spec.rb +1 -1
- data/spec/models/v1_entities_deals_spec.rb +1 -1
- data/spec/models/v1_entities_dividend_spec.rb +1 -1
- data/spec/models/v1_entities_dividends_spec.rb +1 -1
- data/spec/models/v1_entities_email_event_spec.rb +72 -0
- data/spec/models/v1_entities_email_events_spec.rb +42 -0
- data/spec/models/v1_entities_express_wire_instruction_spec.rb +1 -1
- data/spec/models/v1_entities_express_wire_instructions_spec.rb +1 -1
- data/spec/models/v1_entities_generic_response_spec.rb +1 -1
- data/spec/models/v1_entities_investor_otp_access_link_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_address_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_provider_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_trustee_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_id_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_item_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_managed_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_owner_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profiles_spec.rb +1 -1
- data/spec/models/v1_entities_investor_spec.rb +1 -1
- data/spec/models/v1_entities_investor_user_spec.rb +1 -1
- data/spec/models/v1_entities_investors_spec.rb +1 -1
- data/spec/models/v1_entities_money_entity_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result_spec.rb +1 -1
- data/spec/models/v1_entities_presigned_url_result_spec.rb +1 -1
- data/spec/models/v1_entities_shareholder_spec.rb +1 -1
- data/spec/models/v1_entities_shareholders_spec.rb +1 -1
- data/spec/models/v1_entities_shareholders_tags_spec.rb +1 -1
- data/spec/models/v1_entities_state_spec.rb +1 -1
- data/spec/models/v1_entities_subscription_agreement_spec.rb +1 -1
- data/spec/models/v1_entities_user_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_deal_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_security_token_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +105 -97
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 31e2c4cf19ee6914ad1014cde2fd2a077a302eb8e955b2a8a6f1cdf521a3a302
|
4
|
+
data.tar.gz: 7dd4406c415591d00d062f4418f6a0b07d36b16d0441e576638c52860ce5b462
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2a407f13bed84ad1fd1cedea0754781121ed40b60fefe9a97a6d9b5a35f92bc738c0445d9e83c34f043942974656a337d06555dbe257014d2bb81808c9986381
|
7
|
+
data.tar.gz: 671ae1644aac29004e3ad8890f1ac9b4d8d7f8ec98d461ebaa76ff24f4e10f7903b7a8b4035637ce51f0f7d87b36626bf44172257c838cf8aaeb117ef8a1a61b
|
data/DealMakerAPI.gemspec
CHANGED
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.96.
|
341
|
+
- Package version: 0.96.1
|
342
342
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
343
343
|
|
344
344
|
## Installation
|
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
|
|
354
354
|
Then either install the gem locally:
|
355
355
|
|
356
356
|
```shell
|
357
|
-
gem install ./DealMakerAPI-0.96.
|
357
|
+
gem install ./DealMakerAPI-0.96.1.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.96.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.96.1.gem` to install the development dependencies)
|
361
361
|
|
362
362
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
363
363
|
|
364
364
|
Finally add this to the Gemfile:
|
365
365
|
|
366
|
-
gem 'DealMakerAPI', '~> 0.96.
|
366
|
+
gem 'DealMakerAPI', '~> 0.96.1'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -421,6 +421,7 @@ Class | Method | HTTP request | Description
|
|
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
423
|
*DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
|
424
|
+
*DealMakerAPI::CompanyApi* | [**get_email_events**](docs/CompanyApi.md#get_email_events) | **GET** /companies/{company_communication_id}/email_events | Get a list of email events for a company communication
|
424
425
|
*DealMakerAPI::CompanyApi* | [**get_user_accessible_companies**](docs/CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user
|
425
426
|
*DealMakerAPI::CompanyApi* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
|
426
427
|
*DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
|
@@ -546,6 +547,8 @@ Class | Method | HTTP request | Description
|
|
546
547
|
- [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
|
547
548
|
- [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
|
548
549
|
- [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
|
550
|
+
- [DealMakerAPI::V1EntitiesEmailEvent](docs/V1EntitiesEmailEvent.md)
|
551
|
+
- [DealMakerAPI::V1EntitiesEmailEvents](docs/V1EntitiesEmailEvents.md)
|
549
552
|
- [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
|
550
553
|
- [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
|
551
554
|
- [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
|
data/docs/CompanyApi.md
CHANGED
@@ -15,6 +15,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
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
17
|
| [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
|
18
|
+
| [**get_email_events**](CompanyApi.md#get_email_events) | **GET** /companies/{company_communication_id}/email_events | Get a list of email events for a company communication |
|
18
19
|
| [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
|
19
20
|
| [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
|
20
21
|
|
@@ -783,6 +784,72 @@ No authorization required
|
|
783
784
|
- **Accept**: application/json
|
784
785
|
|
785
786
|
|
787
|
+
## get_email_events
|
788
|
+
|
789
|
+
> <V1EntitiesEmailEvents> get_email_events(company_communication_id)
|
790
|
+
|
791
|
+
Get a list of email events for a company communication
|
792
|
+
|
793
|
+
Gets a list of email events for a specific company communication.
|
794
|
+
|
795
|
+
### Examples
|
796
|
+
|
797
|
+
```ruby
|
798
|
+
require 'time'
|
799
|
+
require 'DealMakerAPI'
|
800
|
+
# setup authorization
|
801
|
+
DealMakerAPI.configure do |config|end
|
802
|
+
|
803
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
804
|
+
company_communication_id = 56 # Integer | The id of the company communication.
|
805
|
+
|
806
|
+
begin
|
807
|
+
# Get a list of email events for a company communication
|
808
|
+
result = api_instance.get_email_events(company_communication_id)
|
809
|
+
p result
|
810
|
+
rescue DealMakerAPI::ApiError => e
|
811
|
+
puts "Error when calling CompanyApi->get_email_events: #{e}"
|
812
|
+
end
|
813
|
+
```
|
814
|
+
|
815
|
+
#### Using the get_email_events_with_http_info variant
|
816
|
+
|
817
|
+
This returns an Array which contains the response data, status code and headers.
|
818
|
+
|
819
|
+
> <Array(<V1EntitiesEmailEvents>, Integer, Hash)> get_email_events_with_http_info(company_communication_id)
|
820
|
+
|
821
|
+
```ruby
|
822
|
+
begin
|
823
|
+
# Get a list of email events for a company communication
|
824
|
+
data, status_code, headers = api_instance.get_email_events_with_http_info(company_communication_id)
|
825
|
+
p status_code # => 2xx
|
826
|
+
p headers # => { ... }
|
827
|
+
p data # => <V1EntitiesEmailEvents>
|
828
|
+
rescue DealMakerAPI::ApiError => e
|
829
|
+
puts "Error when calling CompanyApi->get_email_events_with_http_info: #{e}"
|
830
|
+
end
|
831
|
+
```
|
832
|
+
|
833
|
+
### Parameters
|
834
|
+
|
835
|
+
| Name | Type | Description | Notes |
|
836
|
+
| ---- | ---- | ----------- | ----- |
|
837
|
+
| **company_communication_id** | **Integer** | The id of the company communication. | |
|
838
|
+
|
839
|
+
### Return type
|
840
|
+
|
841
|
+
[**V1EntitiesEmailEvents**](V1EntitiesEmailEvents.md)
|
842
|
+
|
843
|
+
### Authorization
|
844
|
+
|
845
|
+
No authorization required
|
846
|
+
|
847
|
+
### HTTP request headers
|
848
|
+
|
849
|
+
- **Content-Type**: Not defined
|
850
|
+
- **Accept**: application/json
|
851
|
+
|
852
|
+
|
786
853
|
## get_user_accessible_companies
|
787
854
|
|
788
855
|
> <V1EntitiesCompany> get_user_accessible_companies(opts)
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesEmailEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The id of the email event. | [optional] |
|
8
|
+
| **name** | **String** | The name of the shareholder. | [optional] |
|
9
|
+
| **email** | **String** | The email of the shareholder. | [optional] |
|
10
|
+
| **delivered** | **Integer** | The number of email delivered. | [optional] |
|
11
|
+
| **opened** | **Integer** | The number of email opened. | [optional] |
|
12
|
+
| **clicked** | **Integer** | The number of email clicked. | [optional] |
|
13
|
+
| **bounced** | **Integer** | The number of email bounced. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'DealMakerAPI'
|
19
|
+
|
20
|
+
instance = DealMakerAPI::V1EntitiesEmailEvent.new(
|
21
|
+
id: null,
|
22
|
+
name: null,
|
23
|
+
email: null,
|
24
|
+
delivered: null,
|
25
|
+
opened: null,
|
26
|
+
clicked: null,
|
27
|
+
bounced: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesEmailEvents
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **rows** | [**V1EntitiesEmailEvent**](V1EntitiesEmailEvent.md) | | [optional] |
|
8
|
+
| **rows_count** | **Integer** | The number of email events. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesEmailEvents.new(
|
16
|
+
rows: null,
|
17
|
+
rows_count: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.75.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 7.3.0
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -801,6 +801,69 @@ module DealMakerAPI
|
|
801
801
|
return data, status_code, headers
|
802
802
|
end
|
803
803
|
|
804
|
+
# Get a list of email events for a company communication
|
805
|
+
# Gets a list of email events for a specific company communication.
|
806
|
+
# @param company_communication_id [Integer] The id of the company communication.
|
807
|
+
# @param [Hash] opts the optional parameters
|
808
|
+
# @return [V1EntitiesEmailEvents]
|
809
|
+
def get_email_events(company_communication_id, opts = {})
|
810
|
+
data, _status_code, _headers = get_email_events_with_http_info(company_communication_id, opts)
|
811
|
+
data
|
812
|
+
end
|
813
|
+
|
814
|
+
# Get a list of email events for a company communication
|
815
|
+
# Gets a list of email events for a specific company communication.
|
816
|
+
# @param company_communication_id [Integer] The id of the company communication.
|
817
|
+
# @param [Hash] opts the optional parameters
|
818
|
+
# @return [Array<(V1EntitiesEmailEvents, Integer, Hash)>] V1EntitiesEmailEvents data, response status code and response headers
|
819
|
+
def get_email_events_with_http_info(company_communication_id, opts = {})
|
820
|
+
if @api_client.config.debugging
|
821
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_email_events ...'
|
822
|
+
end
|
823
|
+
# verify the required parameter 'company_communication_id' is set
|
824
|
+
if @api_client.config.client_side_validation && company_communication_id.nil?
|
825
|
+
fail ArgumentError, "Missing the required parameter 'company_communication_id' when calling CompanyApi.get_email_events"
|
826
|
+
end
|
827
|
+
# resource path
|
828
|
+
local_var_path = '/companies/{company_communication_id}/email_events'.sub('{' + 'company_communication_id' + '}', CGI.escape(company_communication_id.to_s))
|
829
|
+
|
830
|
+
# query parameters
|
831
|
+
query_params = opts[:query_params] || {}
|
832
|
+
|
833
|
+
# header parameters
|
834
|
+
header_params = opts[:header_params] || {}
|
835
|
+
# HTTP header 'Accept' (if needed)
|
836
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
837
|
+
|
838
|
+
# form parameters
|
839
|
+
form_params = opts[:form_params] || {}
|
840
|
+
|
841
|
+
# http body (model)
|
842
|
+
post_body = opts[:debug_body]
|
843
|
+
|
844
|
+
# return_type
|
845
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesEmailEvents'
|
846
|
+
|
847
|
+
# auth_names
|
848
|
+
auth_names = opts[:debug_auth_names] || []
|
849
|
+
|
850
|
+
new_options = opts.merge(
|
851
|
+
:operation => :"CompanyApi.get_email_events",
|
852
|
+
:header_params => header_params,
|
853
|
+
:query_params => query_params,
|
854
|
+
:form_params => form_params,
|
855
|
+
:body => post_body,
|
856
|
+
:auth_names => auth_names,
|
857
|
+
:return_type => return_type
|
858
|
+
)
|
859
|
+
|
860
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
861
|
+
if @api_client.config.debugging
|
862
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_email_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
863
|
+
end
|
864
|
+
return data, status_code, headers
|
865
|
+
end
|
866
|
+
|
804
867
|
# Get list of all Companies accessible by the user
|
805
868
|
# Get user accessible companies
|
806
869
|
# @param [Hash] opts the optional parameters
|