Class: EcfDgii::Generated::RecepcionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ecf_dgii/generated/api/recepcion_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecepcionApi

Returns a new instance of RecepcionApi.



19
20
21
 
# File 'lib/ecf_dgii/generated/api/recepcion_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/recepcion_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_ecf_reception_request(message_id, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def get_ecf_reception_request(message_id, opts = {})
  get_ecf_reception_request_with_http_info(message_id, opts)
  nil
end

#get_ecf_reception_request_with_http_info(message_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • message_id (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/recepcion_api.rb', line 33

def get_ecf_reception_request_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecepcionApi.get_ecf_reception_request ...'
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling RecepcionApi.get_ecf_reception_request"
  end
  # resource path
  local_var_path = '/recepcion/{messageId}'.sub('{messageId}', CGI.escape(message_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/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 => :"RecepcionApi.get_ecf_reception_request",
    :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: RecepcionApi#get_ecf_reception_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ecf_receptor_by_message_id(rnc, message_id, opts = {}) ⇒ EcfReceptorDto

Parameters:

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

    the optional parameters

Returns:



85
86
87
88
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 85

def get_ecf_receptor_by_message_id(rnc, message_id, opts = {})
  data, _status_code, _headers = get_ecf_receptor_by_message_id_with_http_info(rnc, message_id, opts)
  data
end

#get_ecf_receptor_by_message_id_with_http_info(rnc, message_id, opts = {}) ⇒ Array<(EcfReceptorDto, Integer, Hash)>

Returns EcfReceptorDto data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    EcfReceptorDto data, response status code and response headers



94
95
96
97
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
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 94

def get_ecf_receptor_by_message_id_with_http_info(rnc, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecepcionApi.get_ecf_receptor_by_message_id ...'
  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 RecepcionApi.get_ecf_receptor_by_message_id"
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling RecepcionApi.get_ecf_receptor_by_message_id"
  end
  # resource path
  local_var_path = '/recepcion/{rnc}/{messageId}'.sub('{rnc}', CGI.escape(rnc.to_s)).sub('{messageId}', CGI.escape(message_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', '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] || 'EcfReceptorDto'

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

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

#search_ecf_reception_requests(opts = {}) ⇒ PaginatedApiResultOfEcfReceptionRequestDto

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



160
161
162
163
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 160

def search_ecf_reception_requests(opts = {})
  data, _status_code, _headers = search_ecf_reception_requests_with_http_info(opts)
  data
end

#search_ecf_reception_requests_by_rnc(rnc, opts = {}) ⇒ PaginatedApiResultOfEcfReceptionRequestDto

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



269
270
271
272
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 269

def search_ecf_reception_requests_by_rnc(rnc, opts = {})
  data, _status_code, _headers = search_ecf_reception_requests_by_rnc_with_http_info(rnc, opts)
  data
end

#search_ecf_reception_requests_by_rnc_with_http_info(rnc, opts = {}) ⇒ Array<(PaginatedApiResultOfEcfReceptionRequestDto, Integer, Hash)>

Returns PaginatedApiResultOfEcfReceptionRequestDto data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
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
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 288

def search_ecf_reception_requests_by_rnc_with_http_info(rnc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecepcionApi.search_ecf_reception_requests_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 RecepcionApi.search_ecf_reception_requests_by_rnc"
  end
  pattern = Regexp.new(/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/)
  if @api_client.config.client_side_validation && !opts[:'amount_from'].nil? && opts[:'amount_from'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"amount_from\"]' when calling RecepcionApi.search_ecf_reception_requests_by_rnc, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/)
  if @api_client.config.client_side_validation && !opts[:'amount_to'].nil? && opts[:'amount_to'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"amount_to\"]' when calling RecepcionApi.search_ecf_reception_requests_by_rnc, must conform to the pattern #{pattern}."
  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 RecepcionApi.search_ecf_reception_requests_by_rnc, 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 RecepcionApi.search_ecf_reception_requests_by_rnc, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/recepcion/{rnc}'.sub('{rnc}', CGI.escape(rnc.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'MessageIds'] = @api_client.build_collection_param(opts[:'message_ids'], :multi) if !opts[:'message_ids'].nil?
  query_params[:'Encfs'] = @api_client.build_collection_param(opts[:'encfs'], :multi) if !opts[:'encfs'].nil?
  query_params[:'RncEmisors'] = @api_client.build_collection_param(opts[:'rnc_emisors'], :multi) if !opts[:'rnc_emisors'].nil?
  query_params[:'TiposEcfs'] = @api_client.build_collection_param(opts[:'tipos_ecfs'], :multi) if !opts[:'tipos_ecfs'].nil?
  query_params[:'Progresses'] = @api_client.build_collection_param(opts[:'progresses'], :multi) if !opts[:'progresses'].nil?
  query_params[:'FromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'ToDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'AmountFrom'] = opts[:'amount_from'] if !opts[:'amount_from'].nil?
  query_params[:'AmountTo'] = opts[:'amount_to'] if !opts[:'amount_to'].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] || 'PaginatedApiResultOfEcfReceptionRequestDto'

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

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

#search_ecf_reception_requests_with_http_info(opts = {}) ⇒ Array<(PaginatedApiResultOfEcfReceptionRequestDto, Integer, Hash)>

Returns PaginatedApiResultOfEcfReceptionRequestDto data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 179

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

  pattern = Regexp.new(/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/)
  if @api_client.config.client_side_validation && !opts[:'amount_to'].nil? && opts[:'amount_to'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"amount_to\"]' when calling RecepcionApi.search_ecf_reception_requests, must conform to the pattern #{pattern}."
  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 RecepcionApi.search_ecf_reception_requests, 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 RecepcionApi.search_ecf_reception_requests, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/recepcion'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'MessageIds'] = @api_client.build_collection_param(opts[:'message_ids'], :multi) if !opts[:'message_ids'].nil?
  query_params[:'Encfs'] = @api_client.build_collection_param(opts[:'encfs'], :multi) if !opts[:'encfs'].nil?
  query_params[:'Rncs'] = @api_client.build_collection_param(opts[:'rncs'], :multi) if !opts[:'rncs'].nil?
  query_params[:'RncEmisors'] = @api_client.build_collection_param(opts[:'rnc_emisors'], :multi) if !opts[:'rnc_emisors'].nil?
  query_params[:'TiposEcfs'] = @api_client.build_collection_param(opts[:'tipos_ecfs'], :multi) if !opts[:'tipos_ecfs'].nil?
  query_params[:'Progresses'] = @api_client.build_collection_param(opts[:'progresses'], :multi) if !opts[:'progresses'].nil?
  query_params[:'FromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'ToDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'AmountFrom'] = opts[:'amount_from'] if !opts[:'amount_from'].nil?
  query_params[:'AmountTo'] = opts[:'amount_to'] if !opts[:'amount_to'].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] || 'PaginatedApiResultOfEcfReceptionRequestDto'

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

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

#send_aprobacion_comercial(message_id, send_acecf_request, opts = {}) ⇒ nil

Parameters:

  • message_id (String)
  • send_acecf_request (SendAcecfRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


371
372
373
374
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 371

def send_aprobacion_comercial(message_id, send_acecf_request, opts = {})
  send_aprobacion_comercial_with_http_info(message_id, send_acecf_request, opts)
  nil
end

#send_aprobacion_comercial_with_http_info(message_id, send_acecf_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • message_id (String)
  • send_acecf_request (SendAcecfRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/ecf_dgii/generated/api/recepcion_api.rb', line 380

def send_aprobacion_comercial_with_http_info(message_id, send_acecf_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecepcionApi.send_aprobacion_comercial ...'
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling RecepcionApi.send_aprobacion_comercial"
  end
  # verify the required parameter 'send_acecf_request' is set
  if @api_client.config.client_side_validation && send_acecf_request.nil?
    fail ArgumentError, "Missing the required parameter 'send_acecf_request' when calling RecepcionApi.send_aprobacion_comercial"
  end
  # resource path
  local_var_path = '/recepcion/{messageId}/acecf'.sub('{messageId}', CGI.escape(message_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/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(send_acecf_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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