Class: Calendly::WebhookSubscription

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

Overview

Calendly’s webhook model.

Constant Summary collapse

UUID_RE = 
%r{\A#{Client::API_HOST}/webhook_subscriptions/(\w+)\z}.freeze
TIME_FIELDS = 
%i[created_at updated_at retry_started_at].freeze
ASSOCIATION = 
{organization: Organization, user: User, creator: User}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ModelUtils

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

Instance Attribute Details

#callback_url ⇒ String

The callback URL to use when the event is triggered.

Returns:

  • (String) 


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

def callback_url
  @callback_url
end

#created_at ⇒ Time

The moment when the webhook subscription was created.

Returns:

  • (Time) 


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

def created_at
  @created_at
end

#creator ⇒ Calendly::User

The user who created the webhook subscription.

Returns:



51
52
53
 
# File 'lib/calendly/models/webhook_subscription.rb', line 51

def creator
  @creator
end

#events ⇒ Array<String>

A list of events to which the webhook is subscribed.

Returns:

  • (Array<String>) 


39
40
41
 
# File 'lib/calendly/models/webhook_subscription.rb', line 39

def events
  @events
end

#organization ⇒ Calendly::Organization

The organization that’s associated with the webhook subscription.

Returns:



45
46
47
 
# File 'lib/calendly/models/webhook_subscription.rb', line 45

def organization
  @organization
end

#retry_started_at ⇒ Time

The date and time the webhook subscription is retried.

Returns:

  • (Time) 


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

def retry_started_at
  @retry_started_at
end

#scope ⇒ String

The scope of the webhook subscription.

Returns:

  • (String) 


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

def scope
  @scope
end

#state ⇒ String

Indicates if the webhook subscription is “active” or “disabled”.

Returns:

  • (String) 


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

def state
  @state
end

#updated_at ⇒ Time

The moment when the webhook subscription was last updated.

Returns:

  • (Time) 


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

def updated_at
  @updated_at
end

#uri ⇒ String

Canonical reference (unique identifier) for the webhook.

Returns:

  • (String) 


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

def uri
  @uri
end

#user ⇒ Calendly::User

The user that’s associated with the webhook subscription.

Returns:



48
49
50
 
# File 'lib/calendly/models/webhook_subscription.rb', line 48

def user
  @user
end

#uuid ⇒ String

unique id of the WebhookSubscription object.

Returns:

  • (String) 


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

def uuid
  @uuid
end

Instance Method Details

#delete ⇒ true

Delete a webhook subscription associated with self.

Returns:

  • (true)

Raises:

Since:

  • 0.1.0



71
72
73
 
# File 'lib/calendly/models/webhook_subscription.rb', line 71

def delete
  client.delete_webhook uuid
end

#fetch ⇒ Calendly::WebhookSubscription

Get a webhook subscription associated with self.

Returns:

Raises:

Since:

  • 0.1.3



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

def fetch
  client.webhook uuid
end