class LosantRest::ExperienceGroup

Class containing all the actions for the Experience Group Resource

Public Class Methods

new(client) click to toggle source
# File lib/losant_rest/experience_group.rb, line 30
def initialize(client)
  @client = client
end

Public Instance Methods

delete(params = {}) click to toggle source

Deletes an experience group

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, experienceGroup.*, or experienceGroup.delete.

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceGroupId - ID associated with the experience group

  • {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:

# File lib/losant_rest/experience_group.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("experienceGroupId is required") unless params.has_key?(:experienceGroupId)

  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]}/experience/groups/#{params[:experienceGroupId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end
get(params = {}) click to toggle source

Retrieves information on an experience group

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, experienceGroup.*, or experienceGroup.get.

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceGroupId - ID associated with the experience group

  • {string} includeDirectDeviceCount - Whether or not to return count of devices associated directly with this group

  • {string} includeTotalDeviceCount - Whether or not to return count of devices associated with this group or any of its descendents

  • {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:

# File lib/losant_rest/experience_group.rb, line 104
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("experienceGroupId is required") unless params.has_key?(:experienceGroupId)

  query_params[:includeDirectDeviceCount] = params[:includeDirectDeviceCount] if params.has_key?(:includeDirectDeviceCount)
  query_params[:includeTotalDeviceCount] = params[:includeTotalDeviceCount] if params.has_key?(:includeTotalDeviceCount)
  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]}/experience/groups/#{params[:experienceGroupId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end
patch(params = {}) click to toggle source

Updates information about an experience group

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, experienceGroup.*, or experienceGroup.patch.

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceGroupId - ID associated with the experience group

  • {hash} experienceGroup - Object containing new properties of the experience group (api.losant.com/#/definitions/experienceGroupPatch)

  • {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:

# File lib/losant_rest/experience_group.rb, line 153
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("experienceGroupId is required") unless params.has_key?(:experienceGroupId)
  raise ArgumentError.new("experienceGroup is required") unless params.has_key?(:experienceGroup)

  body = params[:experienceGroup] if params.has_key?(:experienceGroup)
  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]}/experience/groups/#{params[:experienceGroupId]}"

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