Class: Wire4Client::SuscripcionesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SuscripcionesApi

Returns a new instance of SuscripcionesApi.



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

def api_client
  @api_client
end

Instance Method Details

#change_subscription_status_using_put(authorization, request, subscription, opts = {}) ⇒ nil

Cambia el estatus de la suscripción Se cambia el estado o estatus de la suscripción a los posibles valores que son: ACTIVE o INACTIVE

Parameters:

  • authorization —

    Header para token

  • request —

    request

  • subscription —

    subscription

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 29

def change_subscription_status_using_put(authorization, request, subscription, opts = {})
  change_subscription_status_using_put_with_http_info(authorization, request, subscription, opts)
  nil
end

#change_subscription_status_using_put_with_http_info(authorization, request, subscription, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cambia el estatus de la suscripción Se cambia el estado o estatus de la suscripción a los posibles valores que son: ACTIVE o INACTIVE

Parameters:

  • authorization —

    Header para token

  • request —

    request

  • subscription —

    subscription

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
80
81
82
83
84
85
86
87
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 41

def change_subscription_status_using_put_with_http_info(authorization, request, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuscripcionesApi.change_subscription_status_using_put ...'
  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 SuscripcionesApi.change_subscription_status_using_put"
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling SuscripcionesApi.change_subscription_status_using_put"
  end
  # verify the required parameter 'subscription' is set
  if @api_client.config.client_side_validation && subscription.nil?
    fail ArgumentError, "Missing the required parameter 'subscription' when calling SuscripcionesApi.change_subscription_status_using_put"
  end
  # resource path
  local_var_path = '/subscriptions/{subscription}/status'.sub('{' + 'subscription' + '}', subscription.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SuscripcionesApi#change_subscription_status_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#change_subscription_use_using_patch(authorization, request, subscription, opts = {}) ⇒ ServiceBanking

Cambia el uso de la suscripción Se asigna o cambia el uso y el estatus que se le dará a la subscripción para los servicios SPEI y SPID en el manejo de Cobros y Pagos El status puede tener los posibles valores: ACTIVE o INACTIVE. El uso puede tener los posibles valores: WITHDRAWAL_DEPOSIT o WITHDRAWAL o DEPOSIT

Parameters:

  • authorization —

    Header para token

  • request —

    request

  • subscription —

    subscription

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 95

def change_subscription_use_using_patch(authorization, request, subscription, opts = {})
  data, _status_code, _headers = change_subscription_use_using_patch_with_http_info(authorization, request, subscription, opts)
  data
end

#change_subscription_use_using_patch_with_http_info(authorization, request, subscription, opts = {}) ⇒ Array<(ServiceBanking, Fixnum, Hash)>

Cambia el uso de la suscripción Se asigna o cambia el uso y el estatus que se le dará a la subscripción para los servicios SPEI y SPID en el manejo de Cobros y Pagos El status puede tener los posibles valores: ACTIVE o INACTIVE. El uso puede tener los posibles valores: WITHDRAWAL_DEPOSIT o WITHDRAWAL o DEPOSIT

Parameters:

  • authorization —

    Header para token

  • request —

    request

  • subscription —

    subscription

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

    the optional parameters

Returns:

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

    ServiceBanking data, response status code and response headers



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/wire4_client/api/suscripciones_api.rb', line 107

def change_subscription_use_using_patch_with_http_info(authorization, request, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuscripcionesApi.change_subscription_use_using_patch ...'
  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 SuscripcionesApi.change_subscription_use_using_patch"
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling SuscripcionesApi.change_subscription_use_using_patch"
  end
  # verify the required parameter 'subscription' is set
  if @api_client.config.client_side_validation && subscription.nil?
    fail ArgumentError, "Missing the required parameter 'subscription' when calling SuscripcionesApi.change_subscription_use_using_patch"
  end
  # resource path
  local_var_path = '/subscriptions/{subscription}'.sub('{' + 'subscription' + '}', subscription.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceBanking')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SuscripcionesApi#change_subscription_use_using_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data, opts = {}) ⇒ PreEnrollmentResponse

Pre-registro de una suscripción Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma. Se retorna una dirección URL hacia el centro de autorización donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/><br/>Una vez que el cuentahabiente autorice el acceso, se envía una notificación (webhook configurado) con el evento ‘ENROLLMENT.CREATED’, el cuál contiene los datos de acceso a esta API.

Parameters:

  • authorization —

    Header para token

  • pre_enrollment_data —

    Información para la pre-suscripción

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

    the optional parameters

Returns:



161
162
163
164
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 161

def pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data, opts = {})
  data, _status_code, _headers = pre_enrollment_monex_user_using_post_with_http_info(authorization, pre_enrollment_data, opts)
  data
end

#pre_enrollment_monex_user_using_post_with_http_info(authorization, pre_enrollment_data, opts = {}) ⇒ Array<(PreEnrollmentResponse, Fixnum, Hash)>

Pre-registro de una suscripción Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma. Se retorna una dirección URL hacia el centro de autorización donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.&lt;br/&gt;&lt;br/&gt;Una vez que el cuentahabiente autorice el acceso, se envía una notificación (webhook configurado) con el evento &#39;ENROLLMENT.CREATED&#39;, el cuál contiene los datos de acceso a esta API.

Parameters:

  • authorization —

    Header para token

  • pre_enrollment_data —

    Información para la pre-suscripción

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

    the optional parameters

Returns:

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

    PreEnrollmentResponse data, response status code and response headers



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
214
215
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 172

def pre_enrollment_monex_user_using_post_with_http_info(authorization, pre_enrollment_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuscripcionesApi.pre_enrollment_monex_user_using_post ...'
  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 SuscripcionesApi.pre_enrollment_monex_user_using_post"
  end
  # verify the required parameter 'pre_enrollment_data' is set
  if @api_client.config.client_side_validation && pre_enrollment_data.nil?
    fail ArgumentError, "Missing the required parameter 'pre_enrollment_data' when calling SuscripcionesApi.pre_enrollment_monex_user_using_post"
  end
  # resource path
  local_var_path = '/subscriptions/pre-subscription'

  # query parameters
  query_params = {}

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

#remove_enrollment_user_using_delete(authorization, subscription, opts = {}) ⇒ nil

Elimina suscripción por su identificador. Elimina una suscripción mediante su identificador. Una vez eliminada dicha suscripción, ya no se podrán realizar operaciones en el API utilizando sus credenciales

Parameters:

  • authorization —

    Header para token

  • subscription —

    El identificador de la suscripción a ésta API

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

    the optional parameters

Returns:

  • (nil) 


222
223
224
225
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 222

def remove_enrollment_user_using_delete(authorization, subscription, opts = {})
  remove_enrollment_user_using_delete_with_http_info(authorization, subscription, opts)
  nil
end

#remove_enrollment_user_using_delete_with_http_info(authorization, subscription, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Elimina suscripción por su identificador. Elimina una suscripción mediante su identificador. Una vez eliminada dicha suscripción, ya no se podrán realizar operaciones en el API utilizando sus credenciales

Parameters:

  • authorization —

    Header para token

  • subscription —

    El identificador de la suscripción a ésta API

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 233

def remove_enrollment_user_using_delete_with_http_info(authorization, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuscripcionesApi.remove_enrollment_user_using_delete ...'
  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 SuscripcionesApi.remove_enrollment_user_using_delete"
  end
  # verify the required parameter 'subscription' is set
  if @api_client.config.client_side_validation && subscription.nil?
    fail ArgumentError, "Missing the required parameter 'subscription' when calling SuscripcionesApi.remove_enrollment_user_using_delete"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling SuscripcionesApi.remove_enrollment_user_using_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && subscription.to_s.length < 36
    fail ArgumentError, 'invalid value for "subscription" when calling SuscripcionesApi.remove_enrollment_user_using_delete, the character length must be great than or equal to 36.'
  end

  if @api_client.config.client_side_validation && subscription !~ Regexp.new(/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/)
    fail ArgumentError, "invalid value for 'subscription' when calling SuscripcionesApi.remove_enrollment_user_using_delete, must conform to the pattern /[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/."
  end

  # resource path
  local_var_path = '/subscriptions/{subscription}'.sub('{' + 'subscription' + '}', subscription.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

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

#remove_subscription_pending_status_using_delete(authorization, subscription, opts = {}) ⇒ nil

Elimina pre-registro de suscripción Se elimina el pre-registro de suscripción. Sólo se elimina en caso de que el cliente Monex no haya concedido su autorización de acceso (token), es decir que la suscripcion esté pendiente.

Parameters:

  • authorization —

    Header para token

  • subscription —

    Es el identificador de la suscripción a esta API.

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

    the optional parameters

Returns:

  • (nil) 


292
293
294
295
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 292

def remove_subscription_pending_status_using_delete(authorization, subscription, opts = {})
  remove_subscription_pending_status_using_delete_with_http_info(authorization, subscription, opts)
  nil
end

#remove_subscription_pending_status_using_delete_with_http_info(authorization, subscription, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Elimina pre-registro de suscripción Se elimina el pre-registro de suscripción. Sólo se elimina en caso de que el cliente Monex no haya concedido su autorización de acceso (token), es decir que la suscripcion esté pendiente.

Parameters:

  • authorization —

    Header para token

  • subscription —

    Es el identificador de la suscripción a esta API.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def remove_subscription_pending_status_using_delete_with_http_info(authorization, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuscripcionesApi.remove_subscription_pending_status_using_delete ...'
  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 SuscripcionesApi.remove_subscription_pending_status_using_delete"
  end
  # verify the required parameter 'subscription' is set
  if @api_client.config.client_side_validation && subscription.nil?
    fail ArgumentError, "Missing the required parameter 'subscription' when calling SuscripcionesApi.remove_subscription_pending_status_using_delete"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling SuscripcionesApi.remove_subscription_pending_status_using_delete, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && subscription.to_s.length < 36
    fail ArgumentError, 'invalid value for "subscription" when calling SuscripcionesApi.remove_subscription_pending_status_using_delete, the character length must be great than or equal to 36.'
  end

  if @api_client.config.client_side_validation && subscription !~ Regexp.new(/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/)
    fail ArgumentError, "invalid value for 'subscription' when calling SuscripcionesApi.remove_subscription_pending_status_using_delete, must conform to the pattern /[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/."
  end

  # resource path
  local_var_path = '/subscriptions/pre-subscription/{subscription}'.sub('{' + 'subscription' + '}', subscription.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

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