Class: Falcon::ScheduledReportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScheduledReportsApi

Returns a new instance of ScheduledReportsApi.



36
37
38
 
# File 'lib/crimson-falcon/api/scheduled_reports_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/scheduled_reports_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#scheduled_reports_get(ids, opts = {}) ⇒ DomainScheduledReportsResultV1

Retrieve scheduled reports for the provided report IDs.

Parameters:

  • ids (Array<String>) —

    The scheduled_report id to get details about.

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

    the optional parameters

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/scheduled_reports_api.rb', line 43

def scheduled_reports_get(ids, opts = {})
  data, _status_code, _headers = scheduled_reports_get_with_http_info(ids, opts)
  data
end

#scheduled_reports_get_with_http_info(ids, opts = {}) ⇒ Array<(DomainScheduledReportsResultV1, Integer, Hash)>

Retrieve scheduled reports for the provided report IDs.

Parameters:

  • ids (Array<String>) —

    The scheduled_report id to get details about.

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

    the optional parameters

Returns:



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
95
96
97
98
99
 
# File 'lib/crimson-falcon/api/scheduled_reports_api.rb', line 52

def scheduled_reports_get_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduledReportsApi.scheduled_reports_get ...'
  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 ScheduledReportsApi.scheduled_reports_get"
  end
  # resource path
  local_var_path = '/reports/entities/scheduled-reports/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] || 'DomainScheduledReportsResultV1'

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

  new_options = opts.merge(
    :operation => :"ScheduledReportsApi.scheduled_reports_get",
    :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: ScheduledReportsApi#scheduled_reports_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scheduled_reports_launch(body, opts = {}) ⇒ DomainReportExecutionsResponseV1

Launch scheduled reports executions for the provided report IDs.

Parameters:

Returns:



105
106
107
108
 
# File 'lib/crimson-falcon/api/scheduled_reports_api.rb', line 105

def scheduled_reports_launch(body, opts = {})
  data, _status_code, _headers = scheduled_reports_launch_with_http_info(body, opts)
  data
end

#scheduled_reports_launch_with_http_info(body, opts = {}) ⇒ Array<(DomainReportExecutionsResponseV1, Integer, Hash)>

Launch scheduled reports executions for the provided report IDs.

Parameters:

Returns:



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
 
# File 'lib/crimson-falcon/api/scheduled_reports_api.rb', line 114

def scheduled_reports_launch_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduledReportsApi.scheduled_reports_launch ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ScheduledReportsApi.scheduled_reports_launch"
  end
  # resource path
  local_var_path = '/reports/entities/scheduled-reports/execution/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

  new_options = opts.merge(
    :operation => :"ScheduledReportsApi.scheduled_reports_launch",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScheduledReportsApi#scheduled_reports_launch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scheduled_reports_query(opts = {}) ⇒ MsaQueryResponse

Find all report IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: created_on, last_updated_on, last_execution_on, next_execution_on

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: type, trigger_reference, recipients, user_uuid, cid, trigger_params.metadata. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:



175
176
177
178
 
# File 'lib/crimson-falcon/api/scheduled_reports_api.rb', line 175

def scheduled_reports_query(opts = {})
  data, _status_code, _headers = scheduled_reports_query_with_http_info(opts)
  data
end

#scheduled_reports_query_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Find all report IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: created_on, last_updated_on, last_execution_on, next_execution_on

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: type, trigger_reference, recipients, user_uuid, cid, trigger_params.metadata. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    MsaQueryResponse data, response status code and response headers



188
189
190
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
 
# File 'lib/crimson-falcon/api/scheduled_reports_api.rb', line 188

def scheduled_reports_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScheduledReportsApi.scheduled_reports_query ...'
  end
  # resource path
  local_var_path = '/reports/queries/scheduled-reports/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"ScheduledReportsApi.scheduled_reports_query",
    :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: ScheduledReportsApi#scheduled_reports_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end