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'])
  # 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'])
  # 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'])
  # 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_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:



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

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



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
317
318
319
320
321
322
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 263

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

#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:



333
334
335
336
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 333

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:



408
409
410
411
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 408

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



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

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'])

  # 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



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
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 347

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'])

  # 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:



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

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



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

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'])

  # 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:



550
551
552
553
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 550

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



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

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'])

  # 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:



614
615
616
617
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 614

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



624
625
626
627
628
629
630
631
632
633
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 624

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'])

  # 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:



678
679
680
681
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 678

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



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
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
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 689

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'])

  # 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:



746
747
748
749
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 746

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



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 756

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'])

  # 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