Class: CyberSource::FlexAPIApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/flex_api_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ FlexAPIApi

Returns a new instance of FlexAPIApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/flex_api_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/flex_api_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#generate_flex_api_capture_context(generate_flex_api_capture_context_request, opts = {}) ⇒ String

Establish a Payment Session with a Capture Context To establish a payment session, include the API fields you plan to use in that session in the body of the request. The system then returns a JSON Web Token (JWT) that includes the capture context. To determine which fields to include in your capture context, identify the personal information that you wish to isolate from the payment session. **Capture Context Fields**
When making a session request, any fields that you request to be added to the capture context are required by default. However, you can choose to make a field optional by setting the required parameter to false.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


29
30
31
32
 
# File 'lib/cybersource_rest_client/api/flex_api_api.rb', line 29

def generate_flex_api_capture_context(generate_flex_api_capture_context_request, opts = {})
  data, status_code, headers = generate_flex_api_capture_context_with_http_info(generate_flex_api_capture_context_request, opts)
  return data, status_code, headers
end

#generate_flex_api_capture_context_with_http_info(generate_flex_api_capture_context_request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Establish a Payment Session with a Capture Context To establish a payment session, include the API fields you plan to use in that session in the body of the request. The system then returns a JSON Web Token (JWT) that includes the capture context. To determine which fields to include in your capture context, identify the personal information that you wish to isolate from the payment session. **Capture Context Fields**&lt;br&gt; When making a session request, any fields that you request to be added to the capture context are required by default. However, you can choose to make a field optional by setting the required parameter to false.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



39
40
41
42
43
44
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
90
 
# File 'lib/cybersource_rest_client/api/flex_api_api.rb', line 39

def generate_flex_api_capture_context_with_http_info(generate_flex_api_capture_context_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: FlexAPIApi.generate_flex_api_capture_context ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'generate_flex_api_capture_context_request' is set
  if @api_client.config.client_side_validation && generate_flex_api_capture_context_request.nil?
    fail ArgumentError, "Missing the required parameter 'generate_flex_api_capture_context_request' when calling FlexAPIApi.generate_flex_api_capture_context"
  end
  # resource path
  local_var_path = 'flex/v2/sessions'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/jwt'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(generate_flex_api_capture_context_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'GenerateFlexAPICaptureContextRequest', @api_client.config.host)
  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 => 'String')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: FlexAPIApi#generate_flex_api_capture_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end