class LosantRest::ExperienceEndpoint

Class containing all the actions for the Experience Endpoint Resource

Public Class Methods

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

Public Instance Methods

delete(params = {}) click to toggle source

Deletes an experience endpoint

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

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceEndpointId - ID associated with the experience endpoint

  • {string} includeWorkflows - If the workflows that utilize this experience endpoint should also be deleted.

  • {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_endpoint.rb, line 57
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("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)

  query_params[:includeWorkflows] = params[:includeWorkflows] if params.has_key?(:includeWorkflows)
  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/endpoints/#{params[:experienceEndpointId]}"

  @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 endpoint

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

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceEndpointId - ID associated with the experience endpoint

  • {string} version - Version of this experience endpoint to return

  • {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_endpoint.rb, line 105
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("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)

  query_params[:version] = params[:version] if params.has_key?(:version)
  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/endpoints/#{params[:experienceEndpointId]}"

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

Retrieves information on resources linked to an experience endpoint

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, experienceEndpoint.*, or experienceEndpoint.linkedResources.

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceEndpointId - ID associated with the experience endpoint

  • {string} version - Version of this experience endpoint to query

  • {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by returned workflows

  • {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_endpoint.rb, line 154
def linked_resources(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("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)

  query_params[:version] = params[:version] if params.has_key?(:version)
  query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
  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/endpoints/#{params[:experienceEndpointId]}/linkedResources"

  @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 endpoint

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

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} experienceEndpointId - ID associated with the experience endpoint

  • {hash} experienceEndpoint - Object containing new properties of the experience endpoint (api.losant.com/#/definitions/experienceEndpointPatch)

  • {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_endpoint.rb, line 203
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("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)
  raise ArgumentError.new("experienceEndpoint is required") unless params.has_key?(:experienceEndpoint)

  body = params[:experienceEndpoint] if params.has_key?(:experienceEndpoint)
  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/endpoints/#{params[:experienceEndpointId]}"

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