class CybridApiBank::PaymentInstructionsBankApi

def create_payment_instruction(post_payment_instruction_bank_model, opts = {})

Returns:
  • (PaymentInstructionBankModel) -

Parameters:
  • opts (Hash) -- the optional parameters
  • post_payment_instruction_bank_model (PostPaymentInstructionBankModel) --
def create_payment_instruction(post_payment_instruction_bank_model, opts = {})
  data, _status_code, _headers = create_payment_instruction_with_http_info(post_payment_instruction_bank_model, opts)
  data
end

def create_payment_instruction_with_http_info(post_payment_instruction_bank_model, opts = {})

Returns:
  • (Array<(PaymentInstructionBankModel, Integer, Hash)>) - PaymentInstructionBankModel data, response status code and response headers

Parameters:
  • opts (Hash) -- the optional parameters
  • post_payment_instruction_bank_model (PostPaymentInstructionBankModel) --
def create_payment_instruction_with_http_info(post_payment_instruction_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstructionsBankApi.create_payment_instruction ...'
  end
  # verify the required parameter 'post_payment_instruction_bank_model' is set
  if @api_client.config.client_side_validation && post_payment_instruction_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_payment_instruction_bank_model' when calling PaymentInstructionsBankApi.create_payment_instruction"
  end
  # resource path
  local_var_path = '/api/payment_instructions'
  # query parameters
  query_params = opts[:query_params] || {}
  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  # form parameters
  form_params = opts[:form_params] || {}
  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_payment_instruction_bank_model)
  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInstructionBankModel'
  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
  new_options = opts.merge(
    :operation => :"PaymentInstructionsBankApi.create_payment_instruction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentInstructionsBankApi#create_payment_instruction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

def get_payment_instruction(payment_instruction_guid, opts = {})

Returns:
  • (PaymentInstructionBankModel) -

Parameters:
  • opts (Hash) -- the optional parameters
  • payment_instruction_guid (String) -- Identifier for the payment instruction.
def get_payment_instruction(payment_instruction_guid, opts = {})
  data, _status_code, _headers = get_payment_instruction_with_http_info(payment_instruction_guid, opts)
  data
end

def get_payment_instruction_with_http_info(payment_instruction_guid, opts = {})

Returns:
  • (Array<(PaymentInstructionBankModel, Integer, Hash)>) - PaymentInstructionBankModel data, response status code and response headers

Parameters:
  • opts (Hash) -- the optional parameters
  • payment_instruction_guid (String) -- Identifier for the payment instruction.
def get_payment_instruction_with_http_info(payment_instruction_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstructionsBankApi.get_payment_instruction ...'
  end
  # verify the required parameter 'payment_instruction_guid' is set
  if @api_client.config.client_side_validation && payment_instruction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'payment_instruction_guid' when calling PaymentInstructionsBankApi.get_payment_instruction"
  end
  # resource path
  local_var_path = '/api/payment_instructions/{payment_instruction_guid}'.sub('{' + 'payment_instruction_guid' + '}', CGI.escape(payment_instruction_guid.to_s))
  # query parameters
  query_params = opts[:query_params] || {}
  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # form parameters
  form_params = opts[:form_params] || {}
  # http body (model)
  post_body = opts[:debug_body]
  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInstructionBankModel'
  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
  new_options = opts.merge(
    :operation => :"PaymentInstructionsBankApi.get_payment_instruction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentInstructionsBankApi#get_payment_instruction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

def initialize(api_client = ApiClient.default)

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

def list_payment_instructions(opts = {})

Returns:
  • (PaymentInstructionListBankModel) -

Options Hash: (**opts)
  • :invoice_guid (String) -- Comma separated invoice_guids to list payment instructions for.
  • :customer_guid (String) -- Comma separated customer_guids to list payment instructions for.
  • :bank_guid (String) -- Comma separated bank_guids to list payment instructions for.
  • :guid (String) -- Comma separated guids to list payment instructions for.
  • :per_page (Integer) -- The number of entities per page to return.
  • :page (Integer) -- The page index to retrieve.

Parameters:
  • opts (Hash) -- the optional parameters
def list_payment_instructions(opts = {})
  data, _status_code, _headers = list_payment_instructions_with_http_info(opts)
  data
end

def list_payment_instructions_with_http_info(opts = {})

Returns:
  • (Array<(PaymentInstructionListBankModel, Integer, Hash)>) - PaymentInstructionListBankModel data, response status code and response headers

Options Hash: (**opts)
  • :invoice_guid (String) -- Comma separated invoice_guids to list payment instructions for.
  • :customer_guid (String) -- Comma separated customer_guids to list payment instructions for.
  • :bank_guid (String) -- Comma separated bank_guids to list payment instructions for.
  • :guid (String) -- Comma separated guids to list payment instructions for.
  • :per_page (Integer) -- The number of entities per page to return.
  • :page (Integer) -- The page index to retrieve.

Parameters:
  • opts (Hash) -- the optional parameters
def list_payment_instructions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstructionsBankApi.list_payment_instructions ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PaymentInstructionsBankApi.list_payment_instructions, must be greater than or equal to 0.'
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PaymentInstructionsBankApi.list_payment_instructions, must be smaller than or equal to 100.'
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PaymentInstructionsBankApi.list_payment_instructions, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/payment_instructions'
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
  query_params[:'invoice_guid'] = opts[:'invoice_guid'] if !opts[:'invoice_guid'].nil?
  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # form parameters
  form_params = opts[:form_params] || {}
  # http body (model)
  post_body = opts[:debug_body]
  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInstructionListBankModel'
  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
  new_options = opts.merge(
    :operation => :"PaymentInstructionsBankApi.list_payment_instructions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentInstructionsBankApi#list_payment_instructions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end