Class: DealMakerAPI::CompanyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompanyApi

Returns a new instance of CompanyApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_bulk_upload(id, create_bulk_upload_request, opts = {}) ⇒ V1EntitiesBulkUpload

Create bulk upload record Create bulk upload record

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 28

def create_bulk_upload(id, create_bulk_upload_request, opts = {})
  data, _status_code, _headers = create_bulk_upload_with_http_info(id, create_bulk_upload_request, opts)
  data
end

#create_bulk_upload_detail(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts = {}) ⇒ V1EntitiesBulkUploadDetail

Create a BulkUploadDetail class record Create a BulkUploadDetail class record

Parameters:

  • bulk_upload_id (String) —

    The Bulk upload ID from which detail is associated with

  • company_id (Integer)
  • create_bulk_upload_detail_request (CreateBulkUploadDetailRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



103
104
105
106
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 103

def create_bulk_upload_detail(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts = {})
  data, _status_code, _headers = create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts)
  data
end

#create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts = {}) ⇒ Array<(V1EntitiesBulkUploadDetail, Integer, Hash)>

Create a BulkUploadDetail class record Create a BulkUploadDetail class record

Parameters:

  • bulk_upload_id (String) —

    The Bulk upload ID from which detail is associated with

  • company_id (Integer)
  • create_bulk_upload_detail_request (CreateBulkUploadDetailRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    V1EntitiesBulkUploadDetail data, response status code and response headers



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 115

def create_bulk_upload_detail_with_http_info(bulk_upload_id, company_id, create_bulk_upload_detail_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.create_bulk_upload_detail ...'
  end
  # verify the required parameter 'bulk_upload_id' is set
  if @api_client.config.client_side_validation && bulk_upload_id.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.create_bulk_upload_detail"
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.create_bulk_upload_detail"
  end
  # verify the required parameter 'create_bulk_upload_detail_request' is set
  if @api_client.config.client_side_validation && create_bulk_upload_detail_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_bulk_upload_detail_request' when calling CompanyApi.create_bulk_upload_detail"
  end
  # resource path
  local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details'.sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_id.to_s)).sub('{' + 'company_id' + '}', CGI.escape(company_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(create_bulk_upload_detail_request)

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

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

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

#create_bulk_upload_with_http_info(id, create_bulk_upload_request, opts = {}) ⇒ Array<(V1EntitiesBulkUpload, Integer, Hash)>

Create bulk upload record Create bulk upload record

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Returns:

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

    V1EntitiesBulkUpload data, response status code and response headers



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
89
90
91
92
93
94
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 39

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

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

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

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

#create_company(create_company_request, opts = {}) ⇒ V1EntitiesCompany

Create new company Creates a new company.

Parameters:

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

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 181

def create_company(create_company_request, opts = {})
  data, _status_code, _headers = create_company_with_http_info(create_company_request, opts)
  data
end

#create_company_with_http_info(create_company_request, opts = {}) ⇒ Array<(V1EntitiesCompany, Integer, Hash)>

Create new company Creates a new company.

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesCompany data, response status code and response headers



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 191

def create_company_with_http_info(create_company_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.create_company ...'
  end
  # verify the required parameter 'create_company_request' is set
  if @api_client.config.client_side_validation && create_company_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_company_request' when calling CompanyApi.create_company"
  end
  # resource path
  local_var_path = '/companies'

  # 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(create_company_request)

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

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

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

#create_email_template(id, create_email_template_request, opts = {}) ⇒ V1EntitiesEmailTemplate

Creates an email template Create new email template

Parameters:

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

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 250

def create_email_template(id, create_email_template_request, opts = {})
  data, _status_code, _headers = create_email_template_with_http_info(id, create_email_template_request, opts)
  data
end

#create_email_template_with_http_info(id, create_email_template_request, opts = {}) ⇒ Array<(V1EntitiesEmailTemplate, Integer, Hash)>

Creates an email template Create new email template

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesEmailTemplate data, response status code and response headers



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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 261

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

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

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

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

#create_members_bulk_upload(id, create_members_bulk_upload_request, opts = {}) ⇒ V1EntitiesMembersBulkUpload

Create bulk upload record Create members bulk upload record

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 324

def create_members_bulk_upload(id, create_members_bulk_upload_request, opts = {})
  data, _status_code, _headers = create_members_bulk_upload_with_http_info(id, create_members_bulk_upload_request, opts)
  data
end

#create_members_bulk_upload_with_http_info(id, create_members_bulk_upload_request, opts = {}) ⇒ Array<(V1EntitiesMembersBulkUpload, Integer, Hash)>

Create bulk upload record Create members bulk upload record

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Returns:

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

    V1EntitiesMembersBulkUpload data, response status code and response headers



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
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 335

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

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

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

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

#create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request, opts = {}) ⇒ V1EntitiesGenericResponse

Create a shareholder action Create a shareholder action

Parameters:

  • company_id (Integer) —

    The company id

  • shareholder_id (Integer) —

    The shareholder id

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

    the optional parameters

Returns:



399
400
401
402
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 399

def create_shareholder_action(company_id, shareholder_id, create_shareholder_action_request, opts = {})
  data, _status_code, _headers = create_shareholder_action_with_http_info(company_id, shareholder_id, create_shareholder_action_request, opts)
  data
end

#create_shareholder_action_with_http_info(company_id, shareholder_id, create_shareholder_action_request, opts = {}) ⇒ Array<(V1EntitiesGenericResponse, Integer, Hash)>

Create a shareholder action Create a shareholder action

Parameters:

  • company_id (Integer) —

    The company id

  • shareholder_id (Integer) —

    The shareholder id

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

    the optional parameters

Returns:

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

    V1EntitiesGenericResponse data, response status code and response headers



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
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
469
470
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 411

def create_shareholder_action_with_http_info(company_id, shareholder_id, create_shareholder_action_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.create_shareholder_action ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.create_shareholder_action"
  end
  # verify the required parameter 'shareholder_id' is set
  if @api_client.config.client_side_validation && shareholder_id.nil?
    fail ArgumentError, "Missing the required parameter 'shareholder_id' when calling CompanyApi.create_shareholder_action"
  end
  # verify the required parameter 'create_shareholder_action_request' is set
  if @api_client.config.client_side_validation && create_shareholder_action_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_shareholder_action_request' when calling CompanyApi.create_shareholder_action"
  end
  # resource path
  local_var_path = '/companies/{company_id}/shareholders/{shareholder_id}/actions'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'shareholder_id' + '}', CGI.escape(shareholder_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(create_shareholder_action_request)

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

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

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

#delete_email_template(id, template_id, opts = {}) ⇒ nil

Deletes an email template Delete an email template

Parameters:

  • id (Integer) —

    The company id

  • template_id (Integer) —

    The email template id

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

    the optional parameters

Returns:

  • (nil) 


478
479
480
481
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 478

def delete_email_template(id, template_id, opts = {})
  delete_email_template_with_http_info(id, template_id, opts)
  nil
end

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

Deletes an email template Delete an email template

Parameters:

  • id (Integer) —

    The company id

  • template_id (Integer) —

    The email template id

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 489

def delete_email_template_with_http_info(id, template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.delete_email_template ...'
  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 CompanyApi.delete_email_template"
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling CompanyApi.delete_email_template"
  end
  # resource path
  local_var_path = '/companies/{id}/news_releases/email_templates/{template_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'template_id' + '}', CGI.escape(template_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 => :"CompanyApi.delete_email_template",
    :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: CompanyApi#delete_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_upload(id, bulk_upload_id, opts = {}) ⇒ V1EntitiesBulkUpload

Return a given bulk upload by id Return a given bulk upload by id

Parameters:

  • id (Integer)
  • bulk_upload_id (Integer)
  • 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:



548
549
550
551
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 548

def get_bulk_upload(id, bulk_upload_id, opts = {})
  data, _status_code, _headers = get_bulk_upload_with_http_info(id, bulk_upload_id, opts)
  data
end

#get_bulk_upload_details_errors(company_id, bulk_upload_id, opts = {}) ⇒ V1EntitiesBulkUploadDetails

Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc Returns a full list of details with errors of the given bulk upload

Parameters:

  • company_id (Integer)
  • bulk_upload_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



623
624
625
626
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 623

def get_bulk_upload_details_errors(company_id, bulk_upload_id, opts = {})
  data, _status_code, _headers = get_bulk_upload_details_errors_with_http_info(company_id, bulk_upload_id, opts)
  data
end

#get_bulk_upload_details_errors_with_http_info(company_id, bulk_upload_id, opts = {}) ⇒ Array<(V1EntitiesBulkUploadDetails, Integer, Hash)>

Returns a full list of details with errors of the given bulk upload ordered by status desc and id asc Returns a full list of details with errors of the given bulk upload

Parameters:

  • company_id (Integer)
  • bulk_upload_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    V1EntitiesBulkUploadDetails data, response status code and response headers



634
635
636
637
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 634

def get_bulk_upload_details_errors_with_http_info(company_id, bulk_upload_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_bulk_upload_details_errors ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_bulk_upload_details_errors"
  end
  # verify the required parameter 'bulk_upload_id' is set
  if @api_client.config.client_side_validation && bulk_upload_id.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.get_bulk_upload_details_errors"
  end
  # resource path
  local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/errors'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_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] || 'V1EntitiesBulkUploadDetails'

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

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

#get_bulk_upload_with_http_info(id, bulk_upload_id, opts = {}) ⇒ Array<(V1EntitiesBulkUpload, Integer, Hash)>

Return a given bulk upload by id Return a given bulk upload by id

Parameters:

  • id (Integer)
  • bulk_upload_id (Integer)
  • 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<(V1EntitiesBulkUpload, Integer, Hash)>) —

    V1EntitiesBulkUpload data, response status code and response headers



562
563
564
565
566
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 562

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

  # 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] || 'V1EntitiesBulkUpload'

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

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

#get_bulk_uploads(id, opts = {}) ⇒ V1EntitiesBulkUploads

Return bulk uploads Return bulk uploads

Parameters:

  • id (Integer)
  • 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:



694
695
696
697
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 694

def get_bulk_uploads(id, opts = {})
  data, _status_code, _headers = get_bulk_uploads_with_http_info(id, opts)
  data
end

#get_bulk_uploads_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesBulkUploads, Integer, Hash)>

Return bulk uploads Return bulk uploads

Parameters:

  • id (Integer)
  • 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<(V1EntitiesBulkUploads, Integer, Hash)>) —

    V1EntitiesBulkUploads data, response status code and response headers



707
708
709
710
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 707

def get_bulk_uploads_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_bulk_uploads ...'
  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 CompanyApi.get_bulk_uploads"
  end
  # resource path
  local_var_path = '/companies/{id}/documents/bulk_uploads'.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?

  # 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] || 'V1EntitiesBulkUploads'

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

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

#get_companies(opts = {}) ⇒ V1EntitiesCompany

Get list of Companies Get companies

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:



765
766
767
768
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 765

def get_companies(opts = {})
  data, _status_code, _headers = get_companies_with_http_info(opts)
  data
end

#get_companies_with_http_info(opts = {}) ⇒ Array<(V1EntitiesCompany, Integer, Hash)>

Get list of Companies Get companies

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<(V1EntitiesCompany, Integer, Hash)>) —

    V1EntitiesCompany data, response status code and response headers



777
778
779
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 777

def get_companies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_companies ...'
  end
  # resource path
  local_var_path = '/companies'

  # 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] || 'V1EntitiesCompany'

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

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

#get_company(id, opts = {}) ⇒ V1EntitiesCompany

Get a Company Get a Company.

Parameters:

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

    the optional parameters

Returns:



829
830
831
832
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 829

def get_company(id, opts = {})
  data, _status_code, _headers = get_company_with_http_info(id, opts)
  data
end

#get_company_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesCompany, Integer, Hash)>

Get a Company Get a Company.

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesCompany data, response status code and response headers



839
840
841
842
843
844
845
846
847
848
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 839

def get_company_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_company ...'
  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 CompanyApi.get_company"
  end
  # resource path
  local_var_path = '/companies/{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] || 'V1EntitiesCompany'

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

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

#get_details_errors_grouped(company_id, bulk_upload_id, opts = {}) ⇒ V1EntitiesBulkUploadDetails

Return bulk upload details grouped by status Return bulk upload details grouped by status

Parameters:

  • company_id (Integer)
  • bulk_upload_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



893
894
895
896
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 893

def get_details_errors_grouped(company_id, bulk_upload_id, opts = {})
  data, _status_code, _headers = get_details_errors_grouped_with_http_info(company_id, bulk_upload_id, opts)
  data
end

#get_details_errors_grouped_with_http_info(company_id, bulk_upload_id, opts = {}) ⇒ Array<(V1EntitiesBulkUploadDetails, Integer, Hash)>

Return bulk upload details grouped by status Return bulk upload details grouped by status

Parameters:

  • company_id (Integer)
  • bulk_upload_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    V1EntitiesBulkUploadDetails data, response status code and response headers



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
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 904

def get_details_errors_grouped_with_http_info(company_id, bulk_upload_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_details_errors_grouped ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_details_errors_grouped"
  end
  # verify the required parameter 'bulk_upload_id' is set
  if @api_client.config.client_side_validation && bulk_upload_id.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.get_details_errors_grouped"
  end
  # resource path
  local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_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] || 'V1EntitiesBulkUploadDetails'

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

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

#get_dividends(company_id, opts = {}) ⇒ V1EntitiesDividends

Return dividends Return dividends associated with a shareholder

Parameters:

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

    the optional parameters

Returns:



961
962
963
964
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 961

def get_dividends(company_id, opts = {})
  data, _status_code, _headers = get_dividends_with_http_info(company_id, opts)
  data
end

#get_dividends_with_http_info(company_id, opts = {}) ⇒ Array<(V1EntitiesDividends, Integer, Hash)>

Return dividends Return dividends associated with a shareholder

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesDividends data, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 971

def get_dividends_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_dividends ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_dividends"
  end
  # resource path
  local_var_path = '/companies/{company_id}/portal/dividends'.sub('{' + 'company_id' + '}', CGI.escape(company_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] || 'V1EntitiesDividends'

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

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

#get_email_events(company_communication_id, opts = {}) ⇒ V1EntitiesEmailEvents

Get a list of email events for a company communication Gets a list of email events for a specific company communication.

Parameters:

  • company_communication_id (Integer) —

    The id of the company communication.

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

    the optional parameters

Returns:



1024
1025
1026
1027
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1024

def get_email_events(company_communication_id, opts = {})
  data, _status_code, _headers = get_email_events_with_http_info(company_communication_id, opts)
  data
end

#get_email_events_with_http_info(company_communication_id, opts = {}) ⇒ Array<(V1EntitiesEmailEvents, Integer, Hash)>

Get a list of email events for a company communication Gets a list of email events for a specific company communication.

Parameters:

  • company_communication_id (Integer) —

    The id of the company communication.

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

    the optional parameters

Returns:

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

    V1EntitiesEmailEvents data, response status code and response headers



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1034

def get_email_events_with_http_info(company_communication_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_email_events ...'
  end
  # verify the required parameter 'company_communication_id' is set
  if @api_client.config.client_side_validation && company_communication_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_communication_id' when calling CompanyApi.get_email_events"
  end
  # resource path
  local_var_path = '/companies/{company_communication_id}/email_events'.sub('{' + 'company_communication_id' + '}', CGI.escape(company_communication_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] || 'V1EntitiesEmailEvents'

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

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

#get_email_template(id, template_id, opts = {}) ⇒ V1EntitiesEmailTemplate

Get an email template Get an email template

Parameters:

  • id (Integer) —

    The company id

  • template_id (Integer) —

    The email template id

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

    the optional parameters

Returns:



1088
1089
1090
1091
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1088

def get_email_template(id, template_id, opts = {})
  data, _status_code, _headers = get_email_template_with_http_info(id, template_id, opts)
  data
end

#get_email_template_with_http_info(id, template_id, opts = {}) ⇒ Array<(V1EntitiesEmailTemplate, Integer, Hash)>

Get an email template Get an email template

Parameters:

  • id (Integer) —

    The company id

  • template_id (Integer) —

    The email template id

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

    the optional parameters

Returns:

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

    V1EntitiesEmailTemplate data, response status code and response headers



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
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1099

def get_email_template_with_http_info(id, template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_email_template ...'
  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 CompanyApi.get_email_template"
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling CompanyApi.get_email_template"
  end
  # resource path
  local_var_path = '/companies/{id}/news_releases/email_templates/{template_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'template_id' + '}', CGI.escape(template_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] || 'V1EntitiesEmailTemplate'

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

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

#get_email_templates(id, opts = {}) ⇒ V1EntitiesEmailTemplate

Get list of email template Get list of email template

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number (default to 0)

  • :per_page (Integer) —

    The number of items per page (default to 10)

  • :public_template (Boolean) —

    The public template (default to false)

Returns:



1159
1160
1161
1162
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1159

def get_email_templates(id, opts = {})
  data, _status_code, _headers = get_email_templates_with_http_info(id, opts)
  data
end

#get_email_templates_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesEmailTemplate, Integer, Hash)>

Get list of email template Get list of email template

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number (default to 0)

  • :per_page (Integer) —

    The number of items per page (default to 10)

  • :public_template (Boolean) —

    The public template (default to false)

Returns:

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

    V1EntitiesEmailTemplate data, response status code and response headers



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
1220
1221
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1172

def get_email_templates_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_email_templates ...'
  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 CompanyApi.get_email_templates"
  end
  # resource path
  local_var_path = '/companies/{id}/news_releases/email_templates'.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[:'public_template'] = opts[:'public_template'] if !opts[:'public_template'].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] || 'V1EntitiesEmailTemplate'

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

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

#get_members_bulk_upload(id, id_members_bulk_upload, opts = {}) ⇒ V1EntitiesMembersBulkUpload

Get bulk upload record Get members bulk upload record

Parameters:

  • id (Integer) —

    The company id

  • id_members_bulk_upload (Integer) —

    The bulk upload id

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

    the optional parameters

Returns:



1229
1230
1231
1232
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1229

def get_members_bulk_upload(id, id_members_bulk_upload, opts = {})
  data, _status_code, _headers = get_members_bulk_upload_with_http_info(id, id_members_bulk_upload, opts)
  data
end

#get_members_bulk_upload_with_http_info(id, id_members_bulk_upload, opts = {}) ⇒ Array<(V1EntitiesMembersBulkUpload, Integer, Hash)>

Get bulk upload record Get members bulk upload record

Parameters:

  • id (Integer) —

    The company id

  • id_members_bulk_upload (Integer) —

    The bulk upload id

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

    the optional parameters

Returns:

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

    V1EntitiesMembersBulkUpload 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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1240

def get_members_bulk_upload_with_http_info(id, id_members_bulk_upload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_members_bulk_upload ...'
  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 CompanyApi.get_members_bulk_upload"
  end
  # verify the required parameter 'id_members_bulk_upload' is set
  if @api_client.config.client_side_validation && id_members_bulk_upload.nil?
    fail ArgumentError, "Missing the required parameter 'id_members_bulk_upload' when calling CompanyApi.get_members_bulk_upload"
  end
  # resource path
  local_var_path = '/companies/{id}/members/bulk_uploads/{id_members_bulk_upload}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'id_members_bulk_upload' + '}', CGI.escape(id_members_bulk_upload.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] || 'V1EntitiesMembersBulkUpload'

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

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

#get_members_bulk_uploads(id, opts = {}) ⇒ V1EntitiesMembersBulkUploads

Get bulk uploads records Get members bulk uploads records

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Returns:



1297
1298
1299
1300
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1297

def get_members_bulk_uploads(id, opts = {})
  data, _status_code, _headers = get_members_bulk_uploads_with_http_info(id, opts)
  data
end

#get_members_bulk_uploads_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesMembersBulkUploads, Integer, Hash)>

Get bulk uploads records Get members bulk uploads records

Parameters:

  • id (Integer) —

    The company id

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

    the optional parameters

Returns:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1307

def get_members_bulk_uploads_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_members_bulk_uploads ...'
  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 CompanyApi.get_members_bulk_uploads"
  end
  # resource path
  local_var_path = '/companies/{id}/members/bulk_uploads'.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] || 'V1EntitiesMembersBulkUploads'

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

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

#get_shareholder_ledger(id, opts = {}) ⇒ V1EntitiesShareholderLedger

Get shareholder ledger by company Get shareholder ledger by company.

Parameters:

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

    the optional parameters

Returns:



1360
1361
1362
1363
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1360

def get_shareholder_ledger(id, opts = {})
  data, _status_code, _headers = get_shareholder_ledger_with_http_info(id, opts)
  data
end

#get_shareholder_ledger_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesShareholderLedger, Integer, Hash)>

Get shareholder ledger by company Get shareholder ledger by company.

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesShareholderLedger data, response status code and response headers



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1370

def get_shareholder_ledger_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_shareholder_ledger ...'
  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 CompanyApi.get_shareholder_ledger"
  end
  # resource path
  local_var_path = '/companies/{id}/shareholder_ledger'.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] || 'V1EntitiesShareholderLedger'

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

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

#get_user_accessible_companies(opts = {}) ⇒ V1EntitiesCompany

Get list of all Companies accessible by the user Get user accessible companies

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:



1425
1426
1427
1428
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1425

def get_user_accessible_companies(opts = {})
  data, _status_code, _headers = get_user_accessible_companies_with_http_info(opts)
  data
end

#get_user_accessible_companies_with_http_info(opts = {}) ⇒ Array<(V1EntitiesCompany, Integer, Hash)>

Get list of all Companies accessible by the user Get user accessible companies

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<(V1EntitiesCompany, Integer, Hash)>) —

    V1EntitiesCompany data, response status code and response headers



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1437

def get_user_accessible_companies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_user_accessible_companies ...'
  end
  # resource path
  local_var_path = '/users/accessible_companies'

  # 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] || 'V1EntitiesCompany'

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

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

#send_portal_invite(id, shareholder_id, opts = {}) ⇒ nil

Send portal invite to shareholder Send portal invite to shareholder.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1491
1492
1493
1494
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1491

def send_portal_invite(id, shareholder_id, opts = {})
  send_portal_invite_with_http_info(id, shareholder_id, opts)
  nil
end

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

Send portal invite to shareholder Send portal invite to shareholder.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1503

def send_portal_invite_with_http_info(id, shareholder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.send_portal_invite ...'
  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 CompanyApi.send_portal_invite"
  end
  # verify the required parameter 'shareholder_id' is set
  if @api_client.config.client_side_validation && shareholder_id.nil?
    fail ArgumentError, "Missing the required parameter 'shareholder_id' when calling CompanyApi.send_portal_invite"
  end
  # resource path
  local_var_path = '/companies/{id}/shareholders/{shareholder_id}/send_portal_invite'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'shareholder_id' + '}', CGI.escape(shareholder_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(opts[:'send_portal_invite_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#test_document_upload_email(id, test_document_upload_email_request, opts = {}) ⇒ nil

Send document upload test email to given user Send document upload test email to given user

Parameters:

Returns:

  • (nil) 


1564
1565
1566
1567
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1564

def test_document_upload_email(id, test_document_upload_email_request, opts = {})
  test_document_upload_email_with_http_info(id, test_document_upload_email_request, opts)
  nil
end

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

Send document upload test email to given user Send document upload test email to given user

Parameters:

Returns:

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

    nil, response status code and response headers



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 1575

def test_document_upload_email_with_http_info(id, test_document_upload_email_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.test_document_upload_email ...'
  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 CompanyApi.test_document_upload_email"
  end
  # verify the required parameter 'test_document_upload_email_request' is set
  if @api_client.config.client_side_validation && test_document_upload_email_request.nil?
    fail ArgumentError, "Missing the required parameter 'test_document_upload_email_request' when calling CompanyApi.test_document_upload_email"
  end
  # resource path
  local_var_path = '/companies/{id}/documents/test_upload_email'.sub('{' + 'id' + '}', CGI.escape(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(test_document_upload_email_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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