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.
- checksums.yaml +4 -4
- data/README.md +15 -7
- data/docs/DealApi.md +69 -0
- data/docs/DefaultApi.md +67 -0
- data/docs/InvestorApi.md +4 -4
- data/docs/InvestorProfileApi.md +67 -0
- data/docs/PostInvestorProfilesManaged.md +68 -0
- data/docs/{V1EntitiesInvestorIncentivePlan.md → V1EntitiesDealsIncentivePlan.md} +2 -2
- data/docs/{V1EntitiesInvestorIncentiveTier.md → V1EntitiesDealsIncentivePlansIncentiveTier.md} +2 -2
- data/docs/V1EntitiesDealsPriceDetails.md +28 -0
- data/docs/V1EntitiesInvestorProfileFieldsBeneficiary.md +32 -0
- data/docs/V1EntitiesInvestorProfileFieldsProvider.md +30 -0
- data/docs/V1EntitiesInvestorProfileItem.md +1 -1
- data/docs/V1EntitiesInvestorProfileManaged.md +38 -0
- data/docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md +18 -0
- data/lib/DealMakerAPI/api/deal_api.rb +66 -0
- data/lib/DealMakerAPI/api/default_api.rb +63 -0
- data/lib/DealMakerAPI/api/investor_api.rb +3 -3
- data/lib/DealMakerAPI/api/investor_profile_api.rb +68 -0
- data/lib/DealMakerAPI/models/post_investor_profiles_managed.rb +519 -0
- data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_plan.rb → v1_entities_deals_incentive_plan.rb} +37 -3
- data/lib/DealMakerAPI/models/{v1_entities_investor_incentive_tier.rb → v1_entities_deals_incentive_plans_incentive_tier.rb} +3 -3
- data/lib/DealMakerAPI/models/{v1_entities_investor_price_details.rb → v1_entities_deals_price_details.rb} +27 -7
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +2 -2
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary.rb +284 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_provider.rb +274 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +2 -2
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +2 -2
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_managed.rb +347 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +2 -2
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data.rb +216 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +8 -3
- data/spec/api/deal_api_spec.rb +13 -0
- data/spec/api/default_api_spec.rb +12 -0
- data/spec/api/investor_api_spec.rb +1 -1
- data/spec/api/investor_profile_api_spec.rb +12 -0
- data/spec/models/post_investor_profiles_managed_spec.rb +194 -0
- data/spec/models/{v1_entities_investor_incentive_plan_spec.rb → v1_entities_deals_incentive_plan_spec.rb} +10 -6
- data/spec/models/{v1_entities_investor_incentive_tier_spec.rb → v1_entities_deals_incentive_plans_incentive_tier_spec.rb} +6 -6
- data/spec/models/{v1_entities_investor_price_details_spec.rb → v1_entities_deals_price_details_spec.rb} +18 -6
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb +78 -0
- data/spec/models/v1_entities_investor_profile_fields_provider_spec.rb +72 -0
- data/spec/models/v1_entities_investor_profile_individual_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 +100 -0
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb +36 -0
- metadata +119 -99
- data/docs/V1EntitiesInvestorPriceDetails.md +0 -24
@@ -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 [
|
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<(
|
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] || '
|
672
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
|
673
673
|
|
674
674
|
# auth_names
|
675
675
|
auth_names = opts[:debug_auth_names] || []
|
@@ -223,6 +223,74 @@ module DealMakerAPI
|
|
223
223
|
return data, status_code, headers
|
224
224
|
end
|
225
225
|
|
226
|
+
# Create new managed investor profile.
|
227
|
+
# Create new managed investor profile associated to the user by email.
|
228
|
+
# @param investor_profiles_managed [PostInvestorProfilesManaged]
|
229
|
+
# @param [Hash] opts the optional parameters
|
230
|
+
# @return [V1EntitiesInvestorProfileManaged]
|
231
|
+
def create_managed_profile(investor_profiles_managed, opts = {})
|
232
|
+
data, _status_code, _headers = create_managed_profile_with_http_info(investor_profiles_managed, opts)
|
233
|
+
data
|
234
|
+
end
|
235
|
+
|
236
|
+
# Create new managed investor profile.
|
237
|
+
# Create new managed investor profile associated to the user by email.
|
238
|
+
# @param investor_profiles_managed [PostInvestorProfilesManaged]
|
239
|
+
# @param [Hash] opts the optional parameters
|
240
|
+
# @return [Array<(V1EntitiesInvestorProfileManaged, Integer, Hash)>] V1EntitiesInvestorProfileManaged data, response status code and response headers
|
241
|
+
def create_managed_profile_with_http_info(investor_profiles_managed, opts = {})
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug 'Calling API: InvestorProfileApi.create_managed_profile ...'
|
244
|
+
end
|
245
|
+
# verify the required parameter 'investor_profiles_managed' is set
|
246
|
+
if @api_client.config.client_side_validation && investor_profiles_managed.nil?
|
247
|
+
fail ArgumentError, "Missing the required parameter 'investor_profiles_managed' when calling InvestorProfileApi.create_managed_profile"
|
248
|
+
end
|
249
|
+
# resource path
|
250
|
+
local_var_path = '/investor_profiles/managed'
|
251
|
+
|
252
|
+
# query parameters
|
253
|
+
query_params = opts[:query_params] || {}
|
254
|
+
|
255
|
+
# header parameters
|
256
|
+
header_params = opts[:header_params] || {}
|
257
|
+
# HTTP header 'Accept' (if needed)
|
258
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
259
|
+
# HTTP header 'Content-Type'
|
260
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
261
|
+
if !content_type.nil?
|
262
|
+
header_params['Content-Type'] = content_type
|
263
|
+
end
|
264
|
+
|
265
|
+
# form parameters
|
266
|
+
form_params = opts[:form_params] || {}
|
267
|
+
|
268
|
+
# http body (model)
|
269
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_managed)
|
270
|
+
|
271
|
+
# return_type
|
272
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileManaged'
|
273
|
+
|
274
|
+
# auth_names
|
275
|
+
auth_names = opts[:debug_auth_names] || []
|
276
|
+
|
277
|
+
new_options = opts.merge(
|
278
|
+
:operation => :"InvestorProfileApi.create_managed_profile",
|
279
|
+
:header_params => header_params,
|
280
|
+
:query_params => query_params,
|
281
|
+
:form_params => form_params,
|
282
|
+
:body => post_body,
|
283
|
+
:auth_names => auth_names,
|
284
|
+
:return_type => return_type
|
285
|
+
)
|
286
|
+
|
287
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
288
|
+
if @api_client.config.debugging
|
289
|
+
@api_client.config.logger.debug "API called: InvestorProfileApi#create_managed_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
290
|
+
end
|
291
|
+
return data, status_code, headers
|
292
|
+
end
|
293
|
+
|
226
294
|
# Create new trust investor profile.
|
227
295
|
# Create new trust investor profile associated to the user by email.
|
228
296
|
# @param investor_profiles_trusts [PostInvestorProfilesTrusts]
|