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.



1295
1296
1297
 
# File 'lib/platform-api/client.rb', line 1295

def initialize(client)
  @client = client
end

Instance Method Details

#finalize_invitation(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



1310
1311
1312
 
# File 'lib/platform-api/client.rb', line 1310

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

#info(invitation_token) ⇒ Object

Info for invitation.

Parameters:

  • invitation_token: —

    Unique identifier of an invitation



1302
1303
1304
 
# File 'lib/platform-api/client.rb', line 1302

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

#invitation(body = {}) ⇒ Object

Invite a user.

Parameters:

  • body: —

    the object to pass as the request payload



1317
1318
1319
 
# File 'lib/platform-api/client.rb', line 1317

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