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

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

registra una pre-suscripción Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma, proporcionando una URL donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/>Una vez que el cuentahabiente autorice el acceso, se envia un webhook con el evento ENROLLMENT.CREATED, el cual contiene los datos de acceso.

Parameters:

  • authorization —

    Header para token

  • pre_enrollment_data —

    Información para el enrolamiento

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

    the optional parameters

Returns:



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

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)>

registra una pre-suscripción Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma, proporcionando una URL donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.&lt;br/&gt;Una vez que el cuentahabiente autorice el acceso, se envia un webhook con el evento ENROLLMENT.CREATED, el cual contiene los datos de acceso.

Parameters:

  • authorization —

    Header para token

  • pre_enrollment_data —

    Información para el enrolamiento

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

    the optional parameters

Returns:

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

    PreEnrollmentResponse data, response status code and response headers



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

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

Elimna una suscripción por id Elimina una suscripción, una ves eliminada la suscripcion ya no se podran realizar operacions en el API uilizando esta suscripción

Parameters:

  • authorization —

    Header para token

  • subscription —

    El identificador de la suscripción a esta API

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

    the optional parameters

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 89

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)>

Elimna una suscripción por id Elimina una suscripción, una ves eliminada la suscripcion ya no se podran realizar operacions en el API uilizando esta suscripción

Parameters:

  • authorization —

    Header para token

  • subscription —

    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



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
145
146
147
148
149
150
151
152
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 100

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

Elimna una pre-suscripción Se elimina una pre-suscripción, sólo se elimina en caso de que cliente monex no haya concedio su autorización de acceso, es decir que la pre-suscripcion este pendiente.

Parameters:

  • authorization —

    Header para token

  • subscription —

    El identificador de la suscripción a esta API

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

    the optional parameters

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 159

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)>

Elimna una pre-suscripción Se elimina una pre-suscripción, sólo se elimina en caso de que cliente monex no haya concedio su autorización de acceso, es decir que la pre-suscripcion este pendiente.

Parameters:

  • authorization —

    Header para token

  • subscription —

    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



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/wire4_client/api/suscripciones_api.rb', line 170

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