Class: PlatformRest::InstanceOrgInvites

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/instance_org_invites.rb

Overview

Class containing all the actions for the Instance Org Invites Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ InstanceOrgInvites

Returns a new instance of InstanceOrgInvites.



30
31
32
 
# File 'lib/platform_rest/instance_org_invites.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#get(params = {}) ⇒ Object

Returns a collection of instance organization invites

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

Parameters:

  • string instanceId - ID associated with the instance

  • string orgId - ID associated with the organization

  • string sortField - Field to sort the results by. Accepted values are: email, role, inviteDate

  • string sortDirection - Direction to sort the results by. Accepted values are: asc, desc

  • string filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role

  • string filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.

  • 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:

Raises:

  • (ArgumentError) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/platform_rest/instance_org_invites.rb', line 60

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)

  query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
  query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
  query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
  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"

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

#post(params = {}) ⇒ Object

Invites a member to an instance organization

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, instanceOrgInvites.*, or instanceOrgInvites.post.

Parameters:

  • string instanceId - ID associated with the instance

  • string orgId - ID associated with the organization

  • hash invite - Object containing new invite info (api.losant.com/#/definitions/orgInvitePost)

  • 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:

Raises:

  • (ArgumentError) 


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/platform_rest/instance_org_invites.rb', line 111

def post(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("invite is required") unless params.has_key?(:invite)

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

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