Class: PlatformAPI::Invitation

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

Overview

An invitation represents an invite sent to a user to use the Heroku platform.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Invitation

Returns a new instance of Invitation.



1569
1570
1571
 
# File 'lib/platform-api/client.rb', line 1569

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Invite a user.

Parameters:

  • body: —

    the object to pass as the request payload



1583
1584
1585
 
# File 'lib/platform-api/client.rb', line 1583

def create(body = {})
  @client.invitation.create(body)
end

#finalize(invitation_token, body = {}) ⇒ Object

Finalize Invitation and Create Account.

Parameters:

  • invitation_token: —

    Unique identifier of an invitation

  • body: —

    the object to pass as the request payload



1607
1608
1609
 
# File 'lib/platform-api/client.rb', line 1607

def finalize(invitation_token, body = {})
  @client.invitation.finalize(invitation_token, body)
end

#info(invitation_token) ⇒ Object

Info for invitation.

Parameters:

  • invitation_token: —

    Unique identifier of an invitation



1576
1577
1578
 
# File 'lib/platform-api/client.rb', line 1576

def info(invitation_token)
  @client.invitation.info(invitation_token)
end

#send_verification_code(invitation_token, body = {}) ⇒ Object

Send a verification code for an invitation via SMS/phone call.

Parameters:

  • invitation_token: —

    Unique identifier of an invitation

  • body: —

    the object to pass as the request payload



1591
1592
1593
 
# File 'lib/platform-api/client.rb', line 1591

def send_verification_code(invitation_token, body = {})
  @client.invitation.send_verification_code(invitation_token, body)
end

#verify(invitation_token, body = {}) ⇒ Object

Verify an invitation using a verification code.

Parameters:

  • invitation_token: —

    Unique identifier of an invitation

  • body: —

    the object to pass as the request payload



1599
1600
1601
 
# File 'lib/platform-api/client.rb', line 1599

def verify(invitation_token, body = {})
  @client.invitation.verify(invitation_token, body)
end