class LosantRest::InstanceMember
Class containing all the actions for the Instance
Member Resource
Public Class Methods
# File lib/losant_rest/instance_member.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes an instance member
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.Instance, all.User, instanceMember.*, or instanceMember.delete.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} userId - ID associated with the instance member
-
{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 member was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance or member was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_member.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("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("userId is required") unless params.has_key?(:userId) 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 = "/instances/#{params[:instanceId]}/members/#{params[:userId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Returns an instance member
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.Instance, all.Instance.read, all.User, all.User.read, instanceMember.*, or instanceMember.get.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} userId - ID associated with the instance member
-
{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 - A single instance member (api.losant.com/#/definitions/instanceMember)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance or member was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_member.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("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("userId is required") unless params.has_key?(:userId) 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 = "/instances/#{params[:instanceId]}/members/#{params[:userId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Modifies the role of an instance member
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.Instance, all.User, instanceMember.*, or instanceMember.patch.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} userId - ID associated with the instance member
-
{hash} member - Object containing new member info (api.losant.com/#/definitions/instanceMemberPatch)
-
{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 - The modified instance member (api.losant.com/#/definitions/instanceMemberPatch)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance or member was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_member.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("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("userId is required") unless params.has_key?(:userId) raise ArgumentError.new("member is required") unless params.has_key?(:member) body = params[:member] if params.has_key?(:member) 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 = "/instances/#{params[:instanceId]}/members/#{params[:userId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end