Class: Falcon::SpotlightEvaluationLogicApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpotlightEvaluationLogicApi

Returns a new instance of SpotlightEvaluationLogicApi.



36
37
38
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#combined_query_evaluation_logic(filter, opts = {}) ⇒ DomainSPAPIEvaluationLogicCombinedResponseV1

Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic entities which match the filter criteria.

Parameters:

  • filter (String) —

    FQL query specifying the filter parameters.

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    A pagination token used with the `limit` parameter to manage pagination of results. On your first request, don't provide an `after` token. On subsequent requests, provide the `after` token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Maximum number of entities to return.

  • :sort (String) —

    Sort evaluation logic by their properties.

Returns:



46
47
48
49
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 46

def combined_query_evaluation_logic(filter, opts = {})
  data, _status_code, _headers = combined_query_evaluation_logic_with_http_info(filter, opts)
  data
end

#combined_query_evaluation_logic_with_http_info(filter, opts = {}) ⇒ Array<(DomainSPAPIEvaluationLogicCombinedResponseV1, Integer, Hash)>

Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic entities which match the filter criteria.

Parameters:

  • filter (String) —

    FQL query specifying the filter parameters.

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Maximum number of entities to return.

  • :sort (String) —

    Sort evaluation logic by their properties.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 58

def combined_query_evaluation_logic_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpotlightEvaluationLogicApi.combined_query_evaluation_logic ...'
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling SpotlightEvaluationLogicApi.combined_query_evaluation_logic"
  end
  # resource path
  local_var_path = '/spotlight/combined/evaluation-logic/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = filter
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DomainSPAPIEvaluationLogicCombinedResponseV1'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SpotlightEvaluationLogicApi.combined_query_evaluation_logic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpotlightEvaluationLogicApi#combined_query_evaluation_logic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_evaluation_logic(ids, opts = {}) ⇒ DomainSPAPIEvaluationLogicEntitiesResponseV1

Get details on evaluation logic items by providing one or more IDs.

Parameters:

  • ids (Array<String>) —

    One or more evaluation logic IDs.

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

    the optional parameters

Returns:



114
115
116
117
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 114

def get_evaluation_logic(ids, opts = {})
  data, _status_code, _headers = get_evaluation_logic_with_http_info(ids, opts)
  data
end

#get_evaluation_logic_with_http_info(ids, opts = {}) ⇒ Array<(DomainSPAPIEvaluationLogicEntitiesResponseV1, Integer, Hash)>

Get details on evaluation logic items by providing one or more IDs.

Parameters:

  • ids (Array<String>) —

    One or more evaluation logic IDs.

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

    the optional parameters

Returns:



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
168
169
170
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 123

def get_evaluation_logic_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpotlightEvaluationLogicApi.get_evaluation_logic ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling SpotlightEvaluationLogicApi.get_evaluation_logic"
  end
  # resource path
  local_var_path = '/spotlight/entities/evaluation-logic/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DomainSPAPIEvaluationLogicEntitiesResponseV1'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SpotlightEvaluationLogicApi.get_evaluation_logic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpotlightEvaluationLogicApi#get_evaluation_logic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_evaluation_logic(filter, opts = {}) ⇒ DomainSPAPIQueryResponse

Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic IDs which match the filter criteria.

Parameters:

  • filter (String) —

    FQL query specifying the filter parameters.

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Maximum number of entities to return.

  • :sort (String) —

    Sort evaluation logic by their properties.

Returns:



179
180
181
182
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 179

def query_evaluation_logic(filter, opts = {})
  data, _status_code, _headers = query_evaluation_logic_with_http_info(filter, opts)
  data
end

#query_evaluation_logic_with_http_info(filter, opts = {}) ⇒ Array<(DomainSPAPIQueryResponse, Integer, Hash)>

Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic IDs which match the filter criteria.

Parameters:

  • filter (String) —

    FQL query specifying the filter parameters.

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Maximum number of entities to return.

  • :sort (String) —

    Sort evaluation logic by their properties.

Returns:

  • (Array<(DomainSPAPIQueryResponse, Integer, Hash)>) —

    DomainSPAPIQueryResponse data, response status code and response headers



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/crimson-falcon/api/spotlight_evaluation_logic_api.rb', line 191

def query_evaluation_logic_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpotlightEvaluationLogicApi.query_evaluation_logic ...'
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling SpotlightEvaluationLogicApi.query_evaluation_logic"
  end
  # resource path
  local_var_path = '/spotlight/queries/evaluation-logic/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = filter
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DomainSPAPIQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SpotlightEvaluationLogicApi.query_evaluation_logic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpotlightEvaluationLogicApi#query_evaluation_logic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end