Class: DealMakerAPI::InvestorApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvestorApi

Returns a new instance of InvestorApi.



19
20
21
 
# File 'lib/DealMakerAPI/api/investor_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_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add506c_document(id, investor_id, add506c_document_request, opts = {}) ⇒ V1EntitiesInvestor

Add 506c document for deal investor Add 506c document for deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 29

def add506c_document(id, investor_id, add506c_document_request, opts = {})
  data, _status_code, _headers = add506c_document_with_http_info(id, investor_id, add506c_document_request, opts)
  data
end

#add506c_document_with_http_info(id, investor_id, add506c_document_request, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Add 506c document for deal investor Add 506c document for deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 41

def add506c_document_with_http_info(id, investor_id, add506c_document_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.add506c_document ...'
  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 InvestorApi.add506c_document"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.add506c_document"
  end
  # verify the required parameter 'add506c_document_request' is set
  if @api_client.config.client_side_validation && add506c_document_request.nil?
    fail ArgumentError, "Missing the required parameter 'add506c_document_request' when calling InvestorApi.add506c_document"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/add_506c_document'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])
  # 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(add506c_document_request)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.add506c_document",
    :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: InvestorApi#add506c_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_document(id, investor_id, add_document_request, opts = {}) ⇒ V1EntitiesInvestor

Add document for deal investor Add document for deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



109
110
111
112
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 109

def add_document(id, investor_id, add_document_request, opts = {})
  data, _status_code, _headers = add_document_with_http_info(id, investor_id, add_document_request, opts)
  data
end

#add_document_with_http_info(id, investor_id, add_document_request, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Add document for deal investor Add document for deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 121

def add_document_with_http_info(id, investor_id, add_document_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.add_document ...'
  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 InvestorApi.add_document"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.add_document"
  end
  # verify the required parameter 'add_document_request' is set
  if @api_client.config.client_side_validation && add_document_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_document_request' when calling InvestorApi.add_document"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/add_document'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])
  # 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(add_document_request)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.add_document",
    :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: InvestorApi#add_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bulk_upload_investors(id, bulk_upload_investors_request, opts = {}) ⇒ V1EntitiesInvestor

Bulk upload investors for deal investor Bulk upload investors

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 188

def bulk_upload_investors(id, bulk_upload_investors_request, opts = {})
  data, _status_code, _headers = bulk_upload_investors_with_http_info(id, bulk_upload_investors_request, opts)
  data
end

#bulk_upload_investors_with_http_info(id, bulk_upload_investors_request, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Bulk upload investors for deal investor Bulk upload investors

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 199

