Class: Pier::CartaoApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CartaoApi

Returns a new instance of CartaoApi.



23
24
25
 
# File 'lib/pier-sdk-ruby/api/cartao_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/cartao_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#bloquear_cartao_using_post(id_conta, id_cartao, motivo, opts = {}) ⇒ CancelarCartaoResponse

/contas/idConta/cartoes/idCartao/bloquear Bloquear um determinado cartu00C3u00A3o

Parameters:

  • id_conta —

    ID da Conta

  • id_cartao —

    ID do Cartu00C3u00A3o que deseja cancelar

  • motivo —

    Motivo do bloqueio

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

    the optional parameters

Options Hash (opts):

  • :observacao (String) —

    Alguma observau00C3u00A7u00C3u00A3o para o bloqueio

Returns:



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

def bloquear_cartao_using_post(id_conta, id_cartao, motivo, opts = {})
  data, _status_code, _headers = bloquear_cartao_using_post_with_http_info(id_conta, id_cartao, motivo, opts)
  return data
end

#bloquear_cartao_using_post_with_http_info(id_conta, id_cartao, motivo, opts = {}) ⇒ Array<(CancelarCartaoResponse, Fixnum, Hash)>

/contas/idConta/cartoes/idCartao/bloquear Bloquear um determinado cartu00C3u00A3o

Parameters:

  • id_conta —

    ID da Conta

  • id_cartao —

    ID do Cartu00C3u00A3o que deseja cancelar

  • motivo —

    Motivo do bloqueio

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

    the optional parameters

Options Hash (opts):

  • :observacao (String) —

    Alguma observau00C3u00A7u00C3u00A3o para o bloqueio

Returns:

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

    CancelarCartaoResponse 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
117
118
119
120
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 48

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

  # query parameters
  query_params = {}
  query_params[:'motivo'] = motivo
  query_params[:'observacao'] = opts[:'observacao'] if opts[:'observacao']

  # 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(: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 => 'CancelarCartaoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CartaoApi#bloquear_cartao_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_cartao_using_get(id_conta, id_cartao, opts = {}) ⇒ ConsultarCartaoResponse

/contas/idConta/cartoes/idCartao Consultar as informau00C3u00A7u00C3u00B5es de um determinado cartu00C3u00A3o de uma conta

Parameters:

  • id_conta —

    ID da Conta que pertence o cartu00C3u00A3o

  • id_cartao —

    ID do Cartu00C3u00A3o que deseja consultar

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

    the optional parameters

Options Hash (opts):

  • :numero_cartao (String) —

    Nu00C3u00BAmero do Cartu00C3u00A3o que deseja consultar (opcional)

Returns:



129
130
131
132
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 129

def consultar_cartao_using_get(id_conta, id_cartao, opts = {})
  data, _status_code, _headers = consultar_cartao_using_get_with_http_info(id_conta, id_cartao, opts)
  return data
end

#consultar_cartao_using_get_with_http_info(id_conta, id_cartao, opts = {}) ⇒ Array<(ConsultarCartaoResponse, Fixnum, Hash)>

/contas/idConta/cartoes/idCartao Consultar as informau00C3u00A7u00C3u00B5es de um determinado cartu00C3u00A3o de uma conta

Parameters:

  • id_conta —

    ID da Conta que pertence o cartu00C3u00A3o

  • id_cartao —

    ID do Cartu00C3u00A3o que deseja consultar

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

    the optional parameters

Options Hash (opts):

  • :numero_cartao (String) —

    Nu00C3u00BAmero do Cartu00C3u00A3o que deseja consultar (opcional)

Returns:

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

    ConsultarCartaoResponse data, response status code and response headers



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 141

