Class: CyberSource::DeviceSearchApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DeviceSearchApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/device_search_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/device_search_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#post_search_query(post_device_search_request, opts = {}) ⇒ InlineResponse2006

Retrieve List of Devices for a given search query V2 Retrieves list of terminals in paginated format.

Parameters:

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

    the optional parameters

Returns:



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

def post_search_query(post_device_search_request, opts = {})
  data, status_code, headers = post_search_query_with_http_info(post_device_search_request, opts)
  return data, status_code, headers
end

#post_search_query_v3(post_device_search_request_v3, opts = {}) ⇒ InlineResponse2008

Retrieve List of Devices for a given search query Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.

Parameters:

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/cybersource_rest_client/api/device_search_api.rb', line 102

def post_search_query_v3(post_device_search_request_v3, opts = {})
  data, status_code, headers = post_search_query_v3_with_http_info(post_device_search_request_v3, opts)
  return data, status_code, headers
end

#post_search_query_v3_with_http_info(post_device_search_request_v3, opts = {}) ⇒ Array<(InlineResponse2008, Fixnum, Hash)>

Retrieve List of Devices for a given search query Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2008 data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cybersource_rest_client/api/device_search_api.rb', line 112

def post_search_query_v3_with_http_info(post_device_search_request_v3, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: DeviceSearchApi.post_search_query_v3 ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'post_device_search_request_v3' is set
  if @api_client.config.client_side_validation && post_device_search_request_v3.nil?
    fail ArgumentError, "Missing the required parameter 'post_device_search_request_v3' when calling DeviceSearchApi.post_search_query_v3"
  end
  # resource path
  local_var_path = 'dms/v3/devices/search'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # 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(post_device_search_request_v3)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostDeviceSearchRequestV3', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["post_search_query_v3","post_search_query_v3_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  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 => 'InlineResponse2008')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: DeviceSearchApi#post_search_query_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#post_search_query_with_http_info(post_device_search_request, opts = {}) ⇒ Array<(InlineResponse2006, Fixnum, Hash)>

Retrieve List of Devices for a given search query V2 Retrieves list of terminals in paginated format.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2006 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
91
92
93
94
 
# File 'lib/cybersource_rest_client/api/device_search_api.rb', line 39

def post_search_query_with_http_info(post_device_search_request, opts = {})

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # 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(post_device_search_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostDeviceSearchRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["post_search_query","post_search_query_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  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 => 'InlineResponse2006')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: DeviceSearchApi#post_search_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end