Class: Wire4Client::OperacionesCoDiApi

Inherits:
Object
  • Object
show all
Defined in:
lib/wire4_client/api/operaciones_co_di_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OperacionesCoDiApi

Returns a new instance of OperacionesCoDiApi.



19
20
21
 
# File 'lib/wire4_client/api/operaciones_co_di_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/wire4_client/api/operaciones_co_di_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#consult_codi_operations(authorization, opts = {}) ⇒ PagerResponseDto

Consulta de operaciones Obtiene las operaciones generadas a partir de peticiones de pago CODI® de forma paginada, pudiendo aplicar filtros.

Parameters:

  • authorization —

    Header para token

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

    the optional parameters

Options Hash (opts):

  • :company_id (String) —

    Es el identificador de empresa CODI®.

  • :page (String) —

    Es el número de pago. (default to 0)

  • :request_filters (CodiOperationsFiltersRequestDTO) —

    Filtros de busqueda

  • :sales_point_id (String) —

    Es el identificador del punto de venta.

  • :size (String) —

    Es el tamaño de página. (default to 20)

Returns:



32
33
34
35
 
# File 'lib/wire4_client/api/operaciones_co_di_api.rb', line 32

def consult_codi_operations(authorization, opts = {})
  data, _status_code, _headers = consult_codi_operations_with_http_info(authorization, opts)
  data
end

#consult_codi_operations_with_http_info(authorization, opts = {}) ⇒ Array<(PagerResponseDto, Fixnum, Hash)>

Consulta de operaciones Obtiene las operaciones generadas a partir de peticiones de pago CODI® de forma paginada, pudiendo aplicar filtros.

Parameters:

  • authorization —

    Header para token

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

    the optional parameters

Options Hash (opts):

  • :company_id (String) —

    Es el identificador de empresa CODI®.

  • :page (String) —

    Es el número de pago.

  • :request_filters (CodiOperationsFiltersRequestDTO) —

    Filtros de busqueda

  • :sales_point_id (String) —

    Es el identificador del punto de venta.

  • :size (String) —

    Es el tamaño de página.

Returns:

  • (Array<(PagerResponseDto, Fixnum, Hash)>) —

    PagerResponseDto data, response status code and response headers



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
 
# File 'lib/wire4_client/api/operaciones_co_di_api.rb', line 47

def consult_codi_operations_with_http_info(authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperacionesCoDiApi.consult_codi_operations ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling OperacionesCoDiApi.consult_codi_operations"
  end
  # resource path
  local_var_path = '/codi/charges'

  # query parameters
  query_params = {}
  query_params[:'company_id'] = opts[:'company_id'] if !opts[:'company_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'sales_point_id'] = opts[:'sales_point_id'] if !opts[:'sales_point_id'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'request_filters'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PagerResponseDto')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OperacionesCoDiApi#consult_codi_operations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end