def consultar_cartao_using_get_with_http_info(id_conta, id_cartao, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CartaoApi.consultar_cartao_using_get ..."
  end
  
  
  # verify the required parameter 'id_conta' is set
  fail ArgumentError, "Missing the required parameter 'id_conta' when calling CartaoApi.consultar_cartao_using_get" if id_conta.nil?
  
  
  
  
  
  
  # verify the required parameter 'id_cartao' is set
  fail ArgumentError, "Missing the required parameter 'id_cartao' when calling CartaoApi.consultar_cartao_using_get" if id_cartao.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/{idConta}/cartoes/{idCartao}".sub('{format}','json').sub('{' + 'idConta' + '}', id_conta.to_s).sub('{' + 'idCartao' + '}', id_cartao.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)
  header_params[:'numeroCartao'] = opts[:'numero_cartao'] if opts[:'numero_cartao']

  # 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 => 'ConsultarCartaoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CartaoApi#consultar_cartao_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_cartoes_using_get(id_conta, opts = {}) ⇒ ConsultarCartaoResponse

/contas/idConta/cartoes Consultar todos os cartu00C3u00B5es de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

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

    the optional parameters

Returns:



211
212
213
214
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 211

def consultar_cartoes_using_get(id_conta, opts = {})
  data, _status_code, _headers = consultar_cartoes_using_get_with_http_info(id_conta, opts)
  return data
end

#consultar_cartoes_using_get_with_http_info(id_conta, opts = {}) ⇒ Array<(ConsultarCartaoResponse, Fixnum, Hash)>

/contas/idConta/cartoes Consultar todos os cartu00C3u00B5es de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

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

    the optional parameters

Returns:

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

    ConsultarCartaoResponse data, response status code and response headers



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
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 221

def consultar_cartoes_using_get_with_http_info(id_conta, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CartaoApi.consultar_cartoes_using_get ..."
  end
  
  
  # verify the required parameter 'id_conta' is set
  fail ArgumentError, "Missing the required parameter 'id_conta' when calling CartaoApi.consultar_cartoes_using_get" if id_conta.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/{idConta}/cartoes".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 => 'ConsultarCartaoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CartaoApi#consultar_cartoes_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#desbloquear_cartao_using_post(id_conta, id_cartao, opts = {}) ⇒ DesbloquearCartaoResponse

/contas/idConta/cartoes/idCartao/desbloquear Desbloquear cartu00C3u00A3o de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

  • id_cartao —

    ID do Cartu00C3u00A3o que deseja consultar o saldo/limite

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

    the optional parameters

Options Hash (opts):

  • :codigo_segurancao (String) —

    Cu00C3u00B3digo seguranu00C3u00A7a do cartu00C3u00A3o

Returns:



278
279
280
281
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 278

def desbloquear_cartao_using_post(id_conta, id_cartao, opts = {})
  data, _status_code, _headers = desbloquear_cartao_using_post_with_http_info(id_conta, id_cartao, opts)
  return data
end

#desbloquear_cartao_using_post_with_http_info(id_conta, id_cartao, opts = {}) ⇒ Array<(DesbloquearCartaoResponse, Fixnum, Hash)>

/contas/idConta/cartoes/idCartao/desbloquear Desbloquear cartu00C3u00A3o de uma determinada conta

Parameters:

  • id_conta —

    ID da Conta

  • id_cartao —

    ID do Cartu00C3u00A3o que deseja consultar o saldo/limite

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

    the optional parameters

Options Hash (opts):

  • :codigo_segurancao (String) —

    Cu00C3u00B3digo seguranu00C3u00A7a do cartu00C3u00A3o

Returns:

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

    DesbloquearCartaoResponse data, response status code and response headers



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
 
# File 'lib/pier-sdk-ruby/api/cartao_api.rb', line 290

def desbloquear_cartao_using_post_with_http_info(id_conta, id_cartao, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CartaoApi.desbloquear_cartao_using_post ..."
  end
  
  
  # verify the required parameter 'id_conta' is set
  fail ArgumentError, "Missing the required parameter 'id_conta' when calling CartaoApi.desbloquear_cartao_using_post" if id_conta.nil?
  
  
  
  
  
  
  # verify the required parameter 'id_cartao' is set
  fail ArgumentError, "Missing the required parameter 'id_cartao' when calling CartaoApi.desbloquear_cartao_using_post" if id_cartao.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/v1/contas/{idConta}/cartoes/{idCartao}/desbloquear".sub('{format}','json').sub('{' + 'idConta' + '}', id_conta.to_s).sub('{' + 'idCartao' + '}', id_cartao.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)
  header_params[:'codigoSegurancao'] = opts[:'codigo_segurancao'] if opts[:'codigo_segurancao']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['access_token']
  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 => 'DesbloquearCartaoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CartaoApi#desbloquear_cartao_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end