DealMakerAPI 0.91.3 → 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 (27) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -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/{V1EntitiesInvestorIncentivePlan.md → V1EntitiesDealsIncentivePlan.md} +2 -2
  7. data/docs/{V1EntitiesInvestorIncentiveTier.md → V1EntitiesDealsIncentivePlansIncentiveTier.md} +2 -2
  8. data/docs/V1EntitiesDealsPriceDetails.md +28 -0
  9. data/docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md +18 -0
  10. data/lib/DealMakerAPI/api/deal_api.rb +66 -0
  11. data/lib/DealMakerAPI/api/default_api.rb +63 -0
  12. data/lib/DealMakerAPI/api/investor_api.rb +3 -3
  13. data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_plan.rb → v1_entities_deals_incentive_plan.rb} +37 -3
  14. data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_tier.rb → v1_entities_deals_incentive_plans_incentive_tier.rb} +3 -3
  15. data/lib/DealMakerAPI/models/{v1_entities_investor_price_details.rb → v1_entities_deals_price_details.rb} +27 -57
  16. data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data.rb +216 -0
  17. data/lib/DealMakerAPI/version.rb +1 -1
  18. data/lib/DealMakerAPI.rb +4 -3
  19. data/spec/api/deal_api_spec.rb +13 -0
  20. data/spec/api/default_api_spec.rb +12 -0
  21. data/spec/api/investor_api_spec.rb +1 -1
  22. data/spec/models/{v1_entities_investor_incentive_plan_spec.rb → v1_entities_deals_incentive_plan_spec.rb} +10 -6
  23. data/spec/models/{v1_entities_investor_incentive_tier_spec.rb → v1_entities_deals_incentive_plans_incentive_tier_spec.rb} +6 -6
  24. data/spec/models/{v1_entities_investor_price_details_spec.rb → v1_entities_deals_price_details_spec.rb} +10 -28
  25. data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb +36 -0
  26. metadata +18 -14
  27. data/docs/V1EntitiesInvestorPriceDetails.md +0 -34
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b977e1b89ce93dabc2b40635fc06316338589582ff0a8fcfe7cae108f748e15f
4
- data.tar.gz: 32432b3c899b8259d387baafc7ad131e3d15fd8e8fbfffe5c2b4489088349c85
3
+ metadata.gz: 2d51e0832687d864a317dfd25d6c628bacb7fa26da49b6a55605ebb2ab4ede14
4
+ data.tar.gz: cb1d0616d5ca1f1278a3a5ceb23f21b3e432eb09e1801b0f15bf245c498bfa37
5
5
  SHA512:
6
- metadata.gz: 9f7c16d53f310b28cf2e6d3955a2263ea1f0817439be578586a15dbce86dcb31dffb14e34f9ebe773ff77312afe756e0c269b6cb5df6d31829fe41d173cc3b69
7
- data.tar.gz: a04eeef6eaa30131482fc5b7593e09461da9c8213d904df8bb2f3fc8006f011d7ec745092b4e0c49b5f6eb6b8fc3ed9242e9821c27ca9f414e19d2222c4124a4
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.3
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.3.gem
357
+ gem install ./DealMakerAPI-0.91.4.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.91.3.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.3'
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
@@ -530,16 +532,16 @@ Class | Method | HTTP request | Description
530
532
  - [DealMakerAPI::V1EntitiesDealSetup](docs/V1EntitiesDealSetup.md)
531
533
  - [DealMakerAPI::V1EntitiesDealSetupUser](docs/V1EntitiesDealSetupUser.md)
