Class: Wire4Client::CuentasDeBeneficiariosSPIDApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CuentasDeBeneficiariosSPIDApi

Returns a new instance of CuentasDeBeneficiariosSPIDApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_spid_beneficiaries_for_account(authorization, subscription, opts = {}) ⇒ SpidBeneficiariesResponse

Consulta los beneficiarios SPID registrados Obtiene los beneficiarios SPID registrados al contrato relacionado con la suscripción. Los beneficiarios son los que actualmente se encuentran registrados en banca Monex.

Parameters:

  • authorization —

    Header para token

  • subscription —

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

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

    the optional parameters

Options Hash (opts):

  • :account (String) —

    Cuenta del beneficiario, puede ser CLABE (18 dígitos), Tarjeta de débito (TDD, 16 dígitos) o número de celular (10 dígitos).

  • :beneficiary_bank (String) —

    Es la clave del banco beneficiario. Se puede obtener del catalogo de <a href="#operation/getAllInstitutionsUsingGET">instituciones.</a>

  • :beneficiary_name (String) —

    Es el nombre del beneficiario.

  • :end_date (String) —

    Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.

  • :init_date (String) —

    Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.

  • :rfc (String) —

    Es el Registro Federal de Contribuyentes (RFC) del beneficiario.

  • :status (String) —

    Es el estado (estatus) de la cuenta, Los valores pueden ser <b>PENDING</b> y <b>REGISTERED</b>.

Returns:



35
36
37
38
 
# File 'lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb', line 35

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

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

Consulta los beneficiarios SPID registrados Obtiene los beneficiarios SPID registrados al contrato relacionado con la suscripción. Los beneficiarios son los que actualmente se encuentran registrados en banca Monex.

Parameters:

  • authorization —

    Header para token

  • subscription —

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

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

    the optional parameters

Options Hash (opts):

  • :account (String) —

    Cuenta del beneficiario, puede ser CLABE (18 dígitos), Tarjeta de débito (TDD, 16 dígitos) o número de celular (10 dígitos).

  • :beneficiary_bank (String) —

    Es la clave del banco beneficiario. Se puede obtener del catalogo de &lt;a href&#x3D;&quot;#operation/getAllInstitutionsUsingGET&quot;&gt;instituciones.&lt;/a&gt;

  • :beneficiary_name (String) —

    Es el nombre del beneficiario.

  • :end_date (String) —

    Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.

  • :init_date (String) —

    Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.

  • :rfc (String) —

    Es el Registro Federal de Contribuyentes (RFC) del beneficiario.

  • :status (String) —

    Es el estado (estatus) de la cuenta, Los valores pueden ser &lt;b&gt;PENDING&lt;/b&gt; y &lt;b&gt;REGISTERED&lt;/b&gt;.

Returns:

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

    SpidBeneficiariesResponse data, response status code and response headers



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

def (authorization, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPIDApi.get_spid_beneficiaries_for_account ...'
  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 CuentasDeBeneficiariosSPIDApi.get_spid_beneficiaries_for_account"
  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 CuentasDeBeneficiariosSPIDApi.get_spid_beneficiaries_for_account"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPIDApi.get_spid_beneficiaries_for_account, 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 CuentasDeBeneficiariosSPIDApi.get_spid_beneficiaries_for_account, 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 CuentasDeBeneficiariosSPIDApi.get_spid_beneficiaries_for_account, 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}/beneficiaries/spid'.sub('{' + 'subscription' + '}', subscription.to_s)

  # query parameters
  query_params = {}
  query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
  query_params[:'beneficiary_bank'] = opts[:'beneficiary_bank'] if !opts[:'beneficiary_bank'].nil?
  query_params[:'beneficiary_name'] = opts[:'beneficiary_name'] if !opts[:'beneficiary_name'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'init_date'] = opts[:'init_date'] if !opts[:'init_date'].nil?
  query_params[:'rfc'] = opts[:'rfc'] if !opts[:'rfc'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

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

  # form parameters
  form_params = {}

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

#pre_register_accounts_using_post1(authorization, request_spid_dto, subscription, opts = {}) ⇒ TokenRequiredResponse

Pre-registro de cuentas de beneficiarios SPID®Pre-registra una o más cuentas de beneficiario SPID® en la plataforma de Wire4, ésta le proporcionaará una URL donde lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar el alta de las cuentas de beneficiarios.<br/> Los posibles valores de relationship y kind_of_relationship se deben obtener de <a href="#operation/getAvailableRelationshipsMonexUsingGET">/subscriptions/subscription/beneficiaries/relationships.</a><br/><br/>La confirmación de registro en Monex se realizará a través de una notificación a los webhooks registrados con el evento de tipo <a href="#section/Eventos/Tipos-de-Eventos">ACCOUNT.CREATED.</a>

Parameters:

  • authorization —

    Header para token

  • request_spid_dto —

    Información de la cuenta del beneficiario

  • subscription —

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

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

    the optional parameters

Returns:



121
122
123
124
 
# File 'lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb', line 121

def pre_register_accounts_using_post1(authorization, request_spid_dto, subscription, opts = {})
  data, _status_code, _headers = pre_register_accounts_using_post1_with_http_info(authorization, request_spid_dto, subscription, opts)
  data
end

#pre_register_accounts_using_post1_with_http_info(authorization, request_spid_dto, subscription, opts = {}) ⇒ Array<(TokenRequiredResponse, Fixnum, Hash)>

Pre-registro de cuentas de beneficiarios SPID®Pre-registra una o más cuentas de beneficiario SPID® en la plataforma de Wire4, ésta le proporcionaará una URL donde lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar el alta de las cuentas de beneficiarios.&lt;br/&gt; Los posibles valores de &lt;em&gt;relationship&lt;/em&gt; y &lt;em&gt;kind_of_relationship&lt;/em&gt; se deben obtener de &lt;a href&#x3D;&quot;#operation/getAvailableRelationshipsMonexUsingGET&quot;&gt;/subscriptions/subscription/beneficiaries/relationships.&lt;/a&gt;&lt;br/&gt;&lt;br/&gt;La confirmación de registro en Monex se realizará a través de una notificación a los webhooks registrados con el evento de tipo &lt;a href&#x3D;&quot;#section/Eventos/Tipos-de-Eventos&quot;&gt;ACCOUNT.CREATED.&lt;/a&gt;

Parameters:

  • authorization —

    Header para token

  • request_spid_dto —

    Información de la cuenta del beneficiario

  • subscription —

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

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

    the optional parameters

Returns:

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

    TokenRequiredResponse 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
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb', line 133

def pre_register_accounts_using_post1_with_http_info(authorization, request_spid_dto, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1 ...'
  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 CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1"
  end
  # verify the required parameter 'request_spid_dto' is set
  if @api_client.config.client_side_validation && request_spid_dto.nil?
    fail ArgumentError, "Missing the required parameter 'request_spid_dto' when calling CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1"
  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 CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1, 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 CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1, 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 CuentasDeBeneficiariosSPIDApi.pre_register_accounts_using_post1, 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}/beneficiaries/spid'.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(['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(request_spid_dto)
  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 => 'TokenRequiredResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CuentasDeBeneficiariosSPIDApi#pre_register_accounts_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end