Class: DealMakerAPI::InvestorProfileApi

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/api/investor_profile_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvestorProfileApi

Returns a new instance of InvestorProfileApi.



19
20
21
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_corporation_profile(investor_profiles_corporations, opts = {}) ⇒ V1EntitiesInvestorProfileId

Create new corporation investor profile. Create new corporation investor profile associated to the user by email.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 27

def create_corporation_profile(investor_profiles_corporations, opts = {})
  data, _status_code, _headers = create_corporation_profile_with_http_info(investor_profiles_corporations, opts)
  data
end

#create_corporation_profile_with_http_info(investor_profiles_corporations, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Create new corporation investor profile. Create new corporation investor profile associated to the user by email.

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 37

def create_corporation_profile_with_http_info(investor_profiles_corporations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.create_corporation_profile ...'
  end
  # verify the required parameter 'investor_profiles_corporations' is set
  if @api_client.config.client_side_validation && investor_profiles_corporations.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_corporations' when calling InvestorProfileApi.create_corporation_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/corporations'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_corporations)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.create_corporation_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#create_corporation_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_individual_profile(investor_profiles_individuals, opts = {}) ⇒ V1EntitiesInvestorProfileId

Create new individual investor profile Create new individual investor profile associated to the user by email.

Parameters:

Returns:



95
96
97
98
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 95

def create_individual_profile(investor_profiles_individuals, opts = {})
  data, _status_code, _headers = create_individual_profile_with_http_info(investor_profiles_individuals, opts)
  data
end

#create_individual_profile_with_http_info(investor_profiles_individuals, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Create new individual investor profile Create new individual investor profile associated to the user by email.

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 105

def create_individual_profile_with_http_info(investor_profiles_individuals, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.create_individual_profile ...'
  end
  # verify the required parameter 'investor_profiles_individuals' is set
  if @api_client.config.client_side_validation && investor_profiles_individuals.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_individuals' when calling InvestorProfileApi.create_individual_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/individuals'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_individuals)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.create_individual_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#create_individual_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_joint_profile(investor_profiles_joints, opts = {}) ⇒ V1EntitiesInvestorProfileId

Create new joint investor profile Create new joint investor profile associated to the user by email.

Parameters:

Returns:



163
164
165
166
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 163

def create_joint_profile(investor_profiles_joints, opts = {})
  data, _status_code, _headers = create_joint_profile_with_http_info(investor_profiles_joints, opts)
  data
end

#create_joint_profile_with_http_info(investor_profiles_joints, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Create new joint investor profile Create new joint investor profile associated to the user by email.

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 173

def create_joint_profile_with_http_info(investor_profiles_joints, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.create_joint_profile ...'
  end
  # verify the required parameter 'investor_profiles_joints' is set
  if @api_client.config.client_side_validation && investor_profiles_joints.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_joints' when calling InvestorProfileApi.create_joint_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/joints'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_joints)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.create_joint_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#create_joint_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_managed_profile(investor_profiles_managed, opts = {}) ⇒ V1EntitiesInvestorProfileId

Create new managed investor profile. Create new managed investor profile associated to the user by email.

Parameters:

Returns:



231
232
233
234
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 231

def create_managed_profile(investor_profiles_managed, opts = {})
  data, _status_code, _headers = create_managed_profile_with_http_info(investor_profiles_managed, opts)
  data
end

#create_managed_profile_with_http_info(investor_profiles_managed, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Create new managed investor profile. Create new managed investor profile associated to the user by email.

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 241

def create_managed_profile_with_http_info(investor_profiles_managed, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.create_managed_profile ...'
  end
  # verify the required parameter 'investor_profiles_managed' is set
  if @api_client.config.client_side_validation && investor_profiles_managed.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_managed' when calling InvestorProfileApi.create_managed_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/managed'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_managed)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.create_managed_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#create_managed_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_trust_profile(investor_profiles_trusts, opts = {}) ⇒ V1EntitiesInvestorProfileId

Create new trust investor profile. Create new trust investor profile associated to the user by email.

Parameters:

Returns:



299
300
301
302
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 299

