class Aimastering::PaymentApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create_payment(product_token, service, opts = {}) click to toggle source

Create a new payment.

@param product_token This parameter represents the product token. @param service This parameter represents the payment message. @param [Hash] opts the optional parameters @option opts [String] :token This parameter represents the card token. This parameter is effective only when the service is "stripe". @return [Payment]

# File lib/aimastering/api/payment_api.rb, line 30
def create_payment(product_token, service, opts = {})
  data, _status_code, _headers = create_payment_with_http_info(product_token, service, opts)
  return data
end
create_payment_with_http_info(product_token, service, opts = {}) click to toggle source

Create a new payment.

@param product_token This parameter represents the product token. @param service This parameter represents the payment message. @param [Hash] opts the optional parameters @option opts [String] :token This parameter represents the card token. This parameter is effective only when the service is "stripe&quot;. @return [Array<(Payment, Fixnum, Hash)>] Payment data, response status code and response headers

# File lib/aimastering/api/payment_api.rb, line 42
def create_payment_with_http_info(product_token, service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.create_payment ..."
  end
  # verify the required parameter 'product_token' is set
  if @api_client.config.client_side_validation && product_token.nil?
    fail ArgumentError, "Missing the required parameter 'product_token' when calling PaymentApi.create_payment"
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling PaymentApi.create_payment"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['paypal', 'stripe'].include?(service)
    fail ArgumentError, "invalid value for 'service', must be one of paypal, stripe"
  end
  # resource path
  local_var_path = "/payments"

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["product_token"] = product_token
  form_params["service"] = service
  form_params["token"] = opts[:'token'] if !opts[:'token'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  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 => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#create_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
execute_payment(id, payer_id, opts = {}) click to toggle source

Execute a payment by id.

@param id Payment id @param payer_id This parameter represents the card token. This parameter is effective only when the service is "paypal&quot;. @param [Hash] opts the optional parameters @return [Payment]

# File lib/aimastering/api/payment_api.rb, line 99
def execute_payment(id, payer_id, opts = {})
  data, _status_code, _headers = execute_payment_with_http_info(id, payer_id, opts)
  return data
end
execute_payment_with_http_info(id, payer_id, opts = {}) click to toggle source

Execute a payment by id.

@param id Payment id @param payer_id This parameter represents the card token. This parameter is effective only when the service is "paypal&quot;. @param [Hash] opts the optional parameters @return [Array<(Payment, Fixnum, Hash)>] Payment data, response status code and response headers

# File lib/aimastering/api/payment_api.rb, line 110
def execute_payment_with_http_info(id, payer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.execute_payment ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentApi.execute_payment"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling PaymentApi.execute_payment, must be greater than or equal to 1.'
  end

  # verify the required parameter 'payer_id' is set
  if @api_client.config.client_side_validation && payer_id.nil?
    fail ArgumentError, "Missing the required parameter 'payer_id' when calling PaymentApi.execute_payment"
  end
  # resource path
  local_var_path = "/payments/{id}/execute".sub('{' + 'id' + '}', id.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["payer_id"] = payer_id

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  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 => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#execute_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_payment(id, opts = {}) click to toggle source

Get a payment by id.

@param id Payment id @param [Hash] opts the optional parameters @return [Payment]

# File lib/aimastering/api/payment_api.rb, line 164
def get_payment(id, opts = {})
  data, _status_code, _headers = get_payment_with_http_info(id, opts)
  return data
end
get_payment_with_http_info(id, opts = {}) click to toggle source

Get a payment by id.

@param id Payment id @param [Hash] opts the optional parameters @return [Array<(Payment, Fixnum, Hash)>] Payment data, response status code and response headers

# File lib/aimastering/api/payment_api.rb, line 174
def get_payment_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.get_payment ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentApi.get_payment"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling PaymentApi.get_payment, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/payments/{id}".sub('{' + 'id' + '}', id.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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  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 => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#get_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_payments(opts = {}) click to toggle source

Get all accessable payments.

@param [Hash] opts the optional parameters @return [Array<Payment>]

# File lib/aimastering/api/payment_api.rb, line 220
def list_payments(opts = {})
  data, _status_code, _headers = list_payments_with_http_info(opts)
  return data
end
list_payments_with_http_info(opts = {}) click to toggle source

Get all accessable payments.

@param [Hash] opts the optional parameters @return [Array<(Array<Payment>, Fixnum, Hash)>] Array<Payment> data, response status code and response headers

# File lib/aimastering/api/payment_api.rb, line 229
def list_payments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentApi.list_payments ..."
  end
  # resource path
  local_var_path = "/payments"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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