class LosantRest::Experience

Class containing all the actions for the Experience Resource

Public Class Methods

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

Public Instance Methods

bootstrap(params = {}) click to toggle source

Bootstraps the experience for this application with standard endpoints and views

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.cli, all.Organization, all.User, all.User.cli, experience.*, or experience.bootstrap.

Parameters:

  • {string} applicationId - ID associated with the application

  • {hash} options - Bootstrap options (api.losant.com/#/definitions/experienceBootstrapOptions)

  • {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.rb, line 56
def bootstrap(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("options is required") unless params.has_key?(:options)

  body = params[:options] if params.has_key?(:options)
  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/bootstrap"

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

Deletes multiple parts of an experience including users, groups, slugs, domains, versions, endpoints, views, and workflows

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

Parameters:

  • {string} applicationId - ID associated with the application

  • {string} keepUsers - If this is set, Experience Users will not be removed.

  • {string} keepGroups - If this is set, Experience Groups will not be removed.

  • {string} keepSlugs - If this is set, Experience Slugs will not be removed.

  • {string} keepDomains - If this is set, Experience Domains will not be removed.

  • {string} removeVersions - If this is set, all Experience Versions and their contents will be removed (except for develop).

  • {string} keepViews - If this is set, Experience Views (in the develop version) will not be removed.

  • {string} keepEndpoints - If this is set, Experience Endpoints (in the develop version) will not be removed.

  • {string} removeWorkflows - If this is set, all Experience Workflows (in the develop version) will ve removed.

  • {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.rb, line 110
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)

  query_params[:keepUsers] = params[:keepUsers] if params.has_key?(:keepUsers)
  query_params[:keepGroups] = params[:keepGroups] if params.has_key?(:keepGroups)
  query_params[:keepSlugs] = params[:keepSlugs] if params.has_key?(:keepSlugs)
  query_params[:keepDomains] = params[:keepDomains] if params.has_key?(:keepDomains)
  query_params[:removeVersions] = params[:removeVersions] if params.has_key?(:removeVersions)
  query_params[:keepViews] = params[:keepViews] if params.has_key?(:keepViews)
  query_params[:keepEndpoints] = params[:keepEndpoints] if params.has_key?(:keepEndpoints)
  query_params[:removeWorkflows] = params[:removeWorkflows] if params.has_key?(:removeWorkflows)
  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"

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