Class: EcfDgii::Generated::CompanyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ecf_dgii/generated/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/ecf_dgii/generated/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/ecf_dgii/generated/api/company_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_company(rnc, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


25
26
27
28
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 25

def delete_company(rnc, opts = {})
  delete_company_with_http_info(rnc, opts)
  nil
end

#delete_company_with_http_info(rnc, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 33

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

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

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

#get_companies(opts = {}) ⇒ PaginatedApiResultOfCompanyResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



87
88
89
90
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 87

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

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

Returns PaginatedApiResultOfCompanyResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def get_companies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_companies ...'
  end
  pattern = Regexp.new(/^-?(?:0|[1-9]\d*)$/)
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"page\"]' when calling CompanyApi.get_companies, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^-?(?:0|[1-9]\d*)$/)
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling CompanyApi.get_companies, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/company'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Rncs'] = @api_client.build_collection_param(opts[:'rncs'], :multi) if !opts[:'rncs'].nil?
  query_params[:'Names'] = @api_client.build_collection_param(opts[:'names'], :multi) if !opts[:'names'].nil?
  query_params[:'Page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'Limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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] || 'PaginatedApiResultOfCompanyResponse'

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

  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_by_rnc(rnc, opts = {}) ⇒ CompanyResponse

Parameters:

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

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 159

def get_company_by_rnc(rnc, opts = {})
  data, _status_code, _headers = get_company_by_rnc_with_http_info(rnc, opts)
  data
end

#get_company_by_rnc_with_http_info(rnc, opts = {}) ⇒ Array<(CompanyResponse, Integer, Hash)>

Returns CompanyResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    CompanyResponse data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 167

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

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

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

#get_current_certificate(rnc, opts = {}) ⇒ Array<CertificateResponse>

Parameters:

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

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 218

def get_current_certificate(rnc, opts = {})
  data, _status_code, _headers = get_current_certificate_with_http_info(rnc, opts)
  data
end

#get_current_certificate_with_http_info(rnc, opts = {}) ⇒ Array<(Array<CertificateResponse>, Integer, Hash)>

Returns Array<CertificateResponse> data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    Array<CertificateResponse> data, response status code and response headers



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 226

def get_current_certificate_with_http_info(rnc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.get_current_certificate ...'
  end
  # verify the required parameter 'rnc' is set
  if @api_client.config.client_side_validation && rnc.nil?
    fail ArgumentError, "Missing the required parameter 'rnc' when calling CompanyApi.get_current_certificate"
  end
  # resource path
  local_var_path = '/company/{rnc}/certificate'.sub('{rnc}', CGI.escape(rnc.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', 'application/problem+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] || 'Array<CertificateResponse>'

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

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

#update_certificate_company(rnc, certificate, password, opts = {}) ⇒ nil

Parameters:

  • rnc (String)
  • certificate (File)
  • password (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


279
280
281
282
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 279

def update_certificate_company(rnc, certificate, password, opts = {})
  update_certificate_company_with_http_info(rnc, certificate, password, opts)
  nil
end

#update_certificate_company_with_http_info(rnc, certificate, password, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • rnc (String)
  • certificate (File)
  • password (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 289

def update_certificate_company_with_http_info(rnc, certificate, password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.update_certificate_company ...'
  end
  # verify the required parameter 'rnc' is set
  if @api_client.config.client_side_validation && rnc.nil?
    fail ArgumentError, "Missing the required parameter 'rnc' when calling CompanyApi.update_certificate_company"
  end
  # verify the required parameter 'certificate' is set
  if @api_client.config.client_side_validation && certificate.nil?
    fail ArgumentError, "Missing the required parameter 'certificate' when calling CompanyApi.update_certificate_company"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling CompanyApi.update_certificate_company"
  end
  # resource path
  local_var_path = '/company/{rnc}/certificate'.sub('{rnc}', CGI.escape(rnc.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/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#upsert_company(upsert_company_request, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


355
356
357
358
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 355

def upsert_company(upsert_company_request, opts = {})
  upsert_company_with_http_info(upsert_company_request, opts)
  nil
end

#upsert_company_with_http_info(upsert_company_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/ecf_dgii/generated/api/company_api.rb', line 363

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

  # 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/problem+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(upsert_company_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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