532
534
  - [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
535
+ - [DealMakerAPI::V1EntitiesDealsIncentivePlan](docs/V1EntitiesDealsIncentivePlan.md)
536
+ - [DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier](docs/V1EntitiesDealsIncentivePlansIncentiveTier.md)
537
+ - [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
533
538
  - [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
534
539
  - [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
535
540
  - [DealMakerAPI::V1EntitiesExpressWireInstruction](docs/V1EntitiesExpressWireInstruction.md)
536
541
  - [DealMakerAPI::V1EntitiesExpressWireInstructions](docs/V1EntitiesExpressWireInstructions.md)
537
542
  - [DealMakerAPI::V1EntitiesGenericResponse](docs/V1EntitiesGenericResponse.md)
538
543
  - [DealMakerAPI::V1EntitiesInvestor](docs/V1EntitiesInvestor.md)
539
- - [DealMakerAPI::V1EntitiesInvestorIncentivePlan](docs/V1EntitiesInvestorIncentivePlan.md)
540
- - [DealMakerAPI::V1EntitiesInvestorIncentiveTier](docs/V1EntitiesInvestorIncentiveTier.md)
541
544
  - [DealMakerAPI::V1EntitiesInvestorOtpAccessLink](docs/V1EntitiesInvestorOtpAccessLink.md)
542
- - [DealMakerAPI::V1EntitiesInvestorPriceDetails](docs/V1EntitiesInvestorPriceDetails.md)
543
545
  - [DealMakerAPI::V1EntitiesInvestorProfileAddress](docs/V1EntitiesInvestorProfileAddress.md)
544
546
  - [DealMakerAPI::V1EntitiesInvestorProfileCorporation](docs/V1EntitiesInvestorProfileCorporation.md)
545
547
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsAccountHolder](docs/V1EntitiesInvestorProfileFieldsAccountHolder.md)
@@ -562,6 +564,7 @@ Class | Method | HTTP request | Description
562
564
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
563
565
  - [DealMakerAPI::V1EntitiesMoneyEntity](docs/V1EntitiesMoneyEntity.md)
564
566
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
567
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md)
565
568
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
566
569
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult](docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
567
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
 
@@ -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,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
+
@@ -150,6 +150,72 @@ module DealMakerAPI
150
150
  return data, status_code, headers
151
151
  end
152
152
 
153
+ # Get incentive plan by deal id
154
+ # Gets the current active incentive plan for the given deal id.
155
+ # @param id [Integer] The deal id.
156
+ # @param [Hash] opts the optional parameters
157
+ # @option opts [Float] :investment_amount The investment amount to get the security price for.
158
+ # @return [V1EntitiesDealsPriceDetails]
159
+ def get_deal_incentive_plan(id, opts = {})
160
+ data, _status_code, _headers = get_deal_incentive_plan_with_http_info(id, opts)
161
+ data
162
+ end
163
+
164
+ # Get incentive plan by deal id
165
+ # Gets the current active incentive plan for the given deal id.
166
+ # @param id [Integer] The deal id.
167
+ # @param [Hash] opts the optional parameters
168
+ # @option opts [Float] :investment_amount The investment amount to get the security price for.
169
+ # @return [Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>] V1EntitiesDealsPriceDetails data, response status code and response headers
170
+ def get_deal_incentive_plan_with_http_info(id, opts = {})
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug 'Calling API: DealApi.get_deal_incentive_plan ...'
173
+ end
174
+ # verify the required parameter 'id' is set
175
+ if @api_client.config.client_side_validation && id.nil?
176
+ fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.get_deal_incentive_plan"
177
+ end
178
+ # resource path
179
+ local_var_path = '/deals/{id}/incentive_plan'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
180
+
181
+ # query parameters
182
+ query_params = opts[:query_params] || {}
183
+ query_params[:'investment_amount'] = opts[:'investment_amount'] if !opts[:'investment_amount'].nil?
184
+
185
+ # header parameters
186
+ header_params = opts[:header_params] || {}
187
+ # HTTP header 'Accept' (if needed)
188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
189
+
190
+ # form parameters
191
+ form_params = opts[:form_params] || {}
192
+
193
+ # http body (model)
194
+ post_body = opts[:debug_body]
195
+
196
+ # return_type
197
+ return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
198
+
199
+ # auth_names
200
+ auth_names = opts[:debug_auth_names] || []
201
+
202
+ new_options = opts.merge(
203
+ :operation => :"DealApi.get_deal_incentive_plan",
204
+ :header_params => header_params,
205
+ :query_params => query_params,
206
+ :form_params => form_params,
207
+ :body => post_body,
208
+ :auth_names => auth_names,
209
+ :return_type => return_type
210
+ )
211
+
212
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
213
+ if @api_client.config.debugging
214
+ @api_client.config.logger.debug "API called: DealApi#get_deal_incentive_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
215
+ end
216
+ return data, status_code, headers
217
+ end
218
+
153
219
  # List available deals
154
220
  # List available deals
155
221
  # @param [Hash] opts the optional parameters
@@ -82,6 +82,69 @@ module DealMakerAPI
82
82
  return data, status_code, headers
83
83
  end
84
84
 
85
+ # Get payout account data
86
+ # Get payout account data
87
+ # @param deal_id [Integer]
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData]
90
+ def get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data(deal_id, opts = {})
91
+ data, _status_code, _headers = get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info(deal_id, opts)
92
+ data
93
+ end
94
+
95
+ # Get payout account data
96
+ # Get payout account data
97
+ # @param deal_id [Integer]
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [Array<(V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData, Integer, Hash)>] V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData data, response status code and response headers
100
+ def get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data_with_http_info(deal_id, opts = {})
101
+ if @api_client.config.debugging
102
+ @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data ...'
103
+ end
104
+ # verify the required parameter 'deal_id' is set
105
+ if @api_client.config.client_side_validation && deal_id.nil?
106
+ fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data"
107
+ end
108
+ # resource path
109
+ local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data'.sub('{' + 'deal_id' + '}', CGI.escape(deal_id.to_s))
110
+
111
+ # query parameters
112
+ query_params = opts[:query_params] || {}
113
+
114
+ # header parameters
115
+ header_params = opts[:header_params] || {}
116
+ # HTTP header 'Accept' (if needed)
117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
118
+
119
+ # form parameters
120
+ form_params = opts[:form_params] || {}
121
+
122
+ # http body (model)
123
+ post_body = opts[:debug_body]
124
+
125
+ # return_type
126
+ return_type = opts[:debug_return_type] || 'V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData'
127
+
128
+ # auth_names
129
+ auth_names = opts[:debug_auth_names] || []
130
+
131
+ new_options = opts.merge(
132
+ :operation => :"DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data",
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: DefaultApi#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+
85
148
  # Displays the express wire instructions for an investor on a deal
86
149
  # Get express wire instructions
87
150
  # @param id [Integer]
@@ -627,7 +627,7 @@ module DealMakerAPI
627
627
  # @param id [Integer] The deal id.
628
628
  # @param investor_id [Integer] The investor id.
629
629
  # @param [Hash] opts the optional parameters
630
- # @return [V1EntitiesInvestorPriceDetails]
630
+ # @return [V1EntitiesDealsPriceDetails]
631
631
  def get_incentive_plan(id, investor_id, opts = {})
632
632
  data, _status_code, _headers = get_incentive_plan_with_http_info(id, investor_id, opts)
633
633
  data
@@ -638,7 +638,7 @@ module DealMakerAPI
638
638
  # @param id [Integer] The deal id.
639
639
  # @param investor_id [Integer] The investor id.
640
640
  # @param [Hash] opts the optional parameters
641
- # @return [Array<(V1EntitiesInvestorPriceDetails, Integer, Hash)>] V1EntitiesInvestorPriceDetails data, response status code and response headers
641
+ # @return [Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>] V1EntitiesDealsPriceDetails data, response status code and response headers
642
642
  def get_incentive_plan_with_http_info(id, investor_id, opts = {})
643
643
  if @api_client.config.debugging
644
644
  @api_client.config.logger.debug 'Calling API: InvestorApi.get_incentive_plan ...'
@@ -669,7 +669,7 @@ module DealMakerAPI
669
669
  post_body = opts[:debug_body]
670
670
 
671
671
  # return_type
672
- return_type = opts[:debug_return_type] || 'V1EntitiesInvestorPriceDetails'
672
+ return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
673
673
 
674
674
  # auth_names
675
675
  auth_names = opts[:debug_auth_names] || []
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DealMakerAPI
17
- class V1EntitiesInvestorIncentivePlan
17
+ class V1EntitiesDealsIncentivePlan
18
18
  # The incentive plan id.
19
19
  attr_accessor :id
20
20
 
@@ -36,6 +36,28 @@ module DealMakerAPI
36
36
  # The last update time.
37
37
  attr_accessor :updated_at
38
38
 
39
+ class EnumAttributeValidator
40
+ attr_reader :datatype
41
+ attr_reader :allowable_values
42
+
43
+ def initialize(datatype, allowable_values)
44
+ @allowable_values = allowable_values.map do |value|
45
+ case datatype.to_s
46
+ when /Integer/i
47
+ value.to_i
48
+ when /Float/i
49
+ value.to_f
50
+ else
51
+ value
52
+ end
53
+ end
54
+ end
55
+
56
+ def valid?(value)
57
+ !value || allowable_values.include?(value)
58
+ end
59
+ end
60
+
39
61
  # Attribute mapping from ruby-style variable name to JSON key.
40
62
  def self.attribute_map
41
63
  {
@@ -77,13 +99,13 @@ module DealMakerAPI
77
99
  # @param [Hash] attributes Model attributes in the form of hash
78
100
  def initialize(attributes = {})
79
101
  if (!attributes.is_a?(Hash))
80
- fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::V1EntitiesInvestorIncentivePlan` initialize method"
102
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::V1EntitiesDealsIncentivePlan` initialize method"
81
103
  end
82
104
 
83
105
  # check to see if the attribute exists and convert string to symbol for hash key
84
106
  attributes = attributes.each_with_object({}) { |(k, v), h|
85
107
  if (!self.class.attribute_map.key?(k.to_sym))
86
- fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::V1EntitiesInvestorIncentivePlan`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
108
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::V1EntitiesDealsIncentivePlan`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
87
109
  end
88
110
  h[k.to_sym] = v
89
111
  }
@@ -129,9 +151,21 @@ module DealMakerAPI
129
151
  # @return true if the model is valid
130
152
  def valid?
131
153
  warn '[DEPRECATED] the `valid?` method is obsolete'
154
+ plan_type_validator = EnumAttributeValidator.new('String', ["time"])
155
+ return false unless plan_type_validator.valid?(@plan_type)
132
156
  true
133
157
  end
134
158
 
159
+ # Custom attribute writer method checking allowed values (enum).
160
+ # @param [Object] plan_type Object to be assigned
161
+ def plan_type=(plan_type)
162
+ validator = EnumAttributeValidator.new('String', ["time"])
163
+ unless validator.valid?(plan_type)
164
+ fail ArgumentError, "invalid value for \"plan_type\", must be one of #{validator.allowable_values}."
165
+ end
166
+ @plan_type = plan_type
167
+ end
168
+
135
169
  # Checks equality by comparing each attribute.
136
170
  # @param [Object] Object to be compared
137
171
  def ==(o)
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module DealMakerAPI
17
- class V1EntitiesInvestorIncentiveTier
17
+ class V1EntitiesDealsIncentivePlansIncentiveTier
18
18
  # The incentive tier id.
19
19
  attr_accessor :id
20
20
 
@@ -67,13 +67,13 @@ module DealMakerAPI
67
67
  # @param [Hash] attributes Model attributes in the form of hash
68
68
  def initialize(attributes = {})
69
69
  if (!attributes.is_a?(Hash))
70
- fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::V1EntitiesInvestorIncentiveTier` initialize method"
70
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier` initialize method"
71
71
  end
72
72
 
73
73
  # check to see if the attribute exists and convert string to symbol for hash key
74
74
  attributes = attributes.each_with_object({}) { |(k, v), h|
75
75
  if (!self.class.attribute_map.key?(k.to_sym))
76
- fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::V1EntitiesInvestorIncentiveTier`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
77
  end
78
78
  h[k.to_sym] = v
79
79
  }