Class: PlatformRest::InstanceNotificationRule

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/instance_notification_rule.rb

Overview

Class containing all the actions for the Instance Notification Rule Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ InstanceNotificationRule

Returns a new instance of InstanceNotificationRule.



30
31
32
 
# File 'lib/platform_rest/instance_notification_rule.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#delete(params = {}) ⇒ Object

Deletes a notification rule

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.delete.

Parameters:

  • string instanceId - ID associated with the instance

  • string notificationRuleId - ID associated with the notification rule

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/platform_rest/instance_notification_rule.rb', line 56

def delete(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("notificationRuleId is required") unless params.has_key?(:notificationRuleId)

  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/notification-rules/#{params[:notificationRuleId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#evaluate(params = {}) ⇒ Object

Queues the evaluation of a notification rule

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.evaluate.

Parameters:

  • string instanceId - ID associated with the instance

  • string notificationRuleId - ID associated with the notification rule

  • hash evaluationOptions - The options for the evaluation (api.losant.com/#/definitions/notificationRuleEvaluationOptions)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


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
 
# File 'lib/platform_rest/instance_notification_rule.rb', line 103

def evaluate(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("notificationRuleId is required") unless params.has_key?(:notificationRuleId)
  raise ArgumentError.new("evaluationOptions is required") unless params.has_key?(:evaluationOptions)

  body = params[:evaluationOptions] if params.has_key?(:evaluationOptions)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/notification-rules/#{params[:notificationRuleId]}/evaluate"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get(params = {}) ⇒ Object

Retrieves information on a notification rule

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceNotificationRule.*, or instanceNotificationRule.get.

Parameters:

  • string instanceId - ID associated with the instance

  • string notificationRuleId - ID associated with the notification rule

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/platform_rest/instance_notification_rule.rb', line 151

def get(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("notificationRuleId is required") unless params.has_key?(:notificationRuleId)

  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/notification-rules/#{params[:notificationRuleId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#logs(params = {}) ⇒ Object

Retrieves information on notification rule deliveries

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.logs.

Parameters:

  • string instanceId - ID associated with the instance

  • string notificationRuleId - ID associated with the notification rule

  • string limit - Max log entries to return (ordered by time descending)

  • string since - Look for log entries since this time (ms since epoch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


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
 
# File 'lib/platform_rest/instance_notification_rule.rb', line 199

def logs(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("notificationRuleId is required") unless params.has_key?(:notificationRuleId)

  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  query_params[:since] = params[:since] if params.has_key?(:since)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/notification-rules/#{params[:notificationRuleId]}/logs"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#patch(params = {}) ⇒ Object

Updates information about a notification rule

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.patch.

Parameters:

  • string instanceId - ID associated with the instance

  • string notificationRuleId - ID associated with the notification rule

  • hash notificationRule - Object containing new properties of the notification rule (api.losant.com/#/definitions/notificationRulePatch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/platform_rest/instance_notification_rule.rb', line 248

def patch(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("notificationRuleId is required") unless params.has_key?(:notificationRuleId)
  raise ArgumentError.new("notificationRule is required") unless params.has_key?(:notificationRule)

  body = params[:notificationRule] if params.has_key?(:notificationRule)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/notification-rules/#{params[:notificationRuleId]}"

  @client.request(
    method: :patch,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end