class Calendly::Organization

Calendly's organization model.

Constants

UUID_RE

Attributes

uri[RW]

@return [String] Canonical resource reference.

uuid[RW]

@return [String] unique id of the Organization object.

Public Instance Methods

create_invitation(email) click to toggle source

Invite a person to an Organization.

@param [String] email Email of the person being invited. @return [Calendly::OrganizationInvitation] @raise [Calendly::Error] if the uuid is empty. @raise [Calendly::Error] if the email is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.1.0

# File lib/calendly/models/organization.rb, line 80
def create_invitation(email)
  client.create_invitation uuid, email
end
create_webhook(url, events, signing_key: nil) click to toggle source

Create a user scope webhook associated with self.

@param [String] url Canonical reference (unique identifier) for the resource. @param [Array<String>] events List of user events to subscribe to. options: invitee.created or invitee.canceled @param [String] signing_key secret key shared between your application and Calendly. Optional. @return [Calendly::WebhookSubscription] @raise [Calendly::Error] if the url arg is empty. @raise [Calendly::Error] if the events arg is empty. @raise [Calendly::Error] if the uri is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.1.3

# File lib/calendly/models/organization.rb, line 175
def create_webhook(url, events, signing_key: nil)
  client.create_webhook url, events, uri, signing_key: signing_key
end
event_types(options: nil) click to toggle source

Returns all Event Types associated with self.

@param [Hash] options the optional request parameters. Optional. @option options [Integer] :count Number of rows to return. @option options [String] :page_token Pass this to get the next portion of collection. @option options [String] :sort Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. @return [Array<Calendly::EventType>] @raise [Calendly::Error] if the uri is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.6.0

# File lib/calendly/models/organization.rb, line 96
def event_types(options: nil)
  return @cached_event_types if defined?(@cached_event_types) && @cached_event_types

  request_proc = proc { |opts| client.event_types uri, options: opts }
  @cached_event_types = auto_pagination request_proc, options
end
event_types!(options: nil) click to toggle source

@since 0.6.0

# File lib/calendly/models/organization.rb, line 104
def event_types!(options: nil)
  @cached_event_types = nil
  event_types options: options
end
invitations(options: nil) click to toggle source

Get Organization Invitations.

@param [Hash] options the optional request parameters. Optional. @option options [Integer] :count Number of rows to return. @option options [String] :email Filter by email. @option options [String] :page_token Pass this to get the next portion of collection. @option options [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values. @option options [String] :status Filter by status. @return [Array<Calendly::OrganizationInvitation>] @raise [Calendly::Error] if the uuid is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.1.0

# File lib/calendly/models/organization.rb, line 58
def invitations(options: nil)
  return @cached_invitations if defined?(@cached_invitations) && @cached_invitations

  request_proc = proc { |opts| client.invitations uuid, options: opts }
  @cached_invitations = auto_pagination request_proc, options
end
invitations!(options: nil) click to toggle source

@since 0.2.0

# File lib/calendly/models/organization.rb, line 66
def invitations!(options: nil)
  @cached_invitations = nil
  invitations options: options
end
memberships(options: nil) click to toggle source

Get List memberships of all users belonging to self.

@param [Hash] options the optional request parameters. Optional. @option options [Integer] :count Number of rows to return. @option options [String] :email Filter by email. @option options [String] :page_token Pass this to get the next portion of collection. @return [Array<Calendly::OrganizationMembership>] @raise [Calendly::Error] if the uri is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.1.0

# File lib/calendly/models/organization.rb, line 31
def memberships(options: nil)
  return @cached_memberships if defined?(@cached_memberships) && @cached_memberships

  request_proc = proc { |opts| client.memberships uri, options: opts }
  @cached_memberships = auto_pagination request_proc, options
end
memberships!(options: nil) click to toggle source

@since 0.2.0

# File lib/calendly/models/organization.rb, line 39
def memberships!(options: nil)
  @cached_memberships = nil
  memberships options: options
end
scheduled_events(options: nil) click to toggle source

Returns all Scheduled Events associated with self.

@param [Hash] options the optional request parameters. Optional. @option options [Integer] :count Number of rows to return. @option options [String] :invitee_email Return events scheduled with the specified invitee email @option options [String] :max_start_timeUpper bound (inclusive) for an event's start time to filter by. @option options [String] :min_start_time Lower bound (inclusive) for an event's start time to filter by. @option options [String] :page_token Pass this to get the next portion of collection. @option options [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values. @option options [String] :status Whether the scheduled event is active or canceled @return [Array<Calendly::Event>] @raise [Calendly::Error] if the uri is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.5.0

# File lib/calendly/models/organization.rb, line 125
def scheduled_events(options: nil)
  return @cached_scheduled_events if defined?(@cached_scheduled_events) && @cached_scheduled_events

  request_proc = proc { |opts| client.scheduled_events uri, options: opts }
  @cached_scheduled_events = auto_pagination request_proc, options
end
scheduled_events!(options: nil) click to toggle source

@since 0.5.0

# File lib/calendly/models/organization.rb, line 133
def scheduled_events!(options: nil)
  @cached_scheduled_events = nil
  scheduled_events options: options
end
webhooks(options: nil) click to toggle source

Get List of organization scope Webhooks associated with self.

@param [Hash] options the optional request parameters. Optional. @option options [Integer] :count Number of rows to return. @option options [String] :page_token Pass this to get the next portion of collection. @option options [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values. Accepts comma-separated list of {field}:{direction} values. @return [Array<Calendly::WebhookSubscription>] @raise [Calendly::Error] if the uri is empty. @raise [Calendly::ApiError] if the api returns error code. @since 0.1.3

# File lib/calendly/models/organization.rb, line 150
def webhooks(options: nil)
  return @cached_webhooks if defined?(@cached_webhooks) && @cached_webhooks

  request_proc = proc { |opts| client.webhooks uri, options: opts }
  @cached_webhooks = auto_pagination request_proc, options
end
webhooks!(options: nil) click to toggle source

@since 0.2.0

# File lib/calendly/models/organization.rb, line 158
def webhooks!(options: nil)
  @cached_webhooks = nil
  webhooks options: options
end