def create_trust_profile(investor_profiles_trusts, opts = {})
  data, _status_code, _headers = create_trust_profile_with_http_info(investor_profiles_trusts, opts)
  data
end

#create_trust_profile_with_http_info(investor_profiles_trusts, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Create new trust investor profile. Create new trust investor profile associated to the user by email.

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 309

def create_trust_profile_with_http_info(investor_profiles_trusts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.create_trust_profile ...'
  end
  # verify the required parameter 'investor_profiles_trusts' is set
  if @api_client.config.client_side_validation && investor_profiles_trusts.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_trusts' when calling InvestorProfileApi.create_trust_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/trusts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_trusts)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.create_trust_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#create_trust_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deal_investor_profiles(deal_id, opts = {}) ⇒ V1EntitiesInvestorProfiles

Get list of InvestorProfiles for a specific deal Get investor profiles for a specific deal. Because an investor profile belongs to the user associated with it, external applications may not use this endpoint for other profiles. Only the user may use this endpoint for their own profiles (i.e. to see existing profiles within the DealMaker application).

Parameters:

  • deal_id (Integer) —

    The deal id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

  • :user_id (Integer) —

    The user id filter.

Returns:



371
372
373
374
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 371

def get_deal_investor_profiles(deal_id, opts = {})
  data, _status_code, _headers = get_deal_investor_profiles_with_http_info(deal_id, opts)
  data
end

#get_deal_investor_profiles_with_http_info(deal_id, opts = {}) ⇒ Array<(V1EntitiesInvestorProfiles, Integer, Hash)>

Get list of InvestorProfiles for a specific deal Get investor profiles for a specific deal. Because an investor profile belongs to the user associated with it, external applications may not use this endpoint for other profiles. Only the user may use this endpoint for their own profiles (i.e. to see existing profiles within the DealMaker application).

Parameters:

  • deal_id (Integer) —

    The deal id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

  • :user_id (Integer) —

    The user id filter.

Returns:

  • (Array<(V1EntitiesInvestorProfiles, Integer, Hash)>) —

    V1EntitiesInvestorProfiles data, response status code and response headers



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 385

def get_deal_investor_profiles_with_http_info(deal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.get_deal_investor_profiles ...'
  end
  # verify the required parameter 'deal_id' is set
  if @api_client.config.client_side_validation && deal_id.nil?
    fail ArgumentError, "Missing the required parameter 'deal_id' when calling InvestorProfileApi.get_deal_investor_profiles"
  end
  # resource path
  local_var_path = '/investor_profiles/{deal_id}'.sub('{' + 'deal_id' + '}', CGI.escape(deal_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfiles'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.get_deal_investor_profiles",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#get_deal_investor_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investor_profile(id, opts = {}) ⇒ V1EntitiesInvestorProfileItem

Get an investor profile by id Get an investor profile. Because an investor profile belongs to the user associated with it, external applications may not use this endpoint for other profiles. Only the user may use this endpoint for their own profiles (i.e. to see existing profiles within the DealMaker application).

Parameters:

  • id (Integer) —

    The id of the investor profile.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



442
443
444
445
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 442

def get_investor_profile(id, opts = {})
  data, _status_code, _headers = get_investor_profile_with_http_info(id, opts)
  data
end

#get_investor_profile_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileItem, Integer, Hash)>

Get an investor profile by id Get an investor profile. Because an investor profile belongs to the user associated with it, external applications may not use this endpoint for other profiles. Only the user may use this endpoint for their own profiles (i.e. to see existing profiles within the DealMaker application).

Parameters:

  • id (Integer) —

    The id of the investor profile.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 452

def get_investor_profile_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.get_investor_profile ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvestorProfileApi.get_investor_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/profile/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileItem'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.get_investor_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#get_investor_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investor_profiles(opts = {}) ⇒ V1EntitiesInvestorProfiles

Get list of InvestorProfiles Get investor profiles. Because an investor profile belongs to the user associated with it, external applications may not use this endpoint for other profiles. Only the user may use this endpoint for their own profiles (i.e. to see existing profiles within the DealMaker application).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:



507
508
509
510
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 507

def get_investor_profiles(opts = {})
  data, _status_code, _headers = get_investor_profiles_with_http_info(opts)
  data
end

#get_investor_profiles_with_http_info(opts = {}) ⇒ Array<(V1EntitiesInvestorProfiles, Integer, Hash)>

Get list of InvestorProfiles Get investor profiles. Because an investor profile belongs to the user associated with it, external applications may not use this endpoint for other profiles. Only the user may use this endpoint for their own profiles (i.e. to see existing profiles within the DealMaker application).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:

  • (Array<(V1EntitiesInvestorProfiles, Integer, Hash)>) —

    V1EntitiesInvestorProfiles data, response status code and response headers



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 519

def get_investor_profiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.get_investor_profiles ...'
  end
  # resource path
  local_var_path = '/investor_profiles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfiles'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.get_investor_profiles",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#get_investor_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_corporation_profile(investor_profile_id, investor_profiles_corporations, opts = {}) ⇒ V1EntitiesInvestorProfileId

Patch a corporation investor profile Patch corporation investor profile

Parameters:

Returns:



572
573
574
575
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 572

def patch_corporation_profile(investor_profile_id, investor_profiles_corporations, opts = {})
  data, _status_code, _headers = patch_corporation_profile_with_http_info(investor_profile_id, investor_profiles_corporations, opts)
  data
end

#patch_corporation_profile_with_http_info(investor_profile_id, investor_profiles_corporations, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Patch a corporation investor profile Patch corporation investor profile

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 583

def patch_corporation_profile_with_http_info(investor_profile_id, investor_profiles_corporations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.patch_corporation_profile ...'
  end
  # verify the required parameter 'investor_profile_id' is set
  if @api_client.config.client_side_validation && investor_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profile_id' when calling InvestorProfileApi.patch_corporation_profile"
  end
  # verify the required parameter 'investor_profiles_corporations' is set
  if @api_client.config.client_side_validation && investor_profiles_corporations.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_corporations' when calling InvestorProfileApi.patch_corporation_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/corporations/{investor_profile_id}'.sub('{' + 'investor_profile_id' + '}', CGI.escape(investor_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_corporations)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.patch_corporation_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#patch_corporation_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_individual_profile(investor_profile_id, investor_profiles_individuals, opts = {}) ⇒ V1EntitiesInvestorProfileId

Patch an individual investor profile. Patch individual investor profile.

Parameters:

Returns:



646
647
648
649
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 646

def patch_individual_profile(investor_profile_id, investor_profiles_individuals, opts = {})
  data, _status_code, _headers = patch_individual_profile_with_http_info(investor_profile_id, investor_profiles_individuals, opts)
  data
end

#patch_individual_profile_with_http_info(investor_profile_id, investor_profiles_individuals, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Patch an individual investor profile. Patch individual investor profile.

Parameters:

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 657

def patch_individual_profile_with_http_info(investor_profile_id, investor_profiles_individuals, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.patch_individual_profile ...'
  end
  # verify the required parameter 'investor_profile_id' is set
  if @api_client.config.client_side_validation && investor_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profile_id' when calling InvestorProfileApi.patch_individual_profile"
  end
  # verify the required parameter 'investor_profiles_individuals' is set
  if @api_client.config.client_side_validation && investor_profiles_individuals.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_individuals' when calling InvestorProfileApi.patch_individual_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/individuals/{investor_profile_id}'.sub('{' + 'investor_profile_id' + '}', CGI.escape(investor_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_individuals)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.patch_individual_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#patch_individual_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_joint_profile(investor_profile_id, investor_profiles_joints, opts = {}) ⇒ V1EntitiesInvestorProfileId

Patch a joint investor profile Patch joint investor profile

Parameters:

  • investor_profile_id (Integer)
  • investor_profiles_joints (PatchInvestorProfilesJoints)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



720
721
722
723
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 720

def patch_joint_profile(investor_profile_id, investor_profiles_joints, opts = {})
  data, _status_code, _headers = patch_joint_profile_with_http_info(investor_profile_id, investor_profiles_joints, opts)
  data
end

#patch_joint_profile_with_http_info(investor_profile_id, investor_profiles_joints, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Patch a joint investor profile Patch joint investor profile

Parameters:

  • investor_profile_id (Integer)
  • investor_profiles_joints (PatchInvestorProfilesJoints)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 731

def patch_joint_profile_with_http_info(investor_profile_id, investor_profiles_joints, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.patch_joint_profile ...'
  end
  # verify the required parameter 'investor_profile_id' is set
  if @api_client.config.client_side_validation && investor_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profile_id' when calling InvestorProfileApi.patch_joint_profile"
  end
  # verify the required parameter 'investor_profiles_joints' is set
  if @api_client.config.client_side_validation && investor_profiles_joints.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_joints' when calling InvestorProfileApi.patch_joint_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/joints/{investor_profile_id}'.sub('{' + 'investor_profile_id' + '}', CGI.escape(investor_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_joints)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.patch_joint_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#patch_joint_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_managed_profile(investor_profile_id, investor_profiles_managed, opts = {}) ⇒ V1EntitiesInvestorProfileId

Patch managed investor profile. Patch managed investor profile associated to the profile id.

Parameters:

  • investor_profile_id (Integer)
  • investor_profiles_managed (PatchInvestorProfilesManaged)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



794
795
796
797
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 794

def patch_managed_profile(investor_profile_id, investor_profiles_managed, opts = {})
  data, _status_code, _headers = patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed, opts)
  data
end

#patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Patch managed investor profile. Patch managed investor profile associated to the profile id.

Parameters:

  • investor_profile_id (Integer)
  • investor_profiles_managed (PatchInvestorProfilesManaged)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 805

def patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.patch_managed_profile ...'
  end
  # verify the required parameter 'investor_profile_id' is set
  if @api_client.config.client_side_validation && investor_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profile_id' when calling InvestorProfileApi.patch_managed_profile"
  end
  # verify the required parameter 'investor_profiles_managed' is set
  if @api_client.config.client_side_validation && investor_profiles_managed.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_managed' when calling InvestorProfileApi.patch_managed_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/managed/{investor_profile_id}'.sub('{' + 'investor_profile_id' + '}', CGI.escape(investor_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_managed)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.patch_managed_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#patch_managed_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_trust_profile(investor_profile_id, investor_profiles_trusts, opts = {}) ⇒ V1EntitiesInvestorProfileId

Patch a trust investor profile Patch trust investor profile

Parameters:

  • investor_profile_id (Integer)
  • investor_profiles_trusts (PatchInvestorProfilesTrusts)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



868
869
870
871
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 868

def patch_trust_profile(investor_profile_id, investor_profiles_trusts, opts = {})
  data, _status_code, _headers = patch_trust_profile_with_http_info(investor_profile_id, investor_profiles_trusts, opts)
  data
end

#patch_trust_profile_with_http_info(investor_profile_id, investor_profiles_trusts, opts = {}) ⇒ Array<(V1EntitiesInvestorProfileId, Integer, Hash)>

Patch a trust investor profile Patch trust investor profile

Parameters:

  • investor_profile_id (Integer)
  • investor_profiles_trusts (PatchInvestorProfilesTrusts)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(V1EntitiesInvestorProfileId, Integer, Hash)>) —

    V1EntitiesInvestorProfileId data, response status code and response headers



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/DealMakerAPI/api/investor_profile_api.rb', line 879

def patch_trust_profile_with_http_info(investor_profile_id, investor_profiles_trusts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorProfileApi.patch_trust_profile ...'
  end
  # verify the required parameter 'investor_profile_id' is set
  if @api_client.config.client_side_validation && investor_profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profile_id' when calling InvestorProfileApi.patch_trust_profile"
  end
  # verify the required parameter 'investor_profiles_trusts' is set
  if @api_client.config.client_side_validation && investor_profiles_trusts.nil?
    fail ArgumentError, "Missing the required parameter 'investor_profiles_trusts' when calling InvestorProfileApi.patch_trust_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/trusts/{investor_profile_id}'.sub('{' + 'investor_profile_id' + '}', CGI.escape(investor_profile_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_trusts)

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"InvestorProfileApi.patch_trust_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorProfileApi#patch_trust_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end