Class: CyberSource::SearchTransactionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SearchTransactionsApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/search_transactions_api.rb', line 19

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.



17
18
19
 
# File 'lib/cybersource_rest_client/api/search_transactions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_search(create_search_request, opts = {}) ⇒ TssV2TransactionsPost201Response

Create a search request Create a search request.

Parameters:

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cybersource_rest_client/api/search_transactions_api.rb', line 28

def create_search(create_search_request, opts = {})
  data, _status_code, _headers = create_search_with_http_info(create_search_request, opts)
  return data, _status_code, _headers
end

#create_search_with_http_info(create_search_request, opts = {}) ⇒ Array<(TssV2TransactionsPost201Response, Fixnum, Hash)>

Create a search request Create a search request.

Parameters:

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

    the optional parameters

Returns:



38
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
 
# File 'lib/cybersource_rest_client/api/search_transactions_api.rb', line 38

def create_search_with_http_info(create_search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchTransactionsApi.create_search ...'
  end
  # verify the required parameter 'create_search_request' is set
  if @api_client.config.client_side_validation && create_search_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_search_request' when calling SearchTransactionsApi.create_search"
  end
  # resource path
  local_var_path = 'tss/v2/searches'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_search_request)
  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 => 'TssV2TransactionsPost201Response')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchTransactionsApi#create_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_search(id, opts = {}) ⇒ TssV2TransactionsPost201Response

Get Search results Include the Search ID in the GET request to retrieve the search results.

Parameters:

  • id —

    Search ID.

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/cybersource_rest_client/api/search_transactions_api.rb', line 82

def get_search(id, opts = {})
  data, _status_code, _headers = get_search_with_http_info(id, opts)
  return data, _status_code, _headers
end

#get_search_with_http_info(id, opts = {}) ⇒ Array<(TssV2TransactionsPost201Response, Fixnum, Hash)>

Get Search results Include the Search ID in the GET request to retrieve the search results.

Parameters:

  • id —

    Search ID.

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

    the optional parameters

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/cybersource_rest_client/api/search_transactions_api.rb', line 92

def get_search_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchTransactionsApi.get_search ...'
  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 SearchTransactionsApi.get_search"
  end
  # resource path
  local_var_path = 'tss/v2/searches/{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([])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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