DealMakerAPI 0.91.2 → 0.91.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.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -7
  3. data/docs/DealApi.md +69 -0
  4. data/docs/DefaultApi.md +67 -0
  5. data/docs/InvestorApi.md +4 -4
  6. data/docs/InvestorProfileApi.md +67 -0
  7. data/docs/PostInvestorProfilesManaged.md +68 -0
  8. data/docs/{V1EntitiesInvestorIncentivePlan.md → V1EntitiesDealsIncentivePlan.md} +2 -2
  9. data/docs/{V1EntitiesInvestorIncentiveTier.md → V1EntitiesDealsIncentivePlansIncentiveTier.md} +2 -2
  10. data/docs/V1EntitiesDealsPriceDetails.md +28 -0
  11. data/docs/V1EntitiesInvestorProfileFieldsBeneficiary.md +32 -0
  12. data/docs/V1EntitiesInvestorProfileFieldsProvider.md +30 -0
  13. data/docs/V1EntitiesInvestorProfileItem.md +1 -1
  14. data/docs/V1EntitiesInvestorProfileManaged.md +38 -0
  15. data/docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md +18 -0
  16. data/lib/DealMakerAPI/api/deal_api.rb +66 -0
  17. data/lib/DealMakerAPI/api/default_api.rb +63 -0
  18. data/lib/DealMakerAPI/api/investor_api.rb +3 -3
  19. data/lib/DealMakerAPI/api/investor_profile_api.rb +68 -0
  20. data/lib/DealMakerAPI/models/post_investor_profiles_managed.rb +519 -0
  21. data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_plan.rb → v1_entities_deals_incentive_plan.rb} +37 -3
  22. data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_tier.rb → v1_entities_deals_incentive_plans_incentive_tier.rb} +3 -3
  23. data/lib/DealMakerAPI/models/{v1_entities_investor_price_details.rb → v1_entities_deals_price_details.rb} +27 -7
  24. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +2 -2
  25. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary.rb +284 -0
  26. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_provider.rb +274 -0
  27. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +2 -2
  28. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
  29. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +2 -2
  30. data/lib/DealMakerAPI/models/v1_entities_investor_profile_managed.rb +347 -0
  31. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +2 -2
  32. data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data.rb +216 -0
  33. data/lib/DealMakerAPI/version.rb +1 -1
  34. data/lib/DealMakerAPI.rb +8 -3
  35. data/spec/api/deal_api_spec.rb +13 -0
  36. data/spec/api/default_api_spec.rb +12 -0
  37. data/spec/api/investor_api_spec.rb +1 -1
  38. data/spec/api/investor_profile_api_spec.rb +12 -0
  39. data/spec/models/post_investor_profiles_managed_spec.rb +194 -0
  40. data/spec/models/{v1_entities_investor_incentive_plan_spec.rb → v1_entities_deals_incentive_plan_spec.rb} +10 -6
  41. data/spec/models/{v1_entities_investor_incentive_tier_spec.rb → v1_entities_deals_incentive_plans_incentive_tier_spec.rb} +6 -6
  42. data/spec/models/{v1_entities_investor_price_details_spec.rb → v1_entities_deals_price_details_spec.rb} +18 -6
  43. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
  44. data/spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb +78 -0
  45. data/spec/models/v1_entities_investor_profile_fields_provider_spec.rb +72 -0
  46. data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
  47. data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
  48. data/spec/models/v1_entities_investor_profile_managed_spec.rb +100 -0
  49. data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
  50. data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb +36 -0
  51. metadata +119 -99
  52. data/docs/V1EntitiesInvestorPriceDetails.md +0 -24
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: df4a26bc9a113c737882c9a606d96bc871e252501305d67484249542b5cdfa29
4
- data.tar.gz: 29b2cd15bfd673c0d2cbb3d5708a32706c931886133da9441207308bc02967cc
3
+ metadata.gz: 2d51e0832687d864a317dfd25d6c628bacb7fa26da49b6a55605ebb2ab4ede14
4
+ data.tar.gz: cb1d0616d5ca1f1278a3a5ceb23f21b3e432eb09e1801b0f15bf245c498bfa37
5
5
  SHA512:
