Class: PlatformAPI::OrganizationInvitation

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Deprecated: An organization invitation represents an invite to an organization.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OrganizationInvitation

Returns a new instance of OrganizationInvitation.



1989
1990
1991
 
# File 'lib/platform-api/client.rb', line 1989

def initialize(client)
  @client = client
end

Instance Method Details

#accept(organization_invitation_token) ⇒ Object

Accept Organization Invitation

Parameters:

  • organization_invitation_token: —

    Special token for invitation



2026
2027
2028
 
# File 'lib/platform-api/client.rb', line 2026

def accept(organization_invitation_token)
  @client.organization_invitation.accept(organization_invitation_token)
end

#create(organization_name_or_organization_id, body = {}) ⇒ Object

Create Organization Invitation

Parameters:

  • organization_name_or_organization_id: —

    unique name of organization or unique identifier of organization

  • body: —

    the object to pass as the request payload



2004
2005
2006
 
# File 'lib/platform-api/client.rb', line 2004

def create(organization_name_or_organization_id, body = {})
  @client.organization_invitation.create(organization_name_or_organization_id, body)
end

#get(organization_invitation_token) ⇒ Object

Get an invitation by its token

Parameters:

  • organization_invitation_token: —

    Special token for invitation



2019
2020
2021
 
# File 'lib/platform-api/client.rb', line 2019

def get(organization_invitation_token)
  @client.organization_invitation.get(organization_invitation_token)
end

#list(organization_name) ⇒ Object

Get a list of an organization's Identity Providers

Parameters:

  • organization_name: —

    unique name of organization



1996
1997
1998
 
# File 'lib/platform-api/client.rb', line 1996

def list(organization_name)
  @client.organization_invitation.list(organization_name)
end

#revoke(organization_name_or_organization_id, organization_invitation_id) ⇒ Object

Revoke an organization invitation.

Parameters:

  • organization_name_or_organization_id: —

    unique name of organization or unique identifier of organization

  • organization_invitation_id: —

    Unique identifier of an invitation



2012
2013
2014
 
# File 'lib/platform-api/client.rb', line 2012

def revoke(organization_name_or_organization_id, organization_invitation_id)
  @client.organization_invitation.revoke(organization_name_or_organization_id, organization_invitation_id)
end