DealMakerAPI 0.93.2 → 0.93.4
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 +8 -4
- data/docs/IncentivePlanApi.md +142 -0
- data/docs/PatchDealIncentivePlanRequest.md +28 -0
- data/docs/PatchInvestorProfilesCorporations.md +2 -0
- data/docs/PatchInvestorProfilesIndividuals.md +2 -0
- data/docs/PatchInvestorProfilesJoints.md +2 -0
- data/docs/PatchInvestorProfilesTrusts.md +2 -0
- data/docs/PostDealIncentivePlanRequest.md +24 -0
- data/docs/V1EntitiesDealsIncentivePlansIncentiveTier.md +6 -0
- data/lib/DealMakerAPI/api/company_api.rb +1 -1
- data/lib/DealMakerAPI/api/country_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 +151 -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/patch_deal_incentive_plan_request.rb +273 -0
- data/lib/DealMakerAPI/models/patch_investor_profiles_corporations.rb +12 -2
- data/lib/DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_individuals.rb +12 -2
- data/lib/DealMakerAPI/models/patch_investor_profiles_joints.rb +12 -2
- data/lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb +12 -2
- data/lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_request.rb +1 -1
- data/{spec/api_client_spec.rb → lib/DealMakerAPI/models/post_deal_incentive_plan_request.rb} +213 -171
- 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_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 +32 -2
- 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_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 +1 -1
- data/spec/api/country_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 +28 -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/patch_deal_incentive_plan_request_spec.rb +66 -0
- data/spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_corporations_spec.rb +7 -1
- data/spec/models/patch_investor_profiles_individuals_spec.rb +7 -1
- data/spec/models/patch_investor_profiles_joints_spec.rb +7 -1
- data/spec/models/patch_investor_profiles_trusts_spec.rb +7 -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/{configuration_spec.rb → models/post_deal_incentive_plan_request_spec.rb} +34 -22
- 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_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 +19 -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_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 +10 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ab634b4afadd54f2465d9e190e75dce050c823b482b98e67b47dec25d3e2928d
|
4
|
+
data.tar.gz: 5676faef6ab228601b71d73381c3fa044fee39cb302033d5d3496bd20c685368
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3cedf62953a5d61fad157a0ca50dceebe2aabbff149ced8b1b7974dd8e5c3a7bf7d33b8ef76fe6d3130105c2998595eff87efd7da48ea779d7f3ca9d4d127b38
|
7
|
+
data.tar.gz: 0da805de5d0eba1ab9a8e2774a8e0ec761c9e71637511ff132ae0cd6858429863451ab38288308e79b7addb7d27fe8cd493017484005260129667fc607d286c3
|
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.93.
|
341
|
+
- Package version: 0.93.4
|
342
342
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
343
343
|
|
344
344
|
## Installation
|
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
|
|
354
354
|
Then either install the gem locally:
|
355
355
|
|
356
356
|
```shell
|
357
|
-
gem install ./DealMakerAPI-0.93.
|
357
|
+
gem install ./DealMakerAPI-0.93.4.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.93.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.93.4.gem` to install the development dependencies)
|
361
361
|
|
362
362
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
363
363
|
|
364
364
|
Finally add this to the Gemfile:
|
365
365
|
|
366
|
-
gem 'DealMakerAPI', '~> 0.93.
|
366
|
+
gem 'DealMakerAPI', '~> 0.93.4'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -443,6 +443,8 @@ Class | Method | HTTP request | Description
|
|
443
443
|
*DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
|
444
444
|
*DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
|
445
445
|
*DealMakerAPI::IncentivePlanApi* | [**get_deal_incentive_plans_time**](docs/IncentivePlanApi.md#get_deal_incentive_plans_time) | **GET** /deals/{id}/incentive_plans/time | Get incentive plans by deal id
|
446
|
+
*DealMakerAPI::IncentivePlanApi* | [**patch_deal_incentive_plan**](docs/IncentivePlanApi.md#patch_deal_incentive_plan) | **PATCH** /deals/{id}/incentive_plans/{incentive_plan_id} | Updates incentive plan by deal id
|
447
|
+
*DealMakerAPI::IncentivePlanApi* | [**post_deal_incentive_plan**](docs/IncentivePlanApi.md#post_deal_incentive_plan) | **POST** /deals/{id}/incentive_plans | Creates incentive plan by deal id
|
446
448
|
*DealMakerAPI::InvestorApi* | [**add506c_document**](docs/InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor
|
447
449
|
*DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
|
448
450
|
*DealMakerAPI::InvestorApi* | [**bulk_upload_investors**](docs/InvestorApi.md#bulk_upload_investors) | **POST** /deals/{id}/investors/bulk_upload | Bulk upload investors for deal investor
|
@@ -490,6 +492,7 @@ Class | Method | HTTP request | Description
|
|
490
492
|
- [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
|
491
493
|
- [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
|
492
494
|
- [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
|
495
|
+
- [DealMakerAPI::PatchDealIncentivePlanRequest](docs/PatchDealIncentivePlanRequest.md)
|
493
496
|
- [DealMakerAPI::PatchInvestorProfilesCorporations](docs/PatchInvestorProfilesCorporations.md)
|
494
497
|
- [DealMakerAPI::PatchInvestorProfilesCorporationsBeneficialOwnersInner](docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md)
|
495
498
|
- [DealMakerAPI::PatchInvestorProfilesIndividuals](docs/PatchInvestorProfilesIndividuals.md)
|
@@ -497,6 +500,7 @@ Class | Method | HTTP request | Description
|
|
497
500
|
- [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
|
498
501
|
- [DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner](docs/PatchInvestorProfilesTrustsTrusteesInner.md)
|
499
502
|
- [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
|
503
|
+
- [DealMakerAPI::PostDealIncentivePlanRequest](docs/PostDealIncentivePlanRequest.md)
|
500
504
|
- [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
|
501
505
|
- [DealMakerAPI::PostInvestorProfilesCorporations](docs/PostInvestorProfilesCorporations.md)
|
502
506
|
- [DealMakerAPI::PostInvestorProfilesCorporationsBeneficialOwnersInner](docs/PostInvestorProfilesCorporationsBeneficialOwnersInner.md)
|
data/docs/IncentivePlanApi.md
CHANGED
@@ -5,6 +5,8 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**get_deal_incentive_plans_time**](IncentivePlanApi.md#get_deal_incentive_plans_time) | **GET** /deals/{id}/incentive_plans/time | Get incentive plans by deal id |
|
8
|
+
| [**patch_deal_incentive_plan**](IncentivePlanApi.md#patch_deal_incentive_plan) | **PATCH** /deals/{id}/incentive_plans/{incentive_plan_id} | Updates incentive plan by deal id |
|
9
|
+
| [**post_deal_incentive_plan**](IncentivePlanApi.md#post_deal_incentive_plan) | **POST** /deals/{id}/incentive_plans | Creates incentive plan by deal id |
|
8
10
|
|
9
11
|
|
10
12
|
## get_deal_incentive_plans_time
|
@@ -80,3 +82,143 @@ No authorization required
|
|
80
82
|
- **Content-Type**: Not defined
|
81
83
|
- **Accept**: application/json
|
82
84
|
|
85
|
+
|
86
|
+
## patch_deal_incentive_plan
|
87
|
+
|
88
|
+
> <V1EntitiesDealsPriceDetails> patch_deal_incentive_plan(id, incentive_plan_id, opts)
|
89
|
+
|
90
|
+
Updates incentive plan by deal id
|
91
|
+
|
92
|
+
Updates an incentive plan for the given deal id with respectve tiers.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'DealMakerAPI'
|
99
|
+
# setup authorization
|
100
|
+
DealMakerAPI.configure do |config|end
|
101
|
+
|
102
|
+
api_instance = DealMakerAPI::IncentivePlanApi.new
|
103
|
+
id = 56 # Integer | The deal id.
|
104
|
+
incentive_plan_id = 56 # Integer | The deal id.
|
105
|
+
opts = {
|
106
|
+
patch_deal_incentive_plan_request: DealMakerAPI::PatchDealIncentivePlanRequest.new # PatchDealIncentivePlanRequest |
|
107
|
+
}
|
108
|
+
|
109
|
+
begin
|
110
|
+
# Updates incentive plan by deal id
|
111
|
+
result = api_instance.patch_deal_incentive_plan(id, incentive_plan_id, opts)
|
112
|
+
p result
|
113
|
+
rescue DealMakerAPI::ApiError => e
|
114
|
+
puts "Error when calling IncentivePlanApi->patch_deal_incentive_plan: #{e}"
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
#### Using the patch_deal_incentive_plan_with_http_info variant
|
119
|
+
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
121
|
+
|
122
|
+
> <Array(<V1EntitiesDealsPriceDetails>, Integer, Hash)> patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts)
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
begin
|
126
|
+
# Updates incentive plan by deal id
|
127
|
+
data, status_code, headers = api_instance.patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts)
|
128
|
+
p status_code # => 2xx
|
129
|
+
p headers # => { ... }
|
130
|
+
p data # => <V1EntitiesDealsPriceDetails>
|
131
|
+
rescue DealMakerAPI::ApiError => e
|
132
|
+
puts "Error when calling IncentivePlanApi->patch_deal_incentive_plan_with_http_info: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
| Name | Type | Description | Notes |
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
140
|
+
| **id** | **Integer** | The deal id. | |
|
141
|
+
| **incentive_plan_id** | **Integer** | The deal id. | |
|
142
|
+
| **patch_deal_incentive_plan_request** | [**PatchDealIncentivePlanRequest**](PatchDealIncentivePlanRequest.md) | | [optional] |
|
143
|
+
|
144
|
+
### Return type
|
145
|
+
|
146
|
+
[**V1EntitiesDealsPriceDetails**](V1EntitiesDealsPriceDetails.md)
|
147
|
+
|
148
|
+
### Authorization
|
149
|
+
|
150
|
+
No authorization required
|
151
|
+
|
152
|
+
### HTTP request headers
|
153
|
+
|
154
|
+
- **Content-Type**: application/json
|
155
|
+
- **Accept**: application/json
|
156
|
+
|
157
|
+
|
158
|
+
## post_deal_incentive_plan
|
159
|
+
|
160
|
+
> <V1EntitiesDealsPriceDetails> post_deal_incentive_plan(id, post_deal_incentive_plan_request)
|
161
|
+
|
162
|
+
Creates incentive plan by deal id
|
163
|
+
|
164
|
+
Creates an incentive plan for the given deal id with respectve tiers.
|
165
|
+
|
166
|
+
### Examples
|
167
|
+
|
168
|
+
```ruby
|
169
|
+
require 'time'
|
170
|
+
require 'DealMakerAPI'
|
171
|
+
# setup authorization
|
172
|
+
DealMakerAPI.configure do |config|end
|
173
|
+
|
174
|
+
api_instance = DealMakerAPI::IncentivePlanApi.new
|
175
|
+
id = 56 # Integer | The deal id.
|
176
|
+
post_deal_incentive_plan_request = DealMakerAPI::PostDealIncentivePlanRequest.new({active_at: Time.now, tiers_incentive_percentage: [3.56], tiers_end_at: [Time.now]}) # PostDealIncentivePlanRequest |
|
177
|
+
|
178
|
+
begin
|
179
|
+
# Creates incentive plan by deal id
|
180
|
+
result = api_instance.post_deal_incentive_plan(id, post_deal_incentive_plan_request)
|
181
|
+
p result
|
182
|
+
rescue DealMakerAPI::ApiError => e
|
183
|
+
puts "Error when calling IncentivePlanApi->post_deal_incentive_plan: #{e}"
|
184
|
+
end
|
185
|
+
```
|
186
|
+
|
187
|
+
#### Using the post_deal_incentive_plan_with_http_info variant
|
188
|
+
|
189
|
+
This returns an Array which contains the response data, status code and headers.
|
190
|
+
|
191
|
+
> <Array(<V1EntitiesDealsPriceDetails>, Integer, Hash)> post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request)
|
192
|
+
|
193
|
+
```ruby
|
194
|
+
begin
|
195
|
+
# Creates incentive plan by deal id
|
196
|
+
data, status_code, headers = api_instance.post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request)
|
197
|
+
p status_code # => 2xx
|
198
|
+
p headers # => { ... }
|
199
|
+
p data # => <V1EntitiesDealsPriceDetails>
|
200
|
+
rescue DealMakerAPI::ApiError => e
|
201
|
+
puts "Error when calling IncentivePlanApi->post_deal_incentive_plan_with_http_info: #{e}"
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
205
|
+
### Parameters
|
206
|
+
|
207
|
+
| Name | Type | Description | Notes |
|
208
|
+
| ---- | ---- | ----------- | ----- |
|
209
|
+
| **id** | **Integer** | The deal id. | |
|
210
|
+
| **post_deal_incentive_plan_request** | [**PostDealIncentivePlanRequest**](PostDealIncentivePlanRequest.md) | | |
|
211
|
+
|
212
|
+
### Return type
|
213
|
+
|
214
|
+
[**V1EntitiesDealsPriceDetails**](V1EntitiesDealsPriceDetails.md)
|
215
|
+
|
216
|
+
### Authorization
|
217
|
+
|
218
|
+
No authorization required
|
219
|
+
|
220
|
+
### HTTP request headers
|
221
|
+
|
222
|
+
- **Content-Type**: application/json
|
223
|
+
- **Accept**: application/json
|
224
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# DealMakerAPI::PatchDealIncentivePlanRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **active_at** | **Time** | The incentive plan active date. | [optional] |
|
8
|
+
| **funded_by_offset** | **Integer** | The incentive plan funded by offset in days. | [optional] |
|
9
|
+
| **tiers_id** | **Array<Integer>** | The incentive plan tier id. If none it will be created | [optional] |
|
10
|
+
| **tiers__delete** | **Array<Boolean>** | If true, this entry will be cleared. | [optional] |
|
11
|
+
| **tiers_incentive_percentage** | **Array<Float>** | The incentive plan tier percentage. | [optional] |
|
12
|
+
| **tiers_end_at** | **Array<Time>** | The incentive plan tier end date. | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'DealMakerAPI'
|
18
|
+
|
19
|
+
instance = DealMakerAPI::PatchDealIncentivePlanRequest.new(
|
20
|
+
active_at: null,
|
21
|
+
funded_by_offset: null,
|
22
|
+
tiers_id: null,
|
23
|
+
tiers__delete: null,
|
24
|
+
tiers_incentive_percentage: null,
|
25
|
+
tiers_end_at: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | The email associated with the profile to be updated. | [optional] |
|
7
8
|
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
9
|
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **name** | **String** | Corporation name. | [optional] |
|
@@ -37,6 +38,7 @@
|
|
37
38
|
require 'DealMakerAPI'
|
38
39
|
|
39
40
|
instance = DealMakerAPI::PatchInvestorProfilesCorporations.new(
|
41
|
+
email: null,
|
40
42
|
us_accredited_category: null,
|
41
43
|
ca_accredited_investor: null,
|
42
44
|
name: null,
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | The email associated with the profile to be updated. | [optional] |
|
7
8
|
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
9
|
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **first_name** | **String** | The first name of the individual investor profile. | [optional] |
|
@@ -27,6 +28,7 @@
|
|
27
28
|
require 'DealMakerAPI'
|
28
29
|
|
29
30
|
instance = DealMakerAPI::PatchInvestorProfilesIndividuals.new(
|
31
|
+
email: null,
|
30
32
|
us_accredited_category: null,
|
31
33
|
ca_accredited_investor: null,
|
32
34
|
first_name: null,
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | The email associated with the profile to be updated. | [optional] |
|
7
8
|
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
9
|
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **joint_type** | **String** | The kind of joint investor. | [optional] |
|
@@ -38,6 +39,7 @@
|
|
38
39
|
require 'DealMakerAPI'
|
39
40
|
|
40
41
|
instance = DealMakerAPI::PatchInvestorProfilesJoints.new(
|
42
|
+
email: null,
|
41
43
|
us_accredited_category: null,
|
42
44
|
ca_accredited_investor: null,
|
43
45
|
joint_type: null,
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | The email associated with the profile to be updated. | [optional] |
|
7
8
|
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
8
9
|
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
9
10
|
| **name** | **String** | The name of the trust. | [optional] |
|
@@ -25,6 +26,7 @@
|
|
25
26
|
require 'DealMakerAPI'
|
26
27
|
|
27
28
|
instance = DealMakerAPI::PatchInvestorProfilesTrusts.new(
|
29
|
+
email: null,
|
28
30
|
us_accredited_category: null,
|
29
31
|
ca_accredited_investor: null,
|
30
32
|
name: null,
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DealMakerAPI::PostDealIncentivePlanRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **active_at** | **Time** | The incentive plan active date. | |
|
8
|
+
| **funded_by_offset** | **Integer** | The incentive plan funded by offset in days. | [optional] |
|
9
|
+
| **tiers_incentive_percentage** | **Array<Float>** | The incentive plan tier percentage. | |
|
10
|
+
| **tiers_end_at** | **Array<Time>** | The incentive plan tier end date. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'DealMakerAPI'
|
16
|
+
|
17
|
+
instance = DealMakerAPI::PostDealIncentivePlanRequest.new(
|
18
|
+
active_at: null,
|
19
|
+
funded_by_offset: null,
|
20
|
+
tiers_incentive_percentage: null,
|
21
|
+
tiers_end_at: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -5,8 +5,11 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **Integer** | The incentive tier id. | [optional] |
|
8
|
+
| **status** | **String** | The incentive tier status. | [optional] |
|
9
|
+
| **humanized_index** | **Integer** | The incentive tier humanized index. | [optional] |
|
8
10
|
| **incentive_percentage** | **Float** | The incentive tier percentage. | [optional] |
|
9
11
|
| **end_at** | **Time** | The incentive tier end date. | [optional] |
|
12
|
+
| **start_at** | **Time** | The incentive plan start date. | [optional] |
|
10
13
|
| **funded_by** | **Time** | The incentive tier funded by date, it is computed from the end at and plan funded by offset. | [optional] |
|
11
14
|
| **created_at** | **Time** | The creation time. | [optional] |
|
12
15
|
| **updated_at** | **Time** | The last update time. | [optional] |
|
@@ -18,8 +21,11 @@ require 'DealMakerAPI'
|
|
18
21
|
|
19
22
|
instance = DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier.new(
|
20
23
|
id: null,
|
24
|
+
status: null,
|
25
|
+
humanized_index: null,
|
21
26
|
incentive_percentage: null,
|
22
27
|
end_at: null,
|
28
|
+
start_at: null,
|
23
29
|
funded_by: null,
|
24
30
|
created_at: null,
|
25
31
|
updated_at: null
|
@@ -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.
|
9
|
+
OpenAPI Generator version: 7.3.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -90,5 +90,155 @@ module DealMakerAPI
|
|
90
90
|
end
|
91
91
|
return data, status_code, headers
|
92
92
|
end
|
93
|
+
|
94
|
+
# Updates incentive plan by deal id
|
95
|
+
# Updates an incentive plan for the given deal id with respectve tiers.
|
96
|
+
# @param id [Integer] The deal id.
|
97
|
+
# @param incentive_plan_id [Integer] The deal id.
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [PatchDealIncentivePlanRequest] :patch_deal_incentive_plan_request
|
100
|
+
# @return [V1EntitiesDealsPriceDetails]
|
101
|
+
def patch_deal_incentive_plan(id, incentive_plan_id, opts = {})
|
102
|
+
data, _status_code, _headers = patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts)
|
103
|
+
data
|
104
|
+
end
|
105
|
+
|
106
|
+
# Updates incentive plan by deal id
|
107
|
+
# Updates an incentive plan for the given deal id with respectve tiers.
|
108
|
+
# @param id [Integer] The deal id.
|
109
|
+
# @param incentive_plan_id [Integer] The deal id.
|
110
|
+
# @param [Hash] opts the optional parameters
|
111
|
+
# @option opts [PatchDealIncentivePlanRequest] :patch_deal_incentive_plan_request
|
112
|
+
# @return [Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>] V1EntitiesDealsPriceDetails data, response status code and response headers
|
113
|
+
def patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts = {})
|
114
|
+
if @api_client.config.debugging
|
115
|
+
@api_client.config.logger.debug 'Calling API: IncentivePlanApi.patch_deal_incentive_plan ...'
|
116
|
+
end
|
117
|
+
# verify the required parameter 'id' is set
|
118
|
+
if @api_client.config.client_side_validation && id.nil?
|
119
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling IncentivePlanApi.patch_deal_incentive_plan"
|
120
|
+
end
|
121
|
+
# verify the required parameter 'incentive_plan_id' is set
|
122
|
+
if @api_client.config.client_side_validation && incentive_plan_id.nil?
|
123
|
+
fail ArgumentError, "Missing the required parameter 'incentive_plan_id' when calling IncentivePlanApi.patch_deal_incentive_plan"
|
124
|
+
end
|
125
|
+
# resource path
|
126
|
+
local_var_path = '/deals/{id}/incentive_plans/{incentive_plan_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'incentive_plan_id' + '}', CGI.escape(incentive_plan_id.to_s))
|
127
|
+
|
128
|
+
# query parameters
|
129
|
+
query_params = opts[:query_params] || {}
|
130
|
+
|
131
|
+
# header parameters
|
132
|
+
header_params = opts[:header_params] || {}
|
133
|
+
# HTTP header 'Accept' (if needed)
|
134
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
135
|
+
# HTTP header 'Content-Type'
|
136
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
137
|
+
if !content_type.nil?
|
138
|
+
header_params['Content-Type'] = content_type
|
139
|
+
end
|
140
|
+
|
141
|
+
# form parameters
|
142
|
+
form_params = opts[:form_params] || {}
|
143
|
+
|
144
|
+
# http body (model)
|
145
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patch_deal_incentive_plan_request'])
|
146
|
+
|
147
|
+
# return_type
|
148
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
|
149
|
+
|
150
|
+
# auth_names
|
151
|
+
auth_names = opts[:debug_auth_names] || []
|
152
|
+
|
153
|
+
new_options = opts.merge(
|
154
|
+
:operation => :"IncentivePlanApi.patch_deal_incentive_plan",
|
155
|
+
:header_params => header_params,
|
156
|
+
:query_params => query_params,
|
157
|
+
:form_params => form_params,
|
158
|
+
:body => post_body,
|
159
|
+
:auth_names => auth_names,
|
160
|
+
:return_type => return_type
|
161
|
+
)
|
162
|
+
|
163
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug "API called: IncentivePlanApi#patch_deal_incentive_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
166
|
+
end
|
167
|
+
return data, status_code, headers
|
168
|
+
end
|
169
|
+
|
170
|
+
# Creates incentive plan by deal id
|
171
|
+
# Creates an incentive plan for the given deal id with respectve tiers.
|
172
|
+
# @param id [Integer] The deal id.
|
173
|
+
# @param post_deal_incentive_plan_request [PostDealIncentivePlanRequest]
|
174
|
+
# @param [Hash] opts the optional parameters
|
175
|
+
# @return [V1EntitiesDealsPriceDetails]
|
176
|
+
def post_deal_incentive_plan(id, post_deal_incentive_plan_request, opts = {})
|
177
|
+
data, _status_code, _headers = post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request, opts)
|
178
|
+
data
|
179
|
+
end
|
180
|
+
|
181
|
+
# Creates incentive plan by deal id
|
182
|
+
# Creates an incentive plan for the given deal id with respectve tiers.
|
183
|
+
# @param id [Integer] The deal id.
|
184
|
+
# @param post_deal_incentive_plan_request [PostDealIncentivePlanRequest]
|
185
|
+
# @param [Hash] opts the optional parameters
|
186
|
+
# @return [Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>] V1EntitiesDealsPriceDetails data, response status code and response headers
|
187
|
+
def post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request, opts = {})
|
188
|
+
if @api_client.config.debugging
|
189
|
+
@api_client.config.logger.debug 'Calling API: IncentivePlanApi.post_deal_incentive_plan ...'
|
190
|
+
end
|
191
|
+
# verify the required parameter 'id' is set
|
192
|
+
if @api_client.config.client_side_validation && id.nil?
|
193
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling IncentivePlanApi.post_deal_incentive_plan"
|
194
|
+
end
|
195
|
+
# verify the required parameter 'post_deal_incentive_plan_request' is set
|
196
|
+
if @api_client.config.client_side_validation && post_deal_incentive_plan_request.nil?
|
197
|
+
fail ArgumentError, "Missing the required parameter 'post_deal_incentive_plan_request' when calling IncentivePlanApi.post_deal_incentive_plan"
|
198
|
+
end
|
199
|
+
# resource path
|
200
|
+
local_var_path = '/deals/{id}/incentive_plans'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
201
|
+
|
202
|
+
# query parameters
|
203
|
+
query_params = opts[:query_params] || {}
|
204
|
+
|
205
|
+
# header parameters
|
206
|
+
header_params = opts[:header_params] || {}
|
207
|
+
# HTTP header 'Accept' (if needed)
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
209
|
+
# HTTP header 'Content-Type'
|
210
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
211
|
+
if !content_type.nil?
|
212
|
+
header_params['Content-Type'] = content_type
|
213
|
+
end
|
214
|
+
|
215
|
+
# form parameters
|
216
|
+
form_params = opts[:form_params] || {}
|
217
|
+
|
218
|
+
# http body (model)
|
219
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(post_deal_incentive_plan_request)
|
220
|
+
|
221
|
+
# return_type
|
222
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
|
223
|
+
|
224
|
+
# auth_names
|
225
|
+
auth_names = opts[:debug_auth_names] || []
|
226
|
+
|
227
|
+
new_options = opts.merge(
|
228
|
+
:operation => :"IncentivePlanApi.post_deal_incentive_plan",
|
229
|
+
:header_params => header_params,
|
230
|
+
:query_params => query_params,
|
231
|
+
:form_params => form_params,
|
232
|
+
:body => post_body,
|
233
|
+
:auth_names => auth_names,
|
234
|
+
:return_type => return_type
|
235
|
+
)
|
236
|
+
|
237
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
238
|
+
if @api_client.config.debugging
|
239
|
+
@api_client.config.logger.debug "API called: IncentivePlanApi#post_deal_incentive_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
240
|
+
end
|
241
|
+
return data, status_code, headers
|
242
|
+
end
|
93
243
|
end
|
94
244
|
end
|