6
- metadata.gz: a652cb1dc46889bb421a33f1a9030a51e3f787824fa3ba84874bbf30d6c44679a301ee1ccb11a6b7f8dbfa691cc8e4e2b0dd4f625ab81fb17827171c66506b0a
7
- data.tar.gz: 79240214728f09862dff71f715c20c781fd2c3e5b80f37ede4a8d3b6413b16f42c73de530875ccce1e2d14cbef8cde1b0d5a39c31917aa0cab10f283c48a5e52
6
+ metadata.gz: 805e5f134448cb906a584de0a3e7d3b22683c87195a94060b3b06ad4f2f3f427b25bb54acd26076ebf65d2ef34b4545f2863770f557a7df66e196b919517f71a
7
+ data.tar.gz: 65d66fa14075b595473eafbae4ffa9fba59f0057303a3e94ee5fb6b98868ccc023dc79e22d231c4674d02a42f49ae9f01b7fcfc7cb13b8844f7769d8c455e8e4
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.91.2
341
+ - Package version: 0.91.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.91.2.gem
357
+ gem install ./DealMakerAPI-0.91.4.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.91.2.gem` to install the development dependencies)
360
+ (for development, run `gem install --dev ./DealMakerAPI-0.91.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.91.2'
366
+ gem 'DealMakerAPI', '~> 0.91.4'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -426,9 +426,11 @@ Class | Method | HTTP request | Description
426
426
  *DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
427
427
  *DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
