Class: WhiteLabelMachineName::TransactionPaymentPageService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/transaction_payment_page_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionPaymentPageService

Returns a new instance of TransactionPaymentPageService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/transaction_payment_page_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/transaction_payment_page_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#payment_page_url(space_id, id, opts = {}) ⇒ String

Build Payment Page URL This operation creates the URL to which the user should be redirected to when the payment page should be used.

Parameters:

  • space_id
  • id —

    The id of the transaction which should be returned.

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

    the optional parameters

Returns:

  • (String) 


34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/transaction_payment_page_service_api.rb', line 34

def payment_page_url(space_id, id, opts = {})
  data, _status_code, _headers = payment_page_url_with_http_info(space_id, id, opts)
  return data
end

#payment_page_url_with_http_info(space_id, id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Build Payment Page URL This operation creates the URL to which the user should be redirected to when the payment page should be used.

Parameters:

  • space_id
  • id —

    The id of the transaction which should be returned.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
83
84
85
86
87
88
89
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/transaction_payment_page_service_api.rb', line 45

def payment_page_url_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionPaymentPageService.payment_page_url ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TransactionPaymentPageService.payment_page_url" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling TransactionPaymentPageService.payment_page_url" if id.nil?
  # resource path
  local_var_path = "/transaction-payment-page/payment-page-url".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'text/plain;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionPaymentPageService#payment_page_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end