DealMakerAPI 0.98.2 → 0.98.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.
- checksums.yaml +4 -4
- data/DealMakerAPI.gemspec +1 -1
- data/README.md +7 -4
- data/docs/CompanyApi.md +144 -0
- data/docs/V1EntitiesEmailTemplate.md +3 -1
- data/lib/DealMakerAPI/api/company_api.rb +142 -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_email_template_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 +1 -1
- data/lib/DealMakerAPI/models/v1_entities_email_events.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_email_template.rb +15 -5
- 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_search_entities.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_search_entities_required_fields.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_shareholder_ledger.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 +1 -1
- data/spec/api/company_api_spec.rb +29 -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_email_template_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 +1 -1
- data/spec/models/v1_entities_email_events_spec.rb +1 -1
- data/spec/models/v1_entities_email_template_spec.rb +7 -1
- 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_search_entities_required_fields_spec.rb +1 -1
- data/spec/models/v1_entities_investor_search_entities_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_ledger_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 +107 -107
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce9765e4040eeb4d69cefd15cf4bdd81726ba47e2e86f5574f91648e022d1994
|
4
|
+
data.tar.gz: 3f2073dcf9cb10762c9e8091c6df7eb5f055e8abd3256bda949f7590ceb5a50a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 296317f8fd21ab6898c7c789492b7c95fe5a226a95c666bcb524758ef1f634ad33bdc1b5c8add8d1edba7cb526526ae95e77d8ce97a82fe66a80af2e53384398
|
7
|
+
data.tar.gz: 474abbe3b619fed87c3cd1c3c55978f3b565255de5dc604a551e88916d0af1985dd625afa20352f47dacd9a25a6409fdf744d60a6b6530984aba0b1403df4a61
|
data/DealMakerAPI.gemspec
CHANGED
data/README.md
CHANGED
@@ -338,7 +338,8 @@ 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.98.
|
341
|
+
- Package version: 0.98.4
|
342
|
+
- Generator version: 7.5.0-SNAPSHOT
|
342
343
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
343
344
|
|
344
345
|
## Installation
|
@@ -354,16 +355,16 @@ gem build DealMakerAPI.gemspec
|
|
354
355
|
Then either install the gem locally:
|
355
356
|
|
356
357
|
```shell
|
357
|
-
gem install ./DealMakerAPI-0.98.
|
358
|
+
gem install ./DealMakerAPI-0.98.4.gem
|
358
359
|
```
|
359
360
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.98.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.98.4.gem` to install the development dependencies)
|
361
362
|
|
362
363
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
363
364
|
|
364
365
|
Finally add this to the Gemfile:
|
365
366
|
|
366
|
-
gem 'DealMakerAPI', '~> 0.98.
|
367
|
+
gem 'DealMakerAPI', '~> 0.98.4'
|
367
368
|
|
368
369
|
### Install from Git
|
369
370
|
|
@@ -423,6 +424,8 @@ Class | Method | HTTP request | Description
|
|
423
424
|
*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
|
424
425
|
*DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
|
425
426
|
*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
|
427
|
+
*DealMakerAPI::CompanyApi* | [**get_email_template**](docs/CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_template/{template_id} | Get a email template
|
428
|
+
*DealMakerAPI::CompanyApi* | [**get_email_templates**](docs/CompanyApi.md#get_email_templates) | **GET** /companies/{id}/news_releases/email_templates | Get list of email template
|
426
429
|
*DealMakerAPI::CompanyApi* | [**get_shareholder_ledger**](docs/CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company
|
427
430
|
*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
|
428
431
|
*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
|
data/docs/CompanyApi.md
CHANGED
@@ -17,6 +17,8 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
17
17
|
| [**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 |
|
18
18
|
| [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
|
19
19
|
| [**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 |
|
20
|
+
| [**get_email_template**](CompanyApi.md#get_email_template) | **GET** /companies/{id}/news_releases/email_template/{template_id} | Get a email template |
|
21
|
+
| [**get_email_templates**](CompanyApi.md#get_email_templates) | **GET** /companies/{id}/news_releases/email_templates | Get list of email template |
|
20
22
|
| [**get_shareholder_ledger**](CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company |
|
21
23
|
| [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
|
22
24
|
| [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
|
@@ -920,6 +922,148 @@ No authorization required
|
|
920
922
|
- **Accept**: application/json
|
921
923
|
|
922
924
|
|
925
|
+
## get_email_template
|
926
|
+
|
927
|
+
> <V1EntitiesEmailTemplate> get_email_template(id, template_id)
|
928
|
+
|
929
|
+
Get a email template
|
930
|
+
|
931
|
+
Get a email template
|
932
|
+
|
933
|
+
### Examples
|
934
|
+
|
935
|
+
```ruby
|
936
|
+
require 'time'
|
937
|
+
require 'DealMakerAPI'
|
938
|
+
# setup authorization
|
939
|
+
DealMakerAPI.configure do |config|end
|
940
|
+
|
941
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
942
|
+
id = 56 # Integer | The company id
|
943
|
+
template_id = 56 # Integer | The email template id
|
944
|
+
|
945
|
+
begin
|
946
|
+
# Get a email template
|
947
|
+
result = api_instance.get_email_template(id, template_id)
|
948
|
+
p result
|
949
|
+
rescue DealMakerAPI::ApiError => e
|
950
|
+
puts "Error when calling CompanyApi->get_email_template: #{e}"
|
951
|
+
end
|
952
|
+
```
|
953
|
+
|
954
|
+
#### Using the get_email_template_with_http_info variant
|
955
|
+
|
956
|
+
This returns an Array which contains the response data, status code and headers.
|
957
|
+
|
958
|
+
> <Array(<V1EntitiesEmailTemplate>, Integer, Hash)> get_email_template_with_http_info(id, template_id)
|
959
|
+
|
960
|
+
```ruby
|
961
|
+
begin
|
962
|
+
# Get a email template
|
963
|
+
data, status_code, headers = api_instance.get_email_template_with_http_info(id, template_id)
|
964
|
+
p status_code # => 2xx
|
965
|
+
p headers # => { ... }
|
966
|
+
p data # => <V1EntitiesEmailTemplate>
|
967
|
+
rescue DealMakerAPI::ApiError => e
|
968
|
+
puts "Error when calling CompanyApi->get_email_template_with_http_info: #{e}"
|
969
|
+
end
|
970
|
+
```
|
971
|
+
|
972
|
+
### Parameters
|
973
|
+
|
974
|
+
| Name | Type | Description | Notes |
|
975
|
+
| ---- | ---- | ----------- | ----- |
|
976
|
+
| **id** | **Integer** | The company id | |
|
977
|
+
| **template_id** | **Integer** | The email template id | |
|
978
|
+
|
979
|
+
### Return type
|
980
|
+
|
981
|
+
[**V1EntitiesEmailTemplate**](V1EntitiesEmailTemplate.md)
|
982
|
+
|
983
|
+
### Authorization
|
984
|
+
|
985
|
+
No authorization required
|
986
|
+
|
987
|
+
### HTTP request headers
|
988
|
+
|
989
|
+
- **Content-Type**: Not defined
|
990
|
+
- **Accept**: application/json
|
991
|
+
|
992
|
+
|
993
|
+
## get_email_templates
|
994
|
+
|
995
|
+
> <V1EntitiesEmailTemplate> get_email_templates(id, opts)
|
996
|
+
|
997
|
+
Get list of email template
|
998
|
+
|
999
|
+
Get list of email template
|
1000
|
+
|
1001
|
+
### Examples
|
1002
|
+
|
1003
|
+
```ruby
|
1004
|
+
require 'time'
|
1005
|
+
require 'DealMakerAPI'
|
1006
|
+
# setup authorization
|
1007
|
+
DealMakerAPI.configure do |config|end
|
1008
|
+
|
1009
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
1010
|
+
id = 56 # Integer | The company id
|
1011
|
+
opts = {
|
1012
|
+
page: 56, # Integer | The page number
|
1013
|
+
per_page: 56, # Integer | The number of items per page
|
1014
|
+
public_template: true # Boolean | The public template
|
1015
|
+
}
|
1016
|
+
|
1017
|
+
begin
|
1018
|
+
# Get list of email template
|
1019
|
+
result = api_instance.get_email_templates(id, opts)
|
1020
|
+
p result
|
1021
|
+
rescue DealMakerAPI::ApiError => e
|
1022
|
+
puts "Error when calling CompanyApi->get_email_templates: #{e}"
|
1023
|
+
end
|
1024
|
+
```
|
1025
|
+
|
1026
|
+
#### Using the get_email_templates_with_http_info variant
|
1027
|
+
|
1028
|
+
This returns an Array which contains the response data, status code and headers.
|
1029
|
+
|
1030
|
+
> <Array(<V1EntitiesEmailTemplate>, Integer, Hash)> get_email_templates_with_http_info(id, opts)
|
1031
|
+
|
1032
|
+
```ruby
|
1033
|
+
begin
|
1034
|
+
# Get list of email template
|
1035
|
+
data, status_code, headers = api_instance.get_email_templates_with_http_info(id, opts)
|
1036
|
+
p status_code # => 2xx
|
1037
|
+
p headers # => { ... }
|
1038
|
+
p data # => <V1EntitiesEmailTemplate>
|
1039
|
+
rescue DealMakerAPI::ApiError => e
|
1040
|
+
puts "Error when calling CompanyApi->get_email_templates_with_http_info: #{e}"
|
1041
|
+
end
|
1042
|
+
```
|
1043
|
+
|
1044
|
+
### Parameters
|
1045
|
+
|
1046
|
+
| Name | Type | Description | Notes |
|
1047
|
+
| ---- | ---- | ----------- | ----- |
|
1048
|
+
| **id** | **Integer** | The company id | |
|
1049
|
+
| **page** | **Integer** | The page number | [optional][default to 1] |
|
1050
|
+
| **per_page** | **Integer** | The number of items per page | [optional][default to 10] |
|
1051
|
+
| **public_template** | **Boolean** | The public template | [optional][default to false] |
|
1052
|
+
|
1053
|
+
### Return type
|
1054
|
+
|
1055
|
+
[**V1EntitiesEmailTemplate**](V1EntitiesEmailTemplate.md)
|
1056
|
+
|
1057
|
+
### Authorization
|
1058
|
+
|
1059
|
+
No authorization required
|
1060
|
+
|
1061
|
+
### HTTP request headers
|
1062
|
+
|
1063
|
+
- **Content-Type**: Not defined
|
1064
|
+
- **Accept**: application/json
|
1065
|
+
|
1066
|
+
|
923
1067
|
## get_shareholder_ledger
|
924
1068
|
|
925
1069
|
> <V1EntitiesShareholderLedger> get_shareholder_ledger(id)
|
@@ -8,6 +8,7 @@
|
|
8
8
|
| **name** | **String** | The name of the email template. | [optional] |
|
9
9
|
| **json_content** | **String** | The json content of the email template. | [optional] |
|
10
10
|
| **company_id** | **Integer** | The ID of the company. | [optional] |
|
11
|
+
| **thumbnail_image** | **String** | The thumbnail image of the email template. | [optional] |
|
11
12
|
|
12
13
|
## Example
|
13
14
|
|
@@ -18,7 +19,8 @@ instance = DealMakerAPI::V1EntitiesEmailTemplate.new(
|
|
18
19
|
id: null,
|
19
20
|
name: null,
|
20
21
|
json_content: null,
|
21
|
-
company_id: null
|
22
|
+
company_id: null,
|
23
|
+
thumbnail_image: null
|
22
24
|
)
|
23
25
|
```
|
24
26
|
|
@@ -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
|
-
|
9
|
+
Generator version: 7.5.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -938,6 +938,147 @@ module DealMakerAPI
|
|
938
938
|
return data, status_code, headers
|
939
939
|
end
|
940
940
|
|
941
|
+
# Get a email template
|
942
|
+
# Get a email template
|
943
|
+
# @param id [Integer] The company id
|
944
|
+
# @param template_id [Integer] The email template id
|
945
|
+
# @param [Hash] opts the optional parameters
|
946
|
+
# @return [V1EntitiesEmailTemplate]
|
947
|
+
def get_email_template(id, template_id, opts = {})
|
948
|
+
data, _status_code, _headers = get_email_template_with_http_info(id, template_id, opts)
|
949
|
+
data
|
950
|
+
end
|
951
|
+
|
952
|
+
# Get a email template
|
953
|
+
# Get a email template
|
954
|
+
# @param id [Integer] The company id
|
955
|
+
# @param template_id [Integer] The email template id
|
956
|
+
# @param [Hash] opts the optional parameters
|
957
|
+
# @return [Array<(V1EntitiesEmailTemplate, Integer, Hash)>] V1EntitiesEmailTemplate data, response status code and response headers
|
958
|
+
def get_email_template_with_http_info(id, template_id, opts = {})
|
959
|
+
if @api_client.config.debugging
|
960
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_email_template ...'
|
961
|
+
end
|
962
|
+
# verify the required parameter 'id' is set
|
963
|
+
if @api_client.config.client_side_validation && id.nil?
|
964
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.get_email_template"
|
965
|
+
end
|
966
|
+
# verify the required parameter 'template_id' is set
|
967
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
968
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling CompanyApi.get_email_template"
|
969
|
+
end
|
970
|
+
# resource path
|
971
|
+
local_var_path = '/companies/{id}/news_releases/email_template/{template_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
|
972
|
+
|
973
|
+
# query parameters
|
974
|
+
query_params = opts[:query_params] || {}
|
975
|
+
|
976
|
+
# header parameters
|
977
|
+
header_params = opts[:header_params] || {}
|
978
|
+
# HTTP header 'Accept' (if needed)
|
979
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
980
|
+
|
981
|
+
# form parameters
|
982
|
+
form_params = opts[:form_params] || {}
|
983
|
+
|
984
|
+
# http body (model)
|
985
|
+
post_body = opts[:debug_body]
|
986
|
+
|
987
|
+
# return_type
|
988
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesEmailTemplate'
|
989
|
+
|
990
|
+
# auth_names
|
991
|
+
auth_names = opts[:debug_auth_names] || []
|
992
|
+
|
993
|
+
new_options = opts.merge(
|
994
|
+
:operation => :"CompanyApi.get_email_template",
|
995
|
+
:header_params => header_params,
|
996
|
+
:query_params => query_params,
|
997
|
+
:form_params => form_params,
|
998
|
+
:body => post_body,
|
999
|
+
:auth_names => auth_names,
|
1000
|
+
:return_type => return_type
|
1001
|
+
)
|
1002
|
+
|
1003
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1004
|
+
if @api_client.config.debugging
|
1005
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1006
|
+
end
|
1007
|
+
return data, status_code, headers
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# Get list of email template
|
1011
|
+
# Get list of email template
|
1012
|
+
# @param id [Integer] The company id
|
1013
|
+
# @param [Hash] opts the optional parameters
|
1014
|
+
# @option opts [Integer] :page The page number (default to 1)
|
1015
|
+
# @option opts [Integer] :per_page The number of items per page (default to 10)
|
1016
|
+
# @option opts [Boolean] :public_template The public template (default to false)
|
1017
|
+
# @return [V1EntitiesEmailTemplate]
|
1018
|
+
def get_email_templates(id, opts = {})
|
1019
|
+
data, _status_code, _headers = get_email_templates_with_http_info(id, opts)
|
1020
|
+
data
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
# Get list of email template
|
1024
|
+
# Get list of email template
|
1025
|
+
# @param id [Integer] The company id
|
1026
|
+
# @param [Hash] opts the optional parameters
|
1027
|
+
# @option opts [Integer] :page The page number (default to 1)
|
1028
|
+
# @option opts [Integer] :per_page The number of items per page (default to 10)
|
1029
|
+
# @option opts [Boolean] :public_template The public template (default to false)
|
1030
|
+
# @return [Array<(V1EntitiesEmailTemplate, Integer, Hash)>] V1EntitiesEmailTemplate data, response status code and response headers
|
1031
|
+
def get_email_templates_with_http_info(id, opts = {})
|
1032
|
+
if @api_client.config.debugging
|
1033
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_email_templates ...'
|
1034
|
+
end
|
1035
|
+
# verify the required parameter 'id' is set
|
1036
|
+
if @api_client.config.client_side_validation && id.nil?
|
1037
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.get_email_templates"
|
1038
|
+
end
|
1039
|
+
# resource path
|
1040
|
+
local_var_path = '/companies/{id}/news_releases/email_templates'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1041
|
+
|
1042
|
+
# query parameters
|
1043
|
+
query_params = opts[:query_params] || {}
|
1044
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1045
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
1046
|
+
query_params[:'public_template'] = opts[:'public_template'] if !opts[:'public_template'].nil?
|
1047
|
+
|
1048
|
+
# header parameters
|
1049
|
+
header_params = opts[:header_params] || {}
|
1050
|
+
# HTTP header 'Accept' (if needed)
|
1051
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1052
|
+
|
1053
|
+
# form parameters
|
1054
|
+
form_params = opts[:form_params] || {}
|
1055
|
+
|
1056
|
+
# http body (model)
|
1057
|
+
post_body = opts[:debug_body]
|
1058
|
+
|
1059
|
+
# return_type
|
1060
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesEmailTemplate'
|
1061
|
+
|
1062
|
+
# auth_names
|
1063
|
+
auth_names = opts[:debug_auth_names] || []
|
1064
|
+
|
1065
|
+
new_options = opts.merge(
|
1066
|
+
:operation => :"CompanyApi.get_email_templates",
|
1067
|
+
:header_params => header_params,
|
1068
|
+
:query_params => query_params,
|
1069
|
+
:form_params => form_params,
|
1070
|
+
:body => post_body,
|
1071
|
+
:auth_names => auth_names,
|
1072
|
+
:return_type => return_type
|
1073
|
+
)
|
1074
|
+
|
1075
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1076
|
+
if @api_client.config.debugging
|
1077
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_email_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1078
|
+
end
|
1079
|
+
return data, status_code, headers
|
1080
|
+
end
|
1081
|
+
|
941
1082
|
# Get shareholder ledger by company
|
942
1083
|
# Get shareholder ledger by company.
|
943
1084
|
# @param id [Integer]
|