class Wire4Client::CuentasDeBeneficiariosSPEIApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

authorize_accounts_pending_put(authorization, subscription, urls_redirect_dto, opts = {}) click to toggle source

Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente. Solicta la agrupación de las cuentas de beneficiarios en estado pendiente para que sean autorizadas, para ello se crea un conjunto de éstas que puede incluir tanto de SPEI como de SPID. Además se debe indicar las urls de redirección en caso de error y éxito @param authorization Header para token @param subscription Es el identificador de la suscripción a esta API. @param urls_redirect_dto Información de la cuenta del beneficiario @param [Hash] opts the optional parameters @return [AuthorizedBeneficiariesResponse]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 29
def authorize_accounts_pending_put(authorization, subscription, urls_redirect_dto, opts = {})
  data, _status_code, _headers = authorize_accounts_pending_put_with_http_info(authorization, subscription, urls_redirect_dto, opts)
  data
end
authorize_accounts_pending_put_with_http_info(authorization, subscription, urls_redirect_dto, opts = {}) click to toggle source

Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente. Solicta la agrupación de las cuentas de beneficiarios en estado pendiente para que sean autorizadas, para ello se crea un conjunto de éstas que puede incluir tanto de SPEI como de SPID. Además se debe indicar las urls de redirección en caso de error y éxito @param authorization Header para token @param subscription Es el identificador de la suscripción a esta API. @param urls_redirect_dto Información de la cuenta del beneficiario @param [Hash] opts the optional parameters @return [Array<(AuthorizedBeneficiariesResponse, Fixnum, Hash)>] AuthorizedBeneficiariesResponse data, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 41
def authorize_accounts_pending_put_with_http_info(authorization, subscription, urls_redirect_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_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 CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_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 CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_put"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_put, 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 CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_put, 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 CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_put, 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

  # verify the required parameter 'urls_redirect_dto' is set
  if @api_client.config.client_side_validation && urls_redirect_dto.nil?
    fail ArgumentError, "Missing the required parameter 'urls_redirect_dto' when calling CuentasDeBeneficiariosSPEIApi.authorize_accounts_pending_put"
  end
  # resource path
  local_var_path = '/subscriptions/{subscription}/beneficiaries/pending'.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(urls_redirect_dto)
  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,
    :return_type => 'AuthorizedBeneficiariesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CuentasDeBeneficiariosSPEIApi#authorize_accounts_pending_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_account_using_delete(authorization, account, subscription, opts = {}) click to toggle source

Elimina la cuenta del beneficiario Elimina la cuenta de beneficiario proporcionada relacionada al contrato perteneciente a la suscripción. La cuenta a borrar debe ser una que opere con SPEI. @param authorization Header para token @param account Es la cuenta del beneficiario que será eliminada. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [nil]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 108
def delete_account_using_delete(authorization, account, subscription, opts = {})
  delete_account_using_delete_with_http_info(authorization, account, subscription, opts)
  nil
end
delete_account_using_delete_with_http_info(authorization, account, subscription, opts = {}) click to toggle source

Elimina la cuenta del beneficiario Elimina la cuenta de beneficiario proporcionada relacionada al contrato perteneciente a la suscripción. La cuenta a borrar debe ser una que opere con SPEI. @param authorization Header para token @param account Es la cuenta del beneficiario que será eliminada. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 120
def delete_account_using_delete_with_http_info(authorization, account, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.delete_account_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 CuentasDeBeneficiariosSPEIApi.delete_account_using_delete"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && account.nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling CuentasDeBeneficiariosSPEIApi.delete_account_using_delete"
  end
  if @api_client.config.client_side_validation && account.to_s.length > 18
    fail ArgumentError, 'invalid value for "account" when calling CuentasDeBeneficiariosSPEIApi.delete_account_using_delete, the character length must be smaller than or equal to 18.'
  end

  if @api_client.config.client_side_validation && account.to_s.length < 10
    fail ArgumentError, 'invalid value for "account" when calling CuentasDeBeneficiariosSPEIApi.delete_account_using_delete, the character length must be great than or equal to 10.'
  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 CuentasDeBeneficiariosSPEIApi.delete_account_using_delete"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.delete_account_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 CuentasDeBeneficiariosSPEIApi.delete_account_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 CuentasDeBeneficiariosSPEIApi.delete_account_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}/beneficiaries/spei/{account}'.sub('{' + 'account' + '}', account.to_s).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'])
  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: CuentasDeBeneficiariosSPEIApi#delete_account_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_available_relationships_monex_using_get(authorization, subscription, opts = {}) click to toggle source

Consulta de relaciones Obtiene las posibles relaciones existentes para registrar beneficiarios en Monex. Se debe invocar este recurso antes de pre-registrar una cuenta de beneficiario. @param authorization Header para token @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [RelationshipsResponse]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 191
def get_available_relationships_monex_using_get(authorization, subscription, opts = {})
  data, _status_code, _headers = get_available_relationships_monex_using_get_with_http_info(authorization, subscription, opts)
  data
end
get_available_relationships_monex_using_get_with_http_info(authorization, subscription, opts = {}) click to toggle source

Consulta de relaciones Obtiene las posibles relaciones existentes para registrar beneficiarios en Monex. Se debe invocar este recurso antes de pre-registrar una cuenta de beneficiario. @param authorization Header para token @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [Array<(RelationshipsResponse, Fixnum, Hash)>] RelationshipsResponse data, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 202
def get_available_relationships_monex_using_get_with_http_info(authorization, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.get_available_relationships_monex_using_get ...'
  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 CuentasDeBeneficiariosSPEIApi.get_available_relationships_monex_using_get"
  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 CuentasDeBeneficiariosSPEIApi.get_available_relationships_monex_using_get"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.get_available_relationships_monex_using_get, 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 CuentasDeBeneficiariosSPEIApi.get_available_relationships_monex_using_get, 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 CuentasDeBeneficiariosSPEIApi.get_available_relationships_monex_using_get, 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/relationships'.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'])
  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 => 'RelationshipsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CuentasDeBeneficiariosSPEIApi#get_available_relationships_monex_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_beneficiaries_by_request_id(authorization, request_id, subscription, opts = {}) click to toggle source

Consulta los beneficiarios por el identificador de la petición de registro Obtiene los beneficiarios enviados para registro en una petición al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex, que pertenezcan a la petición que se solicita. @param authorization Header para token @param request_id El identificador de la petición del registro de beneficiarios a esta API. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [BeneficiariesResponse]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 263
def get_beneficiaries_by_request_id(authorization, request_id, subscription, opts = {})
  data, _status_code, _headers = get_beneficiaries_by_request_id_with_http_info(authorization, request_id, subscription, opts)
  data
end
get_beneficiaries_by_request_id_with_http_info(authorization, request_id, subscription, opts = {}) click to toggle source

Consulta los beneficiarios por el identificador de la petición de registro Obtiene los beneficiarios enviados para registro en una petición al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex, que pertenezcan a la petición que se solicita. @param authorization Header para token @param request_id El identificador de la petición del registro de beneficiarios a esta API. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [Array<(BeneficiariesResponse, Fixnum, Hash)>] BeneficiariesResponse data, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 275
def get_beneficiaries_by_request_id_with_http_info(authorization, request_id, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id ...'
  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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id"
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id"
  end
  if @api_client.config.client_side_validation && request_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "request_id" when calling CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id, the character length must be smaller than or equal to 36.'
  end

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

  if @api_client.config.client_side_validation && request_id !~ 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 'request_id' when calling CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id, 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

  # 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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id, 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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id, 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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_by_request_id, 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/spei/{requestId}'.sub('{' + 'requestId' + '}', request_id.to_s).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'])
  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 => 'BeneficiariesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CuentasDeBeneficiariosSPEIApi#get_beneficiaries_by_request_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_beneficiaries_for_account_using_get(authorization, subscription, opts = {}) click to toggle source

Consulta los beneficiarios registrados Obtiene los beneficiarios registrados al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex. @param authorization Header para token @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @option opts [String] :account Es la cuenta del beneficiario, podría ser teléfono celular (es de 10 dígitos), Tarjeta de débito (TDD, es de 16 dígitos) o cuenta CLABE (es de 18 dígitos). &lt;br/&gt;&lt;br/&gt;Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719. @option opts [String] :beneficiary_bank Es la clave del banco beneficiario. Se puede obtener del recurso de las &lt;a href&#x3D;&quot;#operation/getAllInstitutionsUsingGET&quot;&gt;instituciones.&lt;/a&gt; @option opts [String] :beneficiary_name Es el nombre del beneficiario. @option opts [String] :end_date Es la fecha de inicio del perido a filtrar en formato dd-mm-yyyy. @option opts [String] :init_date Es la fºecha de inicio del perido a filtrar en formato dd-mm-yyyy. @option opts [String] :rfc Es el Registro Federal de Controbuyentes (RFC) del beneficiario. @option opts [String] :status 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;. @return [BeneficiariesResponse]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 358
def get_beneficiaries_for_account_using_get(authorization, subscription, opts = {})
  data, _status_code, _headers = get_beneficiaries_for_account_using_get_with_http_info(authorization, subscription, opts)
  data
end
get_beneficiaries_for_account_using_get_with_http_info(authorization, subscription, opts = {}) click to toggle source

Consulta los beneficiarios registrados Obtiene los beneficiarios registrados al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex. @param authorization Header para token @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @option opts [String] :account Es la cuenta del beneficiario, podría ser teléfono celular (es de 10 dígitos), Tarjeta de débito (TDD, es de 16 dígitos) o cuenta CLABE (es de 18 dígitos). &lt;br/&gt;&lt;br/&gt;Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719. @option opts [String] :beneficiary_bank Es la clave del banco beneficiario. Se puede obtener del recurso de las &lt;a href&#x3D;&quot;#operation/getAllInstitutionsUsingGET&quot;&gt;instituciones.&lt;/a&gt; @option opts [String] :beneficiary_name Es el nombre del beneficiario. @option opts [String] :end_date Es la fecha de inicio del perido a filtrar en formato dd-mm-yyyy. @option opts [String] :init_date Es la fºecha de inicio del perido a filtrar en formato dd-mm-yyyy. @option opts [String] :rfc Es el Registro Federal de Controbuyentes (RFC) del beneficiario. @option opts [String] :status 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;. @return [Array<(BeneficiariesResponse, Fixnum, Hash)>] BeneficiariesResponse data, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 376
def get_beneficiaries_for_account_using_get_with_http_info(authorization, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.get_beneficiaries_for_account_using_get ...'
  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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_for_account_using_get"
  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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_for_account_using_get"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.get_beneficiaries_for_account_using_get, 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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_for_account_using_get, 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 CuentasDeBeneficiariosSPEIApi.get_beneficiaries_for_account_using_get, 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/spei'.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 => 'BeneficiariesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CuentasDeBeneficiariosSPEIApi#get_beneficiaries_for_account_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
pre_register_accounts_using_post(authorization, request_dto, subscription, opts = {}) click to toggle source

Pre-registro de cuentas de beneficiarios SPEI®. Pre-registra una o más cuentas de beneficiario en la plataforma de Wire4, ésta le proporcionará 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> @param authorization Header para token @param request_dto Información de la cuenta del beneficiario @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [TokenRequiredResponse]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 444
def pre_register_accounts_using_post(authorization, request_dto, subscription, opts = {})
  data, _status_code, _headers = pre_register_accounts_using_post_with_http_info(authorization, request_dto, subscription, opts)
  data
end
pre_register_accounts_using_post_with_http_info(authorization, request_dto, subscription, opts = {}) click to toggle source

Pre-registro de cuentas de beneficiarios SPEI®. Pre-registra una o más cuentas de beneficiario en la plataforma de Wire4, ésta le proporcionará 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; @param authorization Header para token @param request_dto Información de la cuenta del beneficiario @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [Array<(TokenRequiredResponse, Fixnum, Hash)>] TokenRequiredResponse data, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 456
def pre_register_accounts_using_post_with_http_info(authorization, request_dto, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.pre_register_accounts_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 CuentasDeBeneficiariosSPEIApi.pre_register_accounts_using_post"
  end
  # verify the required parameter 'request_dto' is set
  if @api_client.config.client_side_validation && request_dto.nil?
    fail ArgumentError, "Missing the required parameter 'request_dto' when calling CuentasDeBeneficiariosSPEIApi.pre_register_accounts_using_post"
  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 CuentasDeBeneficiariosSPEIApi.pre_register_accounts_using_post"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.pre_register_accounts_using_post, 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 CuentasDeBeneficiariosSPEIApi.pre_register_accounts_using_post, 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 CuentasDeBeneficiariosSPEIApi.pre_register_accounts_using_post, 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/spei'.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_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: CuentasDeBeneficiariosSPEIApi#pre_register_accounts_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
remove_beneficiaries_pending_using_delete(authorization, request_id, subscription, opts = {}) click to toggle source

Eliminación de beneficiarios SPEI® sin confirmar Elimina uno o más beneficiarios que se encuentran en estado pendiente de confirmar (autorizar) de la cuenta del cliente Monex relacionada a la suscripción. @param authorization Header para token @param request_id Es el identificador con el que se dió de alta a los beneficiarios (viene en el cuerpo de la respuesta del &lt;a href&#x3D;&quot;#operation/getAvailableRelationshipsMonexUsingGET&quot;&gt;pre-registro de beneficiarios&lt;/a&gt;), los registros bajo éste campo van a ser eliminados. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [nil]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 523
def remove_beneficiaries_pending_using_delete(authorization, request_id, subscription, opts = {})
  remove_beneficiaries_pending_using_delete_with_http_info(authorization, request_id, subscription, opts)
  nil
end
remove_beneficiaries_pending_using_delete_with_http_info(authorization, request_id, subscription, opts = {}) click to toggle source

Eliminación de beneficiarios SPEI® sin confirmar Elimina uno o más beneficiarios que se encuentran en estado pendiente de confirmar (autorizar) de la cuenta del cliente Monex relacionada a la suscripción. @param authorization Header para token @param request_id Es el identificador con el que se dió de alta a los beneficiarios (viene en el cuerpo de la respuesta del &lt;a href&#x3D;&quot;#operation/getAvailableRelationshipsMonexUsingGET&quot;&gt;pre-registro de beneficiarios&lt;/a&gt;), los registros bajo éste campo van a ser eliminados. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 535
def remove_beneficiaries_pending_using_delete_with_http_info(authorization, request_id, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.remove_beneficiaries_pending_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 CuentasDeBeneficiariosSPEIApi.remove_beneficiaries_pending_using_delete"
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling CuentasDeBeneficiariosSPEIApi.remove_beneficiaries_pending_using_delete"
  end
  if @api_client.config.client_side_validation && request_id !~ 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 'request_id' when calling CuentasDeBeneficiariosSPEIApi.remove_beneficiaries_pending_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

  # 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 CuentasDeBeneficiariosSPEIApi.remove_beneficiaries_pending_using_delete"
  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 CuentasDeBeneficiariosSPEIApi.remove_beneficiaries_pending_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}/beneficiaries/spei/request/{requestId}'.sub('{' + 'requestId' + '}', request_id.to_s).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'])
  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: CuentasDeBeneficiariosSPEIApi#remove_beneficiaries_pending_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_amount_limit_account_using_put(authorization, account, request_dto, subscription, opts = {}) click to toggle source

Solicitud para actualizar el monto límite de una cuenta Se crea una solicitud para actualizar el monto límite a la cuenta de beneficiario proporcionada y relacionada al contrato perteneciente a la subscripción. Una vez enviada la solicitud se retornará una URl que lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar la actualización del monto límite. @param authorization Header para token @param account Es la cuenta que va a ser actualizada. @param request_dto Información de la cuenta y el monto límite a actualizar. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [TokenRequiredResponse]

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 596
def update_amount_limit_account_using_put(authorization, account, request_dto, subscription, opts = {})
  data, _status_code, _headers = update_amount_limit_account_using_put_with_http_info(authorization, account, request_dto, subscription, opts)
  data
end
update_amount_limit_account_using_put_with_http_info(authorization, account, request_dto, subscription, opts = {}) click to toggle source

Solicitud para actualizar el monto límite de una cuenta Se crea una solicitud para actualizar el monto límite a la cuenta de beneficiario proporcionada y relacionada al contrato perteneciente a la subscripción. Una vez enviada la solicitud se retornará una URl que lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar la actualización del monto límite. @param authorization Header para token @param account Es la cuenta que va a ser actualizada. @param request_dto Información de la cuenta y el monto límite a actualizar. @param subscription Es el identificador de la suscripción a esta API. @param [Hash] opts the optional parameters @return [Array<(TokenRequiredResponse, Fixnum, Hash)>] TokenRequiredResponse data, response status code and response headers

# File lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb, line 609
def update_amount_limit_account_using_put_with_http_info(authorization, account, request_dto, subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_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 CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && account.nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put"
  end
  if @api_client.config.client_side_validation && account.to_s.length > 18
    fail ArgumentError, 'invalid value for "account" when calling CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put, the character length must be smaller than or equal to 18.'
  end

  if @api_client.config.client_side_validation && account.to_s.length < 10
    fail ArgumentError, 'invalid value for "account" when calling CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put, the character length must be great than or equal to 10.'
  end

  # verify the required parameter 'request_dto' is set
  if @api_client.config.client_side_validation && request_dto.nil?
    fail ArgumentError, "Missing the required parameter 'request_dto' when calling CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_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 CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put"
  end
  if @api_client.config.client_side_validation && subscription.to_s.length > 36
    fail ArgumentError, 'invalid value for "subscription" when calling CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put, 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 CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put, 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 CuentasDeBeneficiariosSPEIApi.update_amount_limit_account_using_put, 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/spei/{account}'.sub('{' + 'account' + '}', account.to_s).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_dto)
  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,
    :return_type => 'TokenRequiredResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CuentasDeBeneficiariosSPEIApi#update_amount_limit_account_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end