class LosantRest::InstanceOrgInvite

Class containing all the actions for the Instance Org Invite Resource

Public Class Methods

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

Public Instance Methods

delete(params = {}) click to toggle source

Revokes an instance org invitation

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

Parameters:

  • {string} instanceId - ID associated with the instance

  • {string} orgId - ID associated with the organization

  • {string} inviteId - ID associated with the organization invite

  • {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/instance_org_invite.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("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
  raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)

  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]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"

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

Returns an organization invite

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

Parameters:

  • {string} instanceId - ID associated with the instance

  • {string} orgId - ID associated with the organization

  • {string} inviteId - ID associated with the organization invite

  • {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/instance_org_invite.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("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
  raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)

  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]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"

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

Resend an organization invite with modified role info

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, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.

Parameters:

  • {string} instanceId - ID associated with the instance

  • {string} orgId - ID associated with the organization

  • {string} inviteId - ID associated with the organization invite

  • {hash} roleInfo - Object containing updated role info (api.losant.com/#/definitions/orgRoleInfo)

  • {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/instance_org_invite.rb, line 154
def resend_invite(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("orgId is required") unless params.has_key?(:orgId)
  raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
  raise ArgumentError.new("roleInfo is required") unless params.has_key?(:roleInfo)

  body = params[:roleInfo] if params.has_key?(:roleInfo)
  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]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"

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