Class: Calendly::OrganizationMembership

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

Overview

Calendly’s organization membership model.

Constant Summary collapse

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

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) 


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

def created_at
  @created_at
end

#organization ⇒ Organization

Reference to Organization associated with this membership.

Returns:



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

def organization
  @organization
end

#role ⇒ String

User’s role within the organization

Returns:

  • (String) 


19
20
21
 
# File 'lib/calendly/models/organization_membership.rb', line 19

def role
  @role
end

#updated_at ⇒ Time

Moment when user record was last updated.

Returns:

  • (Time) 


25
26
27
 
# File 'lib/calendly/models/organization_membership.rb', line 25

def updated_at
  @updated_at
end

#uri ⇒ String

Canonical resource reference.

Returns:

  • (String) 


16
17
18
 
# File 'lib/calendly/models/organization_membership.rb', line 16

def uri
  @uri
end

#user ⇒ Calendly::User

Primary account details of a specific user.

Returns:



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

def user
  @user
end

#uuid ⇒ String

unique id of the OrganizationMembership object.

Returns:

  • (String) 


13
14
15
 
# File 'lib/calendly/models/organization_membership.rb', line 13

def uuid
  @uuid
end

Instance Method Details

#create_user_scope_webhook(url, events) ⇒ Calendly::WebhookSubscription

Create a user scope webhook associated with self.

Parameters:

  • url (String) —

    Canonical reference (unique identifier) for the resource.

  • events (Array<String>) —

    List of user events to subscribe to. options: invitee.created or invitee.canceled

Returns:

Raises:

Since:

  • 0.1.3



95
96
97
98
99
 
# File 'lib/calendly/models/organization_membership.rb', line 95

def create_user_scope_webhook(url, events)
  org_uri = organization.uri if organization
  user_uri = user.uri if user
  client.create_webhook url, events, org_uri, user_uri
end

#delete ⇒ Object

Remove self from associated Organization.

Raises:

Since:

  • 0.1.0



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

def delete
  client.delete_membership uuid
end

#fetch ⇒ Calendly::OrganizationMembership

Get Organization Membership associated with self.

Returns:

Raises:

Since:

  • 0.1.0



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

def fetch
  client.membership uuid
end

#user_scope_webhooks(opts = {}) ⇒ Array<Calendly::WebhookSubscription>

Get List of user scope Webhooks associated with self.

Accepts comma-separated list of field:direction values.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional request parameters.

Options Hash (opts):

  • :count (Integer) —

    Number of rows to return.

  • :page_token (String) —

    Pass this to get the next portion of collection.

  • :sort (String) —

    Order results by the specified field and directin. Accepts comma-separated list of field:direction values.

Returns:

Raises:

Since:

  • 0.1.3



69
70
71
72
73
74
75
76
 
# File 'lib/calendly/models/organization_membership.rb', line 69

def user_scope_webhooks(opts = {})
  return @cached_user_scope_webhooks if @cached_user_scope_webhooks

  org_uri = organization.uri if organization
  user_uri = user.uri if user
  request_proc = proc { |options| client.user_scope_webhooks org_uri, user_uri, options }
  @cached_user_scope_webhooks = auto_pagination request_proc, opts
end

#user_scope_webhooks!(opts = {}) ⇒ Object

Since:

  • 0.2.0



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

def user_scope_webhooks!(opts = {})
  @cached_user_scope_webhooks = nil
  user_scope_webhooks opts
end