428
428
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
429
+ *DealMakerAPI::DealApi* | [**get_deal_incentive_plan**](docs/DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id
429
430
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
430
431
  *DealMakerAPI::DealsApi* | [**put_deals_id_script_tag_environment**](docs/DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal.
431
432
  *DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage
433
+ *DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data
432
434
  *DealMakerAPI::DefaultApi* | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal
433
435
  *DealMakerAPI::DefaultApi* | [**get_deals_id_investors_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal
434
436
  *DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
@@ -458,6 +460,7 @@ Class | Method | HTTP request | Description
458
460
  *DealMakerAPI::InvestorProfileApi* | [**create_corporation_profile**](docs/InvestorProfileApi.md#create_corporation_profile) | **POST** /investor_profiles/corporations | Create new corporation investor profile.
459
461
  *DealMakerAPI::InvestorProfileApi* | [**create_individual_profile**](docs/InvestorProfileApi.md#create_individual_profile) | **POST** /investor_profiles/individuals | Create new individual investor profile
460
462
  *DealMakerAPI::InvestorProfileApi* | [**create_joint_profile**](docs/InvestorProfileApi.md#create_joint_profile) | **POST** /investor_profiles/joints | Create new joint investor profile
463
+ *DealMakerAPI::InvestorProfileApi* | [**create_managed_profile**](docs/InvestorProfileApi.md#create_managed_profile) | **POST** /investor_profiles/managed | Create new managed investor profile.
461
464
  *DealMakerAPI::InvestorProfileApi* | [**create_trust_profile**](docs/InvestorProfileApi.md#create_trust_profile) | **POST** /investor_profiles/trusts | Create new trust investor profile.
462
465
  *DealMakerAPI::InvestorProfileApi* | [**get_deal_investor_profiles**](docs/InvestorProfileApi.md#get_deal_investor_profiles) | **GET** /investor_profiles/{deal_id} | Get list of InvestorProfiles for a specific deal
463
466
  *DealMakerAPI::InvestorProfileApi* | [**get_investor_profile**](docs/InvestorProfileApi.md#get_investor_profile) | **GET** /investor_profiles/profile/{id} | Get an investor profile by id
@@ -498,6 +501,7 @@ Class | Method | HTTP request | Description
498
501
  - [DealMakerAPI::PostInvestorProfilesCorporationsBeneficialOwnersInner](docs/PostInvestorProfilesCorporationsBeneficialOwnersInner.md)
499
502
  - [DealMakerAPI::PostInvestorProfilesIndividuals](docs/PostInvestorProfilesIndividuals.md)
500
503
  - [DealMakerAPI::PostInvestorProfilesJoints](docs/PostInvestorProfilesJoints.md)
504
+ - [DealMakerAPI::PostInvestorProfilesManaged](docs/PostInvestorProfilesManaged.md)
501
505
  - [DealMakerAPI::PostInvestorProfilesTrusts](docs/PostInvestorProfilesTrusts.md)
502
506
  - [DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner](docs/PostInvestorProfilesTrustsTrusteesInner.md)
503
507
  - [DealMakerAPI::PostWebhooksRequest](docs/PostWebhooksRequest.md)
@@ -528,28 +532,31 @@ Class | Method | HTTP request | Description
528
532
  - [DealMakerAPI::V1EntitiesDealSetup](docs/V1EntitiesDealSetup.md)
529
533
  - [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
530
534
  - [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
535
+ - [DealMakerAPI::V1EntitiesDealsIncentivePlan](docs/V1EntitiesDealsIncentivePlan.md)
536
+ - [DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier](docs/V1EntitiesDealsIncentivePlansIncentiveTier.md)
537
+ - [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
531
538
  - [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
532
539
  - [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
533
540
  - [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
534
541
  - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
535
542
  - [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
536
543
  - [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
537
- - [DealMakerAPI::V1EntitiesInvestorIncentivePlan](docs/V1EntitiesInvestorIncentivePlan.md)
538
- - [DealMakerAPI::V1EntitiesInvestorIncentiveTier](docs/V1EntitiesInvestorIncentiveTier.md)
539
544
  - [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
540
- - [DealMakerAPI::V1EntitiesInvestorPriceDetails](docs/V1EntitiesInvestorPriceDetails.md)
541
545
  - [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
542
546
  - [DealMakerAPI::V1EntitiesInvestorProfileCorporation](docs/V1EntitiesInvestorProfileCorporation.md)
543
547
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsAccountHolder](docs/V1EntitiesInvestorProfileFieldsAccountHolder.md)
544
548
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficialOwner](docs/V1EntitiesInvestorProfileFieldsBeneficialOwner.md)
549
+ - [DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary](docs/V1EntitiesInvestorProfileFieldsBeneficiary.md)
545
550
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsCorporation](docs/V1EntitiesInvestorProfileFieldsCorporation.md)
546
551
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsPrimaryHolder](docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md)
552
+ - [DealMakerAPI::V1EntitiesInvestorProfileFieldsProvider](docs/V1EntitiesInvestorProfileFieldsProvider.md)
547
553
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsSigningOfficer](docs/V1EntitiesInvestorProfileFieldsSigningOfficer.md)
548
554
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrust](docs/V1EntitiesInvestorProfileFieldsTrust.md)
549
555
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee](docs/V1EntitiesInvestorProfileFieldsTrustee.md)
550
556
  - [DealMakerAPI::V1EntitiesInvestorProfileIndividual](docs/V1EntitiesInvestorProfileIndividual.md)
551
557
  - [DealMakerAPI::V1EntitiesInvestorProfileItem](docs/V1EntitiesInvestorProfileItem.md)
552
558
  - [DealMakerAPI::V1EntitiesInvestorProfileJoint](docs/V1EntitiesInvestorProfileJoint.md)
559
+ - [DealMakerAPI::V1EntitiesInvestorProfileManaged](docs/V1EntitiesInvestorProfileManaged.md)
553
560
  - [DealMakerAPI::V1EntitiesInvestorProfileOwner](docs/V1EntitiesInvestorProfileOwner.md)
554
561
  - [DealMakerAPI::V1EntitiesInvestorProfileTrust](docs/V1EntitiesInvestorProfileTrust.md)
555
562
  - [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
@@ -557,6 +564,7 @@ Class | Method | HTTP request | Description
557
564
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
558
565
  - [DealMakerAPI::V1EntitiesMoneyEntity](docs/V1EntitiesMoneyEntity.md)
559
566
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
567
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md)
560
568
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
561
569
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult](docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
562
570
  - [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
data/docs/DealApi.md CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *http://api.dealmaker.tech*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_deal_setup**](DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
8
8
  | [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
9
+ | [**get_deal_incentive_plan**](DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id |
9
10
  | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
10
11
 
11
12
 
@@ -141,6 +142,74 @@ No authorization required
141
142
  - **Accept**: application/json
142
143
 
143
144
 
145
+ ## get_deal_incentive_plan
146
+
147
+ > <V1EntitiesDealsPriceDetails> get_deal_incentive_plan(id, opts)
148
+
149
+ Get incentive plan by deal id
150
+
151
+ Gets the current active incentive plan for the given deal id.
152
+
153
+ ### Examples
154
+
155
+ ```ruby
156
+ require 'time'
157
+ require 'DealMakerAPI'
158
+
159
+ api_instance = DealMakerAPI::DealApi.new
160
+ id = 56 # Integer | The deal id.
161
+ opts = {
162
+ investment_amount: 3.4 # Float | The investment amount to get the security price for.
163
+ }
164
+
165
+ begin
166
+ # Get incentive plan by deal id
167
+ result = api_instance.get_deal_incentive_plan(id, opts)
168
+ p result
169
+ rescue DealMakerAPI::ApiError => e
170
+ puts "Error when calling DealApi->get_deal_incentive_plan: #{e}"
171
+ end
172
+ ```
173
+
174
+ #### Using the get_deal_incentive_plan_with_http_info variant
175
+
176
+ This returns an Array which contains the response data, status code and headers.
177
+
178
+ > <Array(<V1EntitiesDealsPriceDetails>, Integer, Hash)> get_deal_incentive_plan_with_http_info(id, opts)
179
+
180
+ ```ruby
181
+ begin
182
+ # Get incentive plan by deal id
183
+ data, status_code, headers = api_instance.get_deal_incentive_plan_with_http_info(id, opts)
184
+ p status_code # => 2xx
185
+ p headers # => { ... }
186
+ p data # => <V1EntitiesDealsPriceDetails>
187
+ rescue DealMakerAPI::ApiError => e
188
+ puts "Error when calling DealApi->get_deal_incentive_plan_with_http_info: #{e}"
189
+ end
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ | Name | Type | Description | Notes |
195
+ | ---- | ---- | ----------- | ----- |
196
+ | **id** | **Integer** | The deal id. | |
197
+ | **investment_amount** | **Float** | The investment amount to get the security price for. | [optional] |
198
+
199
+ ### Return type
200
+
201
+ [**V1EntitiesDealsPriceDetails**](V1EntitiesDealsPriceDetails.md)
202
+
203
+ ### Authorization
204
+
205
+ No authorization required
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
144
213
  ## list_deals
145
214
 
146
215
  > <V1EntitiesDeals> list_deals(opts)
data/docs/DefaultApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.dealmaker.tech*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage |
8
+ | [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data |
8
9
  | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal |
9
10
  | [**get_deals_id_investors_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal |
10
11
  | [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
@@ -84,6 +85,72 @@ No authorization required
84
85
  - **Accept**: application/json
85
86
 
86
87
 
88
+ ## get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data
89
+
90
+ > <V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData> get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data(deal_id)
91
+
92
+ Get payout account data
93
+
94
+ Get payout account data
95
+
96
+ ### Examples
97
+
98
+ ```ruby
99
+ require 'time'
100
+ require 'DealMakerAPI'
101
+ # setup authorization
102
+ DealMakerAPI.configure do |config|end
103
+
104
+ api_instance = DealMakerAPI::DefaultApi.new
105
+ deal_id = 56 # Integer |
106
+
107
+ begin
108
+ # Get payout account data
109
+ result = api_instance.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data(deal_id)
110
+ p result
111
+ rescue DealMakerAPI::ApiError => e
112
+ puts "Error when calling DefaultApi->get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data: #{e}"
113
+ end
114
+ ```
115
+
116
+ #### Using the get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info variant
117
+
118
+ This returns an Array which contains the response data, status code and headers.
119
+
120
+ > <Array(<V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData>, Integer, Hash)> get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info(deal_id)
121
+
122
+ ```ruby
123
+ begin
124
+ # Get payout account data
125
+ data, status_code, headers = api_instance.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info(deal_id)
126
+ p status_code # => 2xx
127
+ p headers # => { ... }
128
+ p data # => <V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData>
129
+ rescue DealMakerAPI::ApiError => e
130
+ puts "Error when calling DefaultApi->get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info: #{e}"
131
+ end
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ | Name | Type | Description | Notes |
137
+ | ---- | ---- | ----------- | ----- |
138
+ | **deal_id** | **Integer** | | |
139
+
140
+ ### Return type
141
+
142
+ [**V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData**](V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md)
143
+
144
+ ### Authorization
145
+
146
+ No authorization required
147
+
148
+ ### HTTP request headers
149
+
150
+ - **Content-Type**: Not defined
151
+ - **Accept**: application/json
152
+
153
+
87
154
  ## get_deals_id_investors_investor_id_payments_express_wire_instructions
88
155
 
89
156
  > <V1EntitiesExpressWireInstruction> get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id)
data/docs/InvestorApi.md CHANGED
@@ -575,7 +575,7 @@ No authorization required
575
575
 
576
576
  ## get_incentive_plan
577
577
 
578
- > <V1EntitiesInvestorPriceDetails> get_incentive_plan(id, investor_id)
578
+ > <V1EntitiesDealsPriceDetails> get_incentive_plan(id, investor_id)
579
579
 
580
580
  Get investor incentive plan by investor id
581
581
 
@@ -606,7 +606,7 @@ end
606
606
 
607
607
  This returns an Array which contains the response data, status code and headers.
608
608
 
609
- > <Array(<V1EntitiesInvestorPriceDetails>, Integer, Hash)> get_incentive_plan_with_http_info(id, investor_id)
609
+ > <Array(<V1EntitiesDealsPriceDetails>, Integer, Hash)> get_incentive_plan_with_http_info(id, investor_id)
610
610
 
611
611
  ```ruby
612
612
  begin
@@ -614,7 +614,7 @@ begin
614
614
  data, status_code, headers = api_instance.get_incentive_plan_with_http_info(id, investor_id)
615
615
  p status_code # => 2xx
616
616
  p headers # => { ... }
617
- p data # => <V1EntitiesInvestorPriceDetails>
617
+ p data # => <V1EntitiesDealsPriceDetails>
618
618
  rescue DealMakerAPI::ApiError => e
619
619
  puts "Error when calling InvestorApi->get_incentive_plan_with_http_info: #{e}"
620
620
  end
@@ -629,7 +629,7 @@ end
629
629
 
630
630
  ### Return type
631
631
 
632
- [**V1EntitiesInvestorPriceDetails**](V1EntitiesInvestorPriceDetails.md)
632
+ [**V1EntitiesDealsPriceDetails**](V1EntitiesDealsPriceDetails.md)
633
633
 
634
634
  ### Authorization
635
635
 
@@ -7,6 +7,7 @@ All URIs are relative to *http://api.dealmaker.tech*
7
7
  | [**create_corporation_profile**](InvestorProfileApi.md#create_corporation_profile) | **POST** /investor_profiles/corporations | Create new corporation investor profile. |
8
8
  | [**create_individual_profile**](InvestorProfileApi.md#create_individual_profile) | **POST** /investor_profiles/individuals | Create new individual investor profile |
9
9
  | [**create_joint_profile**](InvestorProfileApi.md#create_joint_profile) | **POST** /investor_profiles/joints | Create new joint investor profile |
10
+ | [**create_managed_profile**](InvestorProfileApi.md#create_managed_profile) | **POST** /investor_profiles/managed | Create new managed investor profile. |
10
11
  | [**create_trust_profile**](InvestorProfileApi.md#create_trust_profile) | **POST** /investor_profiles/trusts | Create new trust investor profile. |
11
12
  | [**get_deal_investor_profiles**](InvestorProfileApi.md#get_deal_investor_profiles) | **GET** /investor_profiles/{deal_id} | Get list of InvestorProfiles for a specific deal |
12
13
  | [**get_investor_profile**](InvestorProfileApi.md#get_investor_profile) | **GET** /investor_profiles/profile/{id} | Get an investor profile by id |
@@ -215,6 +216,72 @@ No authorization required
215
216
  - **Accept**: application/json
216
217
 
217
218
 
219
+ ## create_managed_profile
220
+
221
+ > <V1EntitiesInvestorProfileManaged> create_managed_profile(investor_profiles_managed)
222
+
223
+ Create new managed investor profile.
224
+
225
+ Create new managed investor profile associated to the user by email.
226
+
227
+ ### Examples
228
+
229
+ ```ruby
230
+ require 'time'
231
+ require 'DealMakerAPI'
232
+ # setup authorization
233
+ DealMakerAPI.configure do |config|end
234
+
235
+ api_instance = DealMakerAPI::InvestorProfileApi.new
236
+ investor_profiles_managed = DealMakerAPI::PostInvestorProfilesManaged.new({email: 'email_example'}) # PostInvestorProfilesManaged |
237
+
238
+ begin
239
+ # Create new managed investor profile.
240
+ result = api_instance.create_managed_profile(investor_profiles_managed)
241
+ p result
242
+ rescue DealMakerAPI::ApiError => e
243
+ puts "Error when calling InvestorProfileApi->create_managed_profile: #{e}"
244
+ end
245
+ ```
246
+
247
+ #### Using the create_managed_profile_with_http_info variant
248
+
249
+ This returns an Array which contains the response data, status code and headers.
250
+
251
+ > <Array(<V1EntitiesInvestorProfileManaged>, Integer, Hash)> create_managed_profile_with_http_info(investor_profiles_managed)
252
+
253
+ ```ruby
254
+ begin
255
+ # Create new managed investor profile.
256
+ data, status_code, headers = api_instance.create_managed_profile_with_http_info(investor_profiles_managed)
257
+ p status_code # => 2xx
258
+ p headers # => { ... }
259
+ p data # => <V1EntitiesInvestorProfileManaged>
260
+ rescue DealMakerAPI::ApiError => e
261
+ puts "Error when calling InvestorProfileApi->create_managed_profile_with_http_info: #{e}"
262
+ end
263
+ ```
264
+
265
+ ### Parameters
266
+
267
+ | Name | Type | Description | Notes |
268
+ | ---- | ---- | ----------- | ----- |
269
+ | **investor_profiles_managed** | [**PostInvestorProfilesManaged**](PostInvestorProfilesManaged.md) | | |
270
+
271
+ ### Return type
272
+
273
+ [**V1EntitiesInvestorProfileManaged**](V1EntitiesInvestorProfileManaged.md)
274
+
275
+ ### Authorization
276
+
277
+ No authorization required
278
+
279
+ ### HTTP request headers
280
+
281
+ - **Content-Type**: application/json
282
+ - **Accept**: application/json
283
+
284
+
218
285
  ## create_trust_profile
219
286
 
220
287
  > <V1EntitiesInvestorProfileTrust> create_trust_profile(investor_profiles_trusts)
@@ -0,0 +1,68 @@
1
+ # DealMakerAPI::PostInvestorProfilesManaged
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | User email which is associated with investor profile (required). | |
8
+ | **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
9
+ | **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
10
+ | **name** | **String** | The name of the provider (required). | [optional] |
11
+ | **street_address** | **String** | The street address of the provider (required). | [optional] |
12
+ | **unit2** | **String** | The street address line 2 of the provider. | [optional] |
13
+ | **city** | **String** | The city of the provider (required). | [optional] |
14
+ | **region** | **String** | The region or state of the provider (required). | [optional] |
15
+ | **postal_code** | **String** | The postal code or zipcode of the provider (required). | [optional] |
16
+ | **taxpayer_id** | **String** | The taxpayer identification number of the provider (required). | [optional] |
17
+ | **confirmation** | **Boolean** | Confirms that the provider is able to custody these securities and release respective funds in order to complete the purchase (required). | [optional] |
18
+ | **income** | **Float** | The income of the managed investor profile | [optional] |
19
+ | **net_worth** | **Float** | The net worth of the managed investor profile | [optional] |
20
+ | **reg_cf_prior_offerings_amount** | **Float** | The prior offering amount of the managed investor profile | [optional] |
21
+ | **beneficiary_account_number** | **String** | The account number of the beneficiary (required). | [optional] |
22
+ | **beneficiary_first_name** | **String** | The first name of the beneficiary (required). | [optional] |
23
+ | **beneficiary_last_name** | **String** | The last name of the beneficiary (required). | [optional] |
24
+ | **beneficiary_suffix** | **String** | The suffix of the beneficiary. | [optional] |
25
+ | **beneficiary_street_address** | **String** | The street address of the beneficiary (required). | [optional] |
26
+ | **beneficiary_unit2** | **String** | The street address line 2 of the beneficiary. | [optional] |
27
+ | **beneficiary_city** | **String** | The city of the beneficiary (required). | [optional] |
28
+ | **beneficiary_region** | **String** | The region or state of the beneficiary (required). | [optional] |
29
+ | **beneficiary_postal_code** | **String** | The postal code or zipcode of the beneficiary (required). | [optional] |
30
+ | **beneficiary_date_of_birth** | **String** | The date of birth of the beneficiary (required). | [optional] |
31
+ | **beneficiary_taxpayer_id** | **String** | The taxpayer identification number of the beneficiary (required). | [optional] |
32
+ | **beneficiary_phone_number** | **String** | The phone number of the beneficiary (required). | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'DealMakerAPI'
38
+
39
+ instance = DealMakerAPI::PostInvestorProfilesManaged.new(
40
+ email: null,
41
+ us_accredited_category: null,
42
+ ca_accredited_investor: null,
43
+ name: null,
44
+ street_address: null,
45
+ unit2: null,
46
+ city: null,
47
+ region: null,
48
+ postal_code: null,
49
+ taxpayer_id: null,
50
+ confirmation: null,
51
+ income: null,
52
+ net_worth: null,
53
+ reg_cf_prior_offerings_amount: null,
54
+ beneficiary_account_number: null,
55
+ beneficiary_first_name: null,
56
+ beneficiary_last_name: null,
57
+ beneficiary_suffix: null,
58
+ beneficiary_street_address: null,
59
+ beneficiary_unit2: null,
60
+ beneficiary_city: null,
61
+ beneficiary_region: null,
62
+ beneficiary_postal_code: null,
63
+ beneficiary_date_of_birth: null,
64
+ beneficiary_taxpayer_id: null,
65
+ beneficiary_phone_number: null
66
+ )
67
+ ```
68
+
@@ -1,4 +1,4 @@
1
- # DealMakerAPI::V1EntitiesInvestorIncentivePlan
1
+ # DealMakerAPI::V1EntitiesDealsIncentivePlan
2
2
 
3
3
  ## Properties
4
4
 
@@ -17,7 +17,7 @@
17
17
  ```ruby
18
18
  require 'DealMakerAPI'
19
19
 
20
- instance = DealMakerAPI::V1EntitiesInvestorIncentivePlan.new(
20
+ instance = DealMakerAPI::V1EntitiesDealsIncentivePlan.new(
21
21
  id: null,
22
22
  deal_id: null,
23
23
  plan_type: null,
@@ -1,4 +1,4 @@
1
- # DealMakerAPI::V1EntitiesInvestorIncentiveTier
1
+ # DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier
2
2
 
3
3
  ## Properties
4
4
 
@@ -15,7 +15,7 @@
15
15
  ```ruby
16
16
  require 'DealMakerAPI'
17
17
 
18
- instance = DealMakerAPI::V1EntitiesInvestorIncentiveTier.new(
18
+ instance = DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier.new(
19
19
  id: null,
20
20
  incentive_percentage: null,
21
21
  end_at: null,
@@ -0,0 +1,28 @@
1
+ # DealMakerAPI::V1EntitiesDealsPriceDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_price** | [**V1EntitiesMoneyEntity**](V1EntitiesMoneyEntity.md) | | [optional] |
8
+ | **final_price** | [**V1EntitiesMoneyEntity**](V1EntitiesMoneyEntity.md) | | [optional] |
9
+ | **computed_investment_amount** | **Float** | The computed valid investment amount based on a given investment amount. | [optional] |
10
+ | **computed_number_of_securities** | **Integer** | The computed number of securities that can be purchased with a given investment amount. | [optional] |
11
+ | **effective_tier** | [**V1EntitiesDealsIncentivePlansIncentiveTier**](V1EntitiesDealsIncentivePlansIncentiveTier.md) | | [optional] |
12
+ | **incentive_plan** | [**V1EntitiesDealsIncentivePlan**](V1EntitiesDealsIncentivePlan.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'DealMakerAPI'
18
+
19
+ instance = DealMakerAPI::V1EntitiesDealsPriceDetails.new(
20
+ full_price: null,
21
+ final_price: null,
22
+ computed_investment_amount: null,
23
+ computed_number_of_securities: null,
24
+ effective_tier: null,
25
+ incentive_plan: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,32 @@
1
+ # DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | Investor profile first name | [optional] |
8
+ | **last_name** | **String** | Investor profile last name | [optional] |
9
+ | **suffix** | **String** | Investor profile suffix | [optional] |
10
+ | **date_of_birth** | **String** | The date of birth | [optional] |
11
+ | **taxpayer_id** | **String** | The taxpayer identification number | [optional] |
12
+ | **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) | | [optional] |
13
+ | **account_number** | **String** | Beneficiary account number | [optional] |
14
+ | **phone_number** | **String** | Beneficiary phone number | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'DealMakerAPI'
20
+
21
+ instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsBeneficiary.new(
22
+ first_name: null,
23
+ last_name: null,
24
+ suffix: null,
25
+ date_of_birth: null,
26
+ taxpayer_id: null,
27
+ address: null,
28
+ account_number: null,
29
+ phone_number: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,30 @@
1
+ # DealMakerAPI::V1EntitiesInvestorProfileFieldsProvider
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The provider name | [optional] |
8
+ | **taxpayer_id** | **String** | The taxpayer identification number | [optional] |
9
+ | **confirmation** | **Boolean** | Confirms that the provider is able to custody these securities and release respective funds in order to complete the purchase | [optional] |
10
+ | **income** | **Float** | The income | [optional] |
11
+ | **net_worth** | **Float** | The net worth | [optional] |
12
+ | **reg_cf_prior_offerings_amount** | **Float** | The prior offering amount in the last 12 months | [optional] |
13
+ | **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'DealMakerAPI'
19
+
20
+ instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsProvider.new(
21
+ name: null,
22
+ taxpayer_id: null,
23
+ confirmation: null,
24
+ income: null,
25
+ net_worth: null,
26
+ reg_cf_prior_offerings_amount: null,
27
+ address: null
28
+ )
29
+ ```
30
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **profile** | [**V1EntitiesInvestorProfileTrust**](V1EntitiesInvestorProfileTrust.md) | | [optional] |
7
+ | **profile** | [**V1EntitiesInvestorProfileManaged**](V1EntitiesInvestorProfileManaged.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -0,0 +1,38 @@
1
+ # DealMakerAPI::V1EntitiesInvestorProfileManaged
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | Investor Profile id | [optional] |
8
+ | **user_id** | **Integer** | User id | [optional] |
9
+ | **email** | **String** | User email | [optional] |
10
+ | **type** | **String** | Investor Profile type | [optional] |
11
+ | **us_accredited_category** | **String** | The United States accredited investor information | [optional] |
12
+ | **ca_accredited_investor** | **String** | The Canadian accredited investor information | [optional] |
13
+ | **complete** | **Boolean** | To check if the profile is complete or not | [optional] |
14
+ | **owner_type** | **String** | Type of the investor profile owner | [optional] |
15
+ | **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) | | [optional] |
16
+ | **provider** | [**V1EntitiesInvestorProfileFieldsProvider**](V1EntitiesInvestorProfileFieldsProvider.md) | | [optional] |
17
+ | **beneficiary** | [**V1EntitiesInvestorProfileFieldsBeneficiary**](V1EntitiesInvestorProfileFieldsBeneficiary.md) | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'DealMakerAPI'
23
+
24
+ instance = DealMakerAPI::V1EntitiesInvestorProfileManaged.new(
25
+ id: null,
26
+ user_id: null,
27
+ email: null,
28
+ type: null,
29
+ us_accredited_category: null,
30
+ ca_accredited_investor: null,
31
+ complete: null,
32
+ owner_type: null,
33
+ owner: null,
34
+ provider: null,
35
+ beneficiary: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **country** | **String** | Payout account country | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.new(
15
+ country: null
16
+ )
17
+ ```
18
+