class LosantRest::Event
Class containing all the actions for the Event
Resource
Public Class Methods
# File lib/losant_rest/event.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes an event
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.Application, all.Organization, all.User, event.*, or event.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} eventId - ID associated with the event
-
{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:
-
200 - If event was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if event was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/event.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("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("eventId is required") unless params.has_key?(:eventId) 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 = "/applications/#{params[:applicationId]}/events/#{params[:eventId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on an event
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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, event.*, or event.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} eventId - ID associated with the event
-
{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:
-
200 -
Event
information (api.losant.com/#/definitions/event)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if event was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/event.rb, line 102 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("eventId is required") unless params.has_key?(:eventId) 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 = "/applications/#{params[:applicationId]}/events/#{params[:eventId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about an event
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.Application, all.Organization, all.User, event.*, or event.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} eventId - ID associated with the event
-
{hash} event - Object containing new properties of the event (api.losant.com/#/definitions/eventPatch)
-
{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:
-
200 - Updated event information (api.losant.com/#/definitions/event)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if event is not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/event.rb, line 149 def patch(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("eventId is required") unless params.has_key?(:eventId) raise ArgumentError.new("event is required") unless params.has_key?(:event) body = params[:event] if params.has_key?(:event) 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 = "/applications/#{params[:applicationId]}/events/#{params[:eventId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end