Class: Calendly::Invitee

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

Overview

Calendly’s Invitee model. An individual who has been invited to meet with a Calendly member.

Constant Summary collapse

UUID_RE = 
%r{\A#{Client::API_HOST}/scheduled_events/\w+/invitees/(\w+)\z}.freeze
TIME_FIELDS = 
%i[created_at updated_at].freeze
ASSOCIATION = 
{event: Event}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ModelUtils

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

Instance Attribute Details

#cancel_url ⇒ String

Link to cancelling the event for the invitee.

Returns:

  • (String) 


49
50
51
 
# File 'lib/calendly/models/invitee.rb', line 49

def cancel_url
  @cancel_url
end

#created_at ⇒ Time

Moment when user record was first created.

Returns:

  • (Time) 


55
56
57
 
# File 'lib/calendly/models/invitee.rb', line 55

def created_at
  @created_at
end

#email ⇒ String

The invitee’s email address.

Returns:

  • (String) 


24
25
26
 
# File 'lib/calendly/models/invitee.rb', line 24

def email
  @email
end

#event ⇒ Event

Reference to Event associated with this invitee.

Returns:



62
63
64
 
# File 'lib/calendly/models/invitee.rb', line 62

def event
  @event
end

#name ⇒ String

The invitee’s human-readable name.

Returns:

  • (String) 


27
28
29
 
# File 'lib/calendly/models/invitee.rb', line 27

def name
  @name
end

#new_invitee ⇒ String?

Link to new invitee, after reschedule.

Returns:

  • (String, nil) 


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

def new_invitee
  @new_invitee
end

#old_invitee ⇒ String?

Reference to old Invitee instance that got rescheduled.

Returns:

  • (String, nil) 


43
44
45
 
# File 'lib/calendly/models/invitee.rb', line 43

def old_invitee
  @old_invitee
end

#questions_and_answers ⇒ Array<Calendly::InviteeQuestionAndAnswer>

A collection of form responses from the invitee.

Returns:



66
67
68
 
# File 'lib/calendly/models/invitee.rb', line 66

def questions_and_answers
  @questions_and_answers
end

#reschedule_url ⇒ String

Link to rescheduling the event for the invitee.

Returns:

  • (String) 


52
53
54
 
# File 'lib/calendly/models/invitee.rb', line 52

def reschedule_url
  @reschedule_url
end

#rescheduled ⇒ Boolean

Indicates if this invitee has rescheduled. If true, a reference to the new Invitee instance is provided in the new_invitee field.

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/calendly/models/invitee.rb', line 40

def rescheduled
  @rescheduled
end

#status ⇒ String

Whether the invitee has canceled or is still active.

Returns:

  • (String) 


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

def status
  @status
end

#text_reminder_number ⇒ String

Text (SMS) reminder phone number.

Returns:

  • (String) 


36
37
38
 
# File 'lib/calendly/models/invitee.rb', line 36

def text_reminder_number
  @text_reminder_number
end

#timezone ⇒ String

Timezone offest to use when presenting time information to invitee.

Returns:

  • (String) 


33
34
35
 
# File 'lib/calendly/models/invitee.rb', line 33

def timezone
  @timezone
end

#tracking ⇒ Calendly::InviteeTracking

Returns:



69
70
71
 
# File 'lib/calendly/models/invitee.rb', line 69

def tracking
  @tracking
end

#updated_at ⇒ Time

Moment when user record was last updated.

Returns:

  • (Time) 


58
59
60
 
# File 'lib/calendly/models/invitee.rb', line 58

def updated_at
  @updated_at
end

#uri ⇒ String

Canonical resource reference.

Returns:

  • (String) 


21
22
23
 
# File 'lib/calendly/models/invitee.rb', line 21

def uri
  @uri
end

#uuid ⇒ String

unique id of the Invitee object.

Returns:

  • (String) 


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

def uuid
  @uuid
end

Instance Method Details

#fetch ⇒ Calendly::Invitee

Get Event Invitee associated with self.

Returns:

Raises:

Since:

  • 0.1.0



79
80
81
82
 
# File 'lib/calendly/models/invitee.rb', line 79

def fetch
  ev_uuid = event.uuid if event
  client.event_invitee ev_uuid, uuid
end