Class: Pier::ContaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pier-sdk-ruby/api/conta_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContaApi

Returns a new instance of ContaApi.



23
24
25
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#buscar_conta_using_get(opts = {}) ⇒ ConsultarContaResponse

/contas/buscar Consulte contas filtrando pelos campos id do emissor, nu00C3u00BAmero do cartu00C3u00A3o, nome ou CPF/CNPJ

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :nome (String) —

    Nome

  • :cpf (String) —

    CPF (opcional caso nao informe o nu00C3u00BAmero do cartu00C3u00A3o ou id da conta)

  • :numero_cartao (String) —

    Nu00C3u00BAmero do cartu00C3u00A3o (opcional caso nu00C3u00A3o informa o cpf ou id da conta)

  • :id_conta (Integer) —

    ID da Conta (opcional caso nu00C3u00A3o informe o nu00C3u00BAmero do cartu00C3u00A3o ou cpf)

Returns:



35
36
37
38
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 35

def buscar_conta_using_get(opts = {})
  data, _status_code, _headers = buscar_conta_using_get_with_http_info(opts)
  return data
end

#buscar_conta_using_get_with_http_info(opts = {}) ⇒ Array<(ConsultarContaResponse, Fixnum, Hash)>

/contas/buscar Consulte contas filtrando pelos campos id do emissor, nu00C3u00BAmero do cartu00C3u00A3o, nome ou CPF/CNPJ

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :nome (String) —

    Nome

  • :cpf (String) —

    CPF (opcional caso nao informe o nu00C3u00BAmero do cartu00C3u00A3o ou id da conta)

  • :numero_cartao (String) —

    Nu00C3u00BAmero do cartu00C3u00A3o (opcional caso nu00C3u00A3o informa o cpf ou id da conta)

  • :id_conta (Integer) —

    ID da Conta (opcional caso nu00C3u00A3o informe o nu00C3u00BAmero do cartu00C3u00A3o ou cpf)

Returns:

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

    ConsultarContaResponse data, response status code and response headers



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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 48

def buscar_conta_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContaApi.buscar_conta_using_get ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/buscar".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'nome'] = opts[:'nome'] if opts[:'nome']
  query_params[:'cpf'] = opts[:'cpf'] if opts[:'cpf']
  query_params[:'numeroCartao'] = opts[:'numero_cartao'] if opts[:'numero_cartao']
  query_params[:'idConta'] = opts[:'id_conta'] if opts[:'id_conta']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['access_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConsultarContaResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContaApi#buscar_conta_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_conta_using_get(id_conta, opts = {}) ⇒ ContaResponse

/contas/idConta Consulte informau00C3u00A7u00C3u00B5es de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

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

    the optional parameters

Returns:



123
124
125
126
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 123

def consultar_conta_using_get(id_conta, opts = {})
  data, _status_code, _headers = consultar_conta_using_get_with_http_info(id_conta, opts)
  return data
end

#consultar_conta_using_get_with_http_info(id_conta, opts = {}) ⇒ Array<(ContaResponse, Fixnum, Hash)>

/contas/idConta Consulte informau00C3u00A7u00C3u00B5es de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

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

    the optional parameters

Returns:

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

    ContaResponse data, response status code and response headers



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
175
176
177
178
179
180
181
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 133

def consultar_conta_using_get_with_http_info(id_conta, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContaApi.consultar_conta_using_get ..."
  end
  
  
  # verify the required parameter 'id_conta' is set
  fail ArgumentError, "Missing the required parameter 'id_conta' when calling ContaApi.consultar_conta_using_get" if id_conta.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/{idConta}".sub('{format}','json').sub('{' + 'idConta' + '}', id_conta.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['access_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContaResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContaApi#consultar_conta_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_extrato_faturas_using_get(id_conta, data_vencimento, opts = {}) ⇒ ConsultarExtratoContaResponse

/contas/idConta/faturas Consulte os extratos/faturas de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

  • data_vencimento —

    Data limite para o vencimento das transau00C3u00A7u00C3u00B5es

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 189

def consultar_extrato_faturas_using_get(id_conta, data_vencimento, opts = {})
  data, _status_code, _headers = consultar_extrato_faturas_using_get_with_http_info(id_conta, data_vencimento, opts)
  return data
end

#consultar_extrato_faturas_using_get_with_http_info(id_conta, data_vencimento, opts = {}) ⇒ Array<(ConsultarExtratoContaResponse, Fixnum, Hash)>

/contas/idConta/faturas Consulte os extratos/faturas de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

  • data_vencimento —

    Data limite para o vencimento das transau00C3u00A7u00C3u00B5es

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

    the optional parameters

Returns:



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
254
255
256
257
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 200

def consultar_extrato_faturas_using_get_with_http_info(id_conta, data_vencimento, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContaApi.consultar_extrato_faturas_using_get ..."
  end
  
  
  # verify the required parameter 'id_conta' is set
  fail ArgumentError, "Missing the required parameter 'id_conta' when calling ContaApi.consultar_extrato_faturas_using_get" if id_conta.nil?
  
  
  
  
  
  
  # verify the required parameter 'data_vencimento' is set
  fail ArgumentError, "Missing the required parameter 'data_vencimento' when calling ContaApi.consultar_extrato_faturas_using_get" if data_vencimento.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/{idConta}/faturas".sub('{format}','json').sub('{' + 'idConta' + '}', id_conta.to_s)

  # query parameters
  query_params = {}
  query_params[:'dataVencimento'] = data_vencimento

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['access_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConsultarExtratoContaResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContaApi#consultar_extrato_faturas_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_saldos_limites_using_get(id_conta, opts = {}) ⇒ ConsultarSaldoLimitesResponse

/contas/idConta/limites Consulte os limites de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/pier-sdk-ruby/api/conta_api.rb', line 264

def consultar_saldos_limites_using_get(id_conta, opts = {})
  data, _status_code, _headers = consultar_saldos_limites_using_get_with_http_info(id_conta, opts)
  return data
end

#consultar_saldos_limites_using_get_with_http_info(id_conta, opts = {}) ⇒ Array<(ConsultarSaldoLimitesResponse, Fixnum, Hash)>

/contas/idConta/limites Consulte os limites de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

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

    the optional parameters

Returns:



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/pier-sdk-ruby/api/conta_api.rb', line 274

def consultar_saldos_limites_using_get_with_http_info(id_conta, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContaApi.consultar_saldos_limites_using_get ..."
  end
  
  
  # verify the required parameter 'id_conta' is set
  fail ArgumentError, "Missing the required parameter 'id_conta' when calling ContaApi.consultar_saldos_limites_using_get" if id_conta.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/{idConta}/limites".sub('{format}','json').sub('{' + 'idConta' + '}', id_conta.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['access_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConsultarSaldoLimitesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContaApi#consultar_saldos_limites_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end