class LosantRest::ExperienceUser
Class containing all the actions for the Experience
User Resource
Public Class Methods
# File lib/losant_rest/experience_user.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes an experience user
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, experienceUser.*, or experienceUser.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceUserId - ID associated with the experience user
-
{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 experience user was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience user was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_user.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("experienceUserId is required") unless params.has_key?(:experienceUserId) 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/users/#{params[:experienceUserId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on an experience user
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, experienceUser.*, or experienceUser.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceUserId - ID associated with the experience user
-
{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 -
Experience
user information (api.losant.com/#/definitions/experienceUser)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience user was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_user.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("experienceUserId is required") unless params.has_key?(:experienceUserId) 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/users/#{params[:experienceUserId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about an experience user
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, experienceUser.*, or experienceUser.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceUserId - ID associated with the experience user
-
{hash} experienceUser - Object containing new properties of the experience user (api.losant.com/#/definitions/experienceUserPatch)
-
{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 experience user information (api.losant.com/#/definitions/experienceUser)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience user was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_user.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("experienceUserId is required") unless params.has_key?(:experienceUserId) raise ArgumentError.new("experienceUser is required") unless params.has_key?(:experienceUser) body = params[:experienceUser] if params.has_key?(:experienceUser) 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/users/#{params[:experienceUserId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end