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

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



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

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



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

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:



315
316
317
318
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 315

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/DealMakerAPI/api/company_api.rb', line 325

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