def bulk_upload_investors_with_http_info(id, bulk_upload_investors_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.bulk_upload_investors ...'
  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 InvestorApi.bulk_upload_investors"
  end
  # verify the required parameter 'bulk_upload_investors_request' is set
  if @api_client.config.client_side_validation && bulk_upload_investors_request.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_upload_investors_request' when calling InvestorApi.bulk_upload_investors"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/bulk_upload'.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'])
  # 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(bulk_upload_investors_request)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.bulk_upload_investors",
    :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: InvestorApi#bulk_upload_investors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_investor(id, deals_id_investors, opts = {}) ⇒ V1EntitiesInvestor

Create a deal investor Create a single deal investor.

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 262

def create_investor(id, deals_id_investors, opts = {})
  data, _status_code, _headers = create_investor_with_http_info(id, deals_id_investors, opts)
  data
end

#create_investor_with_http_info(id, deals_id_investors, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Create a deal investor Create a single deal investor.

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 273

def create_investor_with_http_info(id, deals_id_investors, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.create_investor ...'
  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 InvestorApi.create_investor"
  end
  # verify the required parameter 'deals_id_investors' is set
  if @api_client.config.client_side_validation && deals_id_investors.nil?
    fail ArgumentError, "Missing the required parameter 'deals_id_investors' when calling InvestorApi.create_investor"
  end
  # resource path
  local_var_path = '/deals/{id}/investors'.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'])
  # 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(deals_id_investors)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.create_investor",
    :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: InvestorApi#create_investor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document(id, investor_id, document_id, opts = {}) ⇒ nil

Delete document for deal investor Delete document for deal investor

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • document_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


337
338
339
340
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 337

def delete_document(id, investor_id, document_id, opts = {})
  delete_document_with_http_info(id, investor_id, document_id, opts)
  nil
end

#delete_document_with_http_info(id, investor_id, document_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete document for deal investor Delete document for deal investor

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • document_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 349

def delete_document_with_http_info(id, investor_id, document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.delete_document ...'
  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 InvestorApi.delete_document"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.delete_document"
  end
  # verify the required parameter 'document_id' is set
  if @api_client.config.client_side_validation && document_id.nil?
    fail ArgumentError, "Missing the required parameter 'document_id' when calling InvestorApi.delete_document"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/delete_document/{document_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"InvestorApi.delete_document",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorApi#delete_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_investor_profile(type, id, opts = {}) ⇒ nil

Delete investor profile. Deletes the investor profile.

Parameters:

  • type (Integer)
  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


409
410
411
412
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 409

def delete_investor_profile(type, id, opts = {})
  delete_investor_profile_with_http_info(type, id, opts)
  nil
end

#delete_investor_profile_with_http_info(type, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete investor profile. Deletes the investor profile.

Parameters:

  • type (Integer)
  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 420

def delete_investor_profile_with_http_info(type, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.delete_investor_profile ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling InvestorApi.delete_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 InvestorApi.delete_investor_profile"
  end
  # resource path
  local_var_path = '/investor_profiles/{type}/{id}'.sub('{' + 'type' + '}', CGI.escape(type.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"InvestorApi.delete_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorApi#delete_investor_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_investor_tags(id, investor_id, edit_investor_tags_request, opts = {}) ⇒ V1EntitiesInvestor

Append or replace tag(s) for a specific investor Edit investor tag

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • edit_investor_tags_request (EditInvestorTagsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



477
478
479
480
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 477

def edit_investor_tags(id, investor_id, edit_investor_tags_request, opts = {})
  data, _status_code, _headers = edit_investor_tags_with_http_info(id, investor_id, edit_investor_tags_request, opts)
  data
end

#edit_investor_tags_with_http_info(id, investor_id, edit_investor_tags_request, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Append or replace tag(s) for a specific investor Edit investor tag

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • edit_investor_tags_request (EditInvestorTagsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
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
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 489

def edit_investor_tags_with_http_info(id, investor_id, edit_investor_tags_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.edit_investor_tags ...'
  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 InvestorApi.edit_investor_tags"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.edit_investor_tags"
  end
  # verify the required parameter 'edit_investor_tags_request' is set
  if @api_client.config.client_side_validation && edit_investor_tags_request.nil?
    fail ArgumentError, "Missing the required parameter 'edit_investor_tags_request' when calling InvestorApi.edit_investor_tags"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/edit_tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])
  # 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(edit_investor_tags_request)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.edit_investor_tags",
    :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: InvestorApi#edit_investor_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deal_investor_search_entities(id, investor_id, opts = {}) ⇒ V1EntitiesInvestorSearchEntities

Get the search entities attached to the investor Get the entities that needs to be updated due to wrong information.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



556
557
558
559
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 556

def get_deal_investor_search_entities(id, investor_id, opts = {})
  data, _status_code, _headers = get_deal_investor_search_entities_with_http_info(id, investor_id, opts)
  data
end

#get_deal_investor_search_entities_with_http_info(id, investor_id, opts = {}) ⇒ Array<(V1EntitiesInvestorSearchEntities, Integer, Hash)>

Get the search entities attached to the investor Get the entities that needs to be updated due to wrong information.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
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
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 567

def get_deal_investor_search_entities_with_http_info(id, investor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.get_deal_investor_search_entities ...'
  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 InvestorApi.get_deal_investor_search_entities"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_deal_investor_search_entities"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/search_entities'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.get_deal_investor_search_entities",
    :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: InvestorApi#get_deal_investor_search_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_enforcements(id, investor_id, search_entity_id, opts = {}) ⇒ V1EntitiesInvestor

Get enforcements for a background search Get enforcements for a background search

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • search_entity_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



626
627
628
629
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 626

def get_enforcements(id, investor_id, search_entity_id, opts = {})
  data, _status_code, _headers = get_enforcements_with_http_info(id, investor_id, search_entity_id, opts)
  data
end

#get_enforcements_with_http_info(id, investor_id, search_entity_id, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Get enforcements for a background search Get enforcements for a background search

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • search_entity_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
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
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 638

def get_enforcements_with_http_info(id, investor_id, search_entity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.get_enforcements ...'
  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 InvestorApi.get_enforcements"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_enforcements"
  end
  # verify the required parameter 'search_entity_id' is set
  if @api_client.config.client_side_validation && search_entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'search_entity_id' when calling InvestorApi.get_enforcements"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/enforcements'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'search_entity_id' + '}', CGI.escape(search_entity_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.get_enforcements",
    :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: InvestorApi#get_enforcements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_incentive_plan(id, investor_id, opts = {}) ⇒ V1EntitiesDealsPriceDetails

Get investor incentive plan by investor id Gets a single investor incentive plan by the investor id.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



700
701
702
703
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 700

def get_incentive_plan(id, investor_id, opts = {})
  data, _status_code, _headers = get_incentive_plan_with_http_info(id, investor_id, opts)
  data
end

#get_incentive_plan_with_http_info(id, investor_id, opts = {}) ⇒ Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>

Get investor incentive plan by investor id Gets a single investor incentive plan by the investor id.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:

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

    V1EntitiesDealsPriceDetails data, response status code and response headers



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
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
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 711

def get_incentive_plan_with_http_info(id, investor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.get_incentive_plan ...'
  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 InvestorApi.get_incentive_plan"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_incentive_plan"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/incentive_plan'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.get_incentive_plan",
    :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: InvestorApi#get_incentive_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investor(id, investor_id, opts = {}) ⇒ V1EntitiesInvestor

Get a deal investor by id Gets a single investor by the id.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



769
770
771
772
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 769

def get_investor(id, investor_id, opts = {})
  data, _status_code, _headers = get_investor_with_http_info(id, investor_id, opts)
  data
end

#get_investor_otp_link(id, investor_id, opts = {}) ⇒ V1EntitiesInvestorOtpAccessLink

Get OTP access link for deal investor The access link for the investor. This is the access link for the specific investment, not the user. If the same user has multiple investments, each one will have a different access link. Please note that this access link expires every hour. In order to redirect the investor into their authentication screen, use the app.dealmaker.tech/deals/{deal_id}/investors/{investor_id}/otp_access url.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



838
839
840
841
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 838

def get_investor_otp_link(id, investor_id, opts = {})
  data, _status_code, _headers = get_investor_otp_link_with_http_info(id, investor_id, opts)
  data
end

#get_investor_otp_link_with_http_info(id, investor_id, opts = {}) ⇒ Array<(V1EntitiesInvestorOtpAccessLink, Integer, Hash)>

Get OTP access link for deal investor The access link for the investor. This is the access link for the specific investment, not the user. If the same user has multiple investments, each one will have a different access link. Please note that this access link expires every hour. In order to redirect the investor into their authentication screen, use the app.dealmaker.tech/deals/{deal_id}/investors/{investor_id}/otp_access url.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 849

def get_investor_otp_link_with_http_info(id, investor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.get_investor_otp_link ...'
  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 InvestorApi.get_investor_otp_link"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_investor_otp_link"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/otp_access_link'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.get_investor_otp_link",
    :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: InvestorApi#get_investor_otp_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investor_with_http_info(id, investor_id, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Get a deal investor by id Gets a single investor by the id.

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
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
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 780

def get_investor_with_http_info(id, investor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.get_investor ...'
  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 InvestorApi.get_investor"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.get_investor"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.get_investor",
    :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: InvestorApi#get_investor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_investors(id, opts = {}) ⇒ V1EntitiesInvestors

List deal investors List deal investors according to the specified search criteria.

Parameters:

  • 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)

  • :investor_ids (Array<Integer>) —

    An array of investor ids.

  • :q (String) —

    The search query for investors. For additional information on filtering and seach, click [here](#section/Search-and-Filtering-(The-q-parameter)/Keyword-filtering)

Returns:



911
912
913
914
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 911

def list_investors(id, opts = {})
  data, _status_code, _headers = list_investors_with_http_info(id, opts)
  data
end

#list_investors_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesInvestors, Integer, Hash)>

List deal investors List deal investors according to the specified search criteria.

Parameters:

  • 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)

  • :investor_ids (Array<Integer>) —

    An array of investor ids.

  • :q (String) —

    The search query for investors. For additional information on filtering and seach, click [here](#section/Search-and-Filtering-(The-q-parameter)/Keyword-filtering)

Returns:

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

    V1EntitiesInvestors data, response status code and response headers



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 926

def list_investors_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.list_investors ...'
  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 InvestorApi.list_investors"
  end
  # resource path
  local_var_path = '/deals/{id}/investors'.sub('{' + 'id' + '}', CGI.escape(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[:'investor_ids'] = @api_client.build_collection_param(opts[:'investor_ids'], :csv) if !opts[:'investor_ids'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.list_investors",
    :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: InvestorApi#list_investors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_investor(id, investor_id, patch_investor_request, opts = {}) ⇒ V1EntitiesInvestor

Patch a deal investor Patch deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



986
987
988
989
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 986

def patch_investor(id, investor_id, patch_investor_request, opts = {})
  data, _status_code, _headers = patch_investor_with_http_info(id, investor_id, patch_investor_request, opts)
  data
end

#patch_investor_with_http_info(id, investor_id, patch_investor_request, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Patch a deal investor Patch deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 998

def patch_investor_with_http_info(id, investor_id, patch_investor_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.patch_investor ...'
  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 InvestorApi.patch_investor"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.patch_investor"
  end
  # verify the required parameter 'patch_investor_request' is set
  if @api_client.config.client_side_validation && patch_investor_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_investor_request' when calling InvestorApi.patch_investor"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])
  # 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(patch_investor_request)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.patch_investor",
    :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: InvestorApi#patch_investor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_new_document(id, investor_id, search_entity_id, request_new_document_request, opts = {}) ⇒ nil

Request new document for a specific entity Request new document to entity

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • search_entity_id (Integer)
  • request_new_document_request (RequestNewDocumentRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1067
1068
1069
1070
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 1067

def request_new_document(id, investor_id, search_entity_id, request_new_document_request, opts = {})
  request_new_document_with_http_info(id, investor_id, search_entity_id, request_new_document_request, opts)
  nil
end

#request_new_document_with_http_info(id, investor_id, search_entity_id, request_new_document_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Request new document for a specific entity Request new document to entity

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • search_entity_id (Integer)
  • request_new_document_request (RequestNewDocumentRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 1080

def request_new_document_with_http_info(id, investor_id, search_entity_id, request_new_document_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.request_new_document ...'
  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 InvestorApi.request_new_document"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.request_new_document"
  end
  # verify the required parameter 'search_entity_id' is set
  if @api_client.config.client_side_validation && search_entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'search_entity_id' when calling InvestorApi.request_new_document"
  end
  # verify the required parameter 'request_new_document_request' is set
  if @api_client.config.client_side_validation && request_new_document_request.nil?
    fail ArgumentError, "Missing the required parameter 'request_new_document_request' when calling InvestorApi.request_new_document"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/send_review'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'search_entity_id' + '}', CGI.escape(search_entity_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(request_new_document_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"InvestorApi.request_new_document",
    :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: InvestorApi#request_new_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#run_background_search(id, investor_id, run_background_search_request, opts = {}) ⇒ nil

Run Alloy background search for the investor Run Alloy background search for the investor

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • run_background_search_request (RunBackgroundSearchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1150
1151
1152
1153
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 1150

def run_background_search(id, investor_id, run_background_search_request, opts = {})
  run_background_search_with_http_info(id, investor_id, run_background_search_request, opts)
  nil
end

#run_background_search_with_http_info(id, investor_id, run_background_search_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Run Alloy background search for the investor Run Alloy background search for the investor

Parameters:

  • id (Integer)
  • investor_id (Integer)
  • run_background_search_request (RunBackgroundSearchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 1162

def run_background_search_with_http_info(id, investor_id, run_background_search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.run_background_search ...'
  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 InvestorApi.run_background_search"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.run_background_search"
  end
  # verify the required parameter 'run_background_search_request' is set
  if @api_client.config.client_side_validation && run_background_search_request.nil?
    fail ArgumentError, "Missing the required parameter 'run_background_search_request' when calling InvestorApi.run_background_search"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}/background_checks/run'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(run_background_search_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"InvestorApi.run_background_search",
    :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: InvestorApi#run_background_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_investor(id, investor_id, deals_id_investors, opts = {}) ⇒ V1EntitiesInvestor

Update a deal investor Update deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:



1228
1229
1230
1231
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 1228

def update_investor(id, investor_id, deals_id_investors, opts = {})
  data, _status_code, _headers = update_investor_with_http_info(id, investor_id, deals_id_investors, opts)
  data
end

#update_investor_with_http_info(id, investor_id, deals_id_investors, opts = {}) ⇒ Array<(V1EntitiesInvestor, Integer, Hash)>

Update a deal investor Update deal investor

Parameters:

  • id (Integer) —

    The deal id.

  • investor_id (Integer) —

    The investor id.

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

    the optional parameters

Returns:

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

    V1EntitiesInvestor data, response status code and response headers



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/DealMakerAPI/api/investor_api.rb', line 1240

def update_investor_with_http_info(id, investor_id, deals_id_investors, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestorApi.update_investor ...'
  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 InvestorApi.update_investor"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.update_investor"
  end
  # verify the required parameter 'deals_id_investors' is set
  if @api_client.config.client_side_validation && deals_id_investors.nil?
    fail ArgumentError, "Missing the required parameter 'deals_id_investors' when calling InvestorApi.update_investor"
  end
  # resource path
  local_var_path = '/deals/{id}/investors/{investor_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_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'])
  # 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(deals_id_investors)

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

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

  new_options = opts.merge(
    :operation => :"InvestorApi.update_investor",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestorApi#update_investor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end