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

#created_atTime

Moment when user record was first created.

Returns:

  • (Time)


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

def created_at
  @created_at
end

#emailString

The invitee’s email address.

Returns:

  • (String)


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

def email
  @email
end

#eventEvent

Reference to Event associated with this invitee.

Returns:



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

def event
  @event
end

#nameString

The invitee’s human-readable name.

Returns:

  • (String)


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

def name
  @name
end

#questions_and_answersArray<Calendly::InviteeQuestionAndAnswer>

A collection of form responses from the invitee.



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

def questions_and_answers
  @questions_and_answers
end

#statusString

Whether the invitee has canceled or is still active.

Returns:

  • (String)


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

def status
  @status
end

#text_reminder_numberString

Text (SMS) reminder phone number.

Returns:

  • (String)


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

def text_reminder_number
  @text_reminder_number
end

#timezoneString

Timezone offest to use when presenting time information to invitee.

Returns:

  • (String)


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

def timezone
  @timezone
end

#trackingCalendly::InviteeTracking



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

def tracking
  @tracking
end

#updated_atTime

Moment when user record was last updated.

Returns:

  • (Time)


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

def updated_at
  @updated_at
end

#uriString

Canonical resource reference.

Returns:

  • (String)


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

def uri
  @uri
end

#uuidString

unique id of the Invitee object.

Returns:

  • (String)


14
15
16
# File 'lib/calendly/models/invitee.rb', line 14

def uuid
  @uuid
end

Instance Method Details

#fetchCalendly::Invitee

Get Event Invitee associated with self.

Returns:

Raises:

Since:

  • 0.1.0



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

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