class stcloud::AlertsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/stcloud/api/alerts_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_alert_using_post(body, opts = {}) click to toggle source

Create alert rule @param body dto @param [Hash] opts the optional parameters @return [AlertRuleResponse]

# File lib/stcloud/api/alerts_api.rb, line 23
def create_alert_using_post(body, opts = {})
  data, _status_code, _headers = create_alert_using_post_with_http_info(body, opts)
  data
end
create_alert_using_post_with_http_info(body, opts = {}) click to toggle source

Create alert rule @param body dto @param [Hash] opts the optional parameters @return [Array<(AlertRuleResponse, Integer, Hash)>] AlertRuleResponse data, response status code and response headers

# File lib/stcloud/api/alerts_api.rb, line 32
def create_alert_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.create_alert_using_post ...'
  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 AlertsApi.create_alert_using_post"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'AlertRuleResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#create_alert_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_alert_rule_using_delete(updateable_alert_id, opts = {}) click to toggle source

Delete alert rule @param updateable_alert_id updateableAlertId @param [Hash] opts the optional parameters @return [GenericMapBasedApiResponse]

# File lib/stcloud/api/alerts_api.rb, line 79
def delete_alert_rule_using_delete(updateable_alert_id, opts = {})
  data, _status_code, _headers = delete_alert_rule_using_delete_with_http_info(updateable_alert_id, opts)
  data
end
delete_alert_rule_using_delete_with_http_info(updateable_alert_id, opts = {}) click to toggle source

Delete alert rule @param updateable_alert_id updateableAlertId @param [Hash] opts the optional parameters @return [Array<(GenericMapBasedApiResponse, Integer, Hash)>] GenericMapBasedApiResponse data, response status code and response headers

# File lib/stcloud/api/alerts_api.rb, line 88
def delete_alert_rule_using_delete_with_http_info(updateable_alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.delete_alert_rule_using_delete ...'
  end
  # verify the required parameter 'updateable_alert_id' is set
  if @api_client.config.client_side_validation && updateable_alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'updateable_alert_id' when calling AlertsApi.delete_alert_rule_using_delete"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts/{updateableAlertId}'.sub('{' + 'updateableAlertId' + '}', updateable_alert_id.to_s)

  # 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'])

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

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

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#delete_alert_rule_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
disable_alert_rule_using_put(updateable_alert_id, opts = {}) click to toggle source

Disable alert rule @param updateable_alert_id updateableAlertId @param [Hash] opts the optional parameters @return [GenericMapBasedApiResponse]

# File lib/stcloud/api/alerts_api.rb, line 133
def disable_alert_rule_using_put(updateable_alert_id, opts = {})
  data, _status_code, _headers = disable_alert_rule_using_put_with_http_info(updateable_alert_id, opts)
  data
end
disable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {}) click to toggle source

Disable alert rule @param updateable_alert_id updateableAlertId @param [Hash] opts the optional parameters @return [Array<(GenericMapBasedApiResponse, Integer, Hash)>] GenericMapBasedApiResponse data, response status code and response headers

# File lib/stcloud/api/alerts_api.rb, line 142
def disable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.disable_alert_rule_using_put ...'
  end
  # verify the required parameter 'updateable_alert_id' is set
  if @api_client.config.client_side_validation && updateable_alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'updateable_alert_id' when calling AlertsApi.disable_alert_rule_using_put"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts/{updateableAlertId}/disable'.sub('{' + 'updateableAlertId' + '}', updateable_alert_id.to_s)

  # 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'])

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

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

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#disable_alert_rule_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
enable_alert_rule_using_put(updateable_alert_id, opts = {}) click to toggle source

Enable alert rule @param updateable_alert_id updateableAlertId @param [Hash] opts the optional parameters @return [GenericMapBasedApiResponse]

# File lib/stcloud/api/alerts_api.rb, line 187
def enable_alert_rule_using_put(updateable_alert_id, opts = {})
  data, _status_code, _headers = enable_alert_rule_using_put_with_http_info(updateable_alert_id, opts)
  data
end
enable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {}) click to toggle source

Enable alert rule @param updateable_alert_id updateableAlertId @param [Hash] opts the optional parameters @return [Array<(GenericMapBasedApiResponse, Integer, Hash)>] GenericMapBasedApiResponse data, response status code and response headers

# File lib/stcloud/api/alerts_api.rb, line 196
def enable_alert_rule_using_put_with_http_info(updateable_alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.enable_alert_rule_using_put ...'
  end
  # verify the required parameter 'updateable_alert_id' is set
  if @api_client.config.client_side_validation && updateable_alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'updateable_alert_id' when calling AlertsApi.enable_alert_rule_using_put"
  end
  # resource path
  local_var_path = '/users-web/api/v3/alerts/{updateableAlertId}/enable'.sub('{' + 'updateableAlertId' + '}', updateable_alert_id.to_s)

  # 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'])

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

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

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#enable_alert_rule_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_alert_rules_for_app_using_get(app_id, opts = {}) click to toggle source

Get alert rules for an app @param app_id appId @param [Hash] opts the optional parameters @return [AlertRulesResponse]

# File lib/stcloud/api/alerts_api.rb, line 241
def get_alert_rules_for_app_using_get(app_id, opts = {})
  data, _status_code, _headers = get_alert_rules_for_app_using_get_with_http_info(app_id, opts)
  data
end
get_alert_rules_for_app_using_get_with_http_info(app_id, opts = {}) click to toggle source

Get alert rules for an app @param app_id appId @param [Hash] opts the optional parameters @return [Array<(AlertRulesResponse, Integer, Hash)>] AlertRulesResponse data, response status code and response headers

# File lib/stcloud/api/alerts_api.rb, line 250
def get_alert_rules_for_app_using_get_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.get_alert_rules_for_app_using_get ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AlertsApi.get_alert_rules_for_app_using_get"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{appId}/alerts'.sub('{' + 'appId' + '}', app_id.to_s)

  # 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'])

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

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

  return_type = opts[:return_type] || 'AlertRulesResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#get_alert_rules_for_app_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end