Class: Calendly::OrganizationInvitation

Inherits:
Object
  • Object
show all
Includes:
ModelUtils
Defined in:
lib/calendly/models/organization_invitation.rb

Overview

Calendly’s organization invitation model.

Constant Summary collapse

UUID_RE = 
%r{\A#{Client::API_HOST}/organizations/#{UUID_FORMAT}/invitations/(#{UUID_FORMAT})\z}.freeze
TIME_FIELDS = 
i[created_at updated_at last_sent_at].freeze
ASSOCIATION = 
{user: User, organization: Organization}.freeze

Constants included from ModelUtils

ModelUtils::UUID_FORMAT

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ModelUtils

#client, #id, included, #initialize, #inspect

Instance Attribute Details

#created_at ⇒ Time

Moment when user record was first created.

Returns:

  • (Time) 


34
35
36
 
# File 'lib/calendly/models/organization_invitation.rb', line 34

def created_at
  @created_at
end

#email ⇒ String

Invited person’s email.

Returns:

  • (String) 


26
27
28
 
# File 'lib/calendly/models/organization_invitation.rb', line 26

def email
  @email
end

#last_sent_at ⇒ Time

Moment when the last invitation was sent.

Returns:

  • (Time) 


42
43
44
 
# File 'lib/calendly/models/organization_invitation.rb', line 42

def last_sent_at
  @last_sent_at
end

#organization ⇒ Organization

Reference to Organization associated with this invitation.

Returns:



46
47
48
 
# File 'lib/calendly/models/organization_invitation.rb', line 46

def organization
  @organization
end

#status ⇒ String

Invitation status.

Returns:

  • (String) 


30
31
32
 
# File 'lib/calendly/models/organization_invitation.rb', line 30

def status
  @status
end

#updated_at ⇒ Time

Moment when user record was last updated.

Returns:

  • (Time) 


38
39
40
 
# File 'lib/calendly/models/organization_invitation.rb', line 38

def updated_at
  @updated_at
end

#uri ⇒ String

Canonical resource reference.

Returns:

  • (String) 


22
23
24
 
# File 'lib/calendly/models/organization_invitation.rb', line 22

def uri
  @uri
end

#user ⇒ User

If a person accepted the invitation, a reference to their User.

Returns:



50
51
52
 
# File 'lib/calendly/models/organization_invitation.rb', line 50

def user
  @user
end

#uuid ⇒ String

unique id of the OrganizationInvitation object.

Returns:

  • (String) 


18
19
20
 
# File 'lib/calendly/models/organization_invitation.rb', line 18

def uuid
  @uuid
end

Instance Method Details

#delete ⇒ true

Revoke self Invitation.

Returns:

  • (true)

Raises:

Since:

  • 0.1.0



73
74
75
76
 
# File 'lib/calendly/models/organization_invitation.rb', line 73

def delete
  org_uuid = organization.uuid if organization
  client.delete_invitation org_uuid, uuid
end

#fetch ⇒ Calendly::OrganizationInvitation

Get Organization Invitation associated with self.

Returns:

Raises:

Since:

  • 0.1.0



60
61
62
63
 
# File 'lib/calendly/models/organization_invitation.rb', line 60

def fetch
  org_uuid = organization.uuid if organization
  client.invitation org_uuid, uuid
end