calendly 0.5.0 → 0.8.0

data/lib/calendly/models/invitee.rb

@@ -3,60 +3,99 @@
 require 'calendly/client'
 require 'calendly/models/model_utils'
 require 'calendly/models/event'
+require 'calendly/models/invitee_cancellation'
+require 'calendly/models/invitee_payment'
+require 'calendly/models/invitee_question_and_answer'
+require 'calendly/models/invitee_tracking'
 
 module Calendly
-  # Calendly's Invitee model.
+  # Calendly's invitee model.
   # An individual who has been invited to meet with a Calendly member.
   class Invitee
     include ModelUtils
     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
+    ASSOCIATION = {
+      event: Event,
+      cancellation: InviteeCancellation,
+      payment: InviteePayment,
+      questions_and_answers: InviteeQuestionAndAnswer,
+      tracking: InviteeTracking
+    }.freeze
 
     # @return [String]
     # unique id of the Invitee object.
     attr_accessor :uuid
+
     # @return [String]
     # Canonical resource reference.
     attr_accessor :uri
+
     # @return [String]
     # The invitee's email address.
     attr_accessor :email
+
     # @return [String]
     # The invitee's human-readable name.
     attr_accessor :name
+
+    # @return [String]
+    # The first name of the invitee who booked the event when the event type is configured to use separate fields for
+    # first name and last name. Null when event type is configured to use a single field for name.
+    attr_accessor :first_name
+
+    # @return [String]
+    # The last name of the invitee who booked the event when the event type is configured to use separate fields
+    # for first name and last name. Null when event type is configured to use a single field for name.
+    attr_accessor :last_name
+
     # @return [String]
     # Whether the invitee has canceled or is still active.
     attr_accessor :status
+
     # @return [String]
     # Timezone offest to use when presenting time information to invitee.
     attr_accessor :timezone
+
     # @return [String]
     # Text (SMS) reminder phone number.
     attr_accessor :text_reminder_number
+
     # @return [Boolean]
     # Indicates if this invitee has rescheduled.
     # If true, a reference to the new Invitee instance is provided in the new_invitee field.
     attr_accessor :rescheduled
+
     # @return [String, nil]
     # Reference to old Invitee instance that got rescheduled.
     attr_accessor :old_invitee
+
     # @return [String, nil]
     # Link to new invitee, after reschedule.
     attr_accessor :new_invitee
+
     # @return [String]
     # Link to cancelling the event for the invitee.
     attr_accessor :cancel_url
+
     # @return [String]
     # Link to rescheduling the event for the invitee.
     attr_accessor :reschedule_url
+
     # @return [Time]
     # Moment when user record was first created.
     attr_accessor :created_at
+
     # @return [Time]
     # Moment when user record was last updated.
     attr_accessor :updated_at
 
+    # @return [InviteeCancellation] Provides data pertaining to the cancellation of the Invitee.
+    attr_accessor :cancellation
+
+    # @return [InviteePayment] Invitee payment.
+    attr_accessor :payment
+
     # @return [Event]
     # Reference to Event associated with this invitee.
     attr_accessor :event
@@ -80,16 +119,5 @@ module Calendly
       ev_uuid = event.uuid if event
       client.event_invitee ev_uuid, uuid
     end
-
-  private
-
-    def after_set_attributes(attrs)
-      super attrs
-      answers = attrs[:questions_and_answers]
-      @questions_and_answers = answers.map { |ans| InviteeQuestionAndAnswer.new ans } if answers&.is_a? Array
-
-      trac_attrs = attrs[:tracking]
-      @tracking = InviteeTracking.new trac_attrs if trac_attrs&.is_a? Hash
-    end
   end
 end

data/lib/calendly/models/invitee_cancellation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's invitee cancellation model.
+  # Provides data pertaining to the cancellation of the Invitee.
+  class InviteeCancellation
+    include ModelUtils
+
+    # @return [String] Name of the person whom canceled.
+    attr_accessor :canceled_by
+
+    # @return [String] Reason that the cancellation occurred.
+    attr_accessor :reason
+  end
+end

data/lib/calendly/models/invitee_payment.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's invitee payment model.
+  class InviteePayment
+    include ModelUtils
+
+    # @return [String] Unique identifier for the payment.
+    attr_accessor :external_id
+
+    # @return [String] Payment provider.
+    attr_accessor :provider
+
+    # @return[Float] The amount of the payment.
+    attr_accessor :amount
+
+    # @return [String] The currency format that the payment is in.
+    attr_accessor :currency
+
+    # @return [String] Terms of the payment.
+    attr_accessor :terms
+
+    # @return [Boolean] Indicates whether the payment was successfully processed.
+    attr_accessor :successful
+  end
+end

data/lib/calendly/models/invitee_question_and_answer.rb

@@ -3,7 +3,7 @@
 require 'calendly/models/model_utils'
 
 module Calendly
-  # Calendly's InviteeQuestionAndAnswer model.
+  # Calendly's question and answer model.
   # An individual form question and response.
   class InviteeQuestionAndAnswer
     include ModelUtils
@@ -11,11 +11,19 @@ module Calendly
     # @return [String]
     # The question from the event booking confirmation form.
     attr_accessor :question
+
     # @return [String]
     # The answer supplied by the invitee to this question.
     attr_accessor :answer
+
     # @return [Integer]
     # The position of this question in the event booking confirmation form.
     attr_accessor :position
+
+  private
+
+    def inspect_attributes
+      super + %i[position question]
+    end
   end
 end

data/lib/calendly/models/invitee_tracking.rb

@@ -3,7 +3,7 @@
 require 'calendly/models/model_utils'
 
 module Calendly
-  # Calendly's InviteeTracking model.
+  # Calendly's invitee tracking model.
   # Object that represents UTM and Salesforce tracking parameters associated with the invitee.
   class InviteeTracking
     include ModelUtils
@@ -11,20 +11,31 @@ module Calendly
     # @return [String]
     # UTM campaign tracking parameter.
     attr_accessor :utm_campaign
+
     # @return [String]
     # UTM source tracking parameter.
     attr_accessor :utm_source
+
     # @return [String]
     # UTM medium tracking parameter.
     attr_accessor :utm_medium
+
     # @return [String]
     # UTM content tracking parameter.
     attr_accessor :utm_content
+
     # @return [String]
     # UTM term tracking parameter.
     attr_accessor :utm_term
+
     # @return [String]
     # Salesforce Record ID.
     attr_accessor :salesforce_uuid
+
+  private
+
+    def inspect_attributes
+      super + %i[utm_source utm_medium utm_campaign]
+    end
   end
 end

data/lib/calendly/models/invitees_counter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's invitees counter model.
+  class InviteesCounter
+    include ModelUtils
+
+    # @return [Integer] number of total invitees in this event.
+    attr_accessor :total
+
+    # @return [Integer] number of active invitees in this event.
+    attr_accessor :active
+
+    # @return [Integer] max invitees in this event.
+    attr_accessor :limit
+  end
+end

data/lib/calendly/models/location.rb

@@ -59,13 +59,23 @@ module Calendly
 
     # @return [String]
     attr_accessor :type
+
     # @return [String]
     attr_accessor :location
+
     # @return [String]
     attr_accessor :status
+
     # @return [String]
     attr_accessor :join_url
+
     # @return [Hash]
     attr_accessor :data
+
+  private
+
+    def inspect_attributes
+      super + %i[location]
+    end
   end
 end

data/lib/calendly/models/model_utils.rb

@@ -26,7 +26,7 @@ module Calendly
     end
 
     #
-    # alias of uuid.
+    # Alias of uuid.
     #
     # @return [String]
     # @raise [Calendly::Error] if uuid is not defined.
@@ -37,9 +37,20 @@ module Calendly
       uuid
     end
 
+    #
+    # Self object description human readable in CLI.
+    #
+    # @return [String]
+    # @since 0.0.1
     def inspect
-      description = "uuid:#{uuid}" if respond_to? :uuid
-      "\#<#{self.class}:#{object_id} #{description}>"
+      att_info = []
+      inspect_attributes.each do |att|
+        next unless respond_to? att
+
+        att_info << "#{att}=#{send(att).inspect}"
+      end
+      att_info << '..'
+      "\#<#{self.class}:#{object_id} #{att_info.join(', ')}>"
     end
 
     module ClassMethods
@@ -61,7 +72,7 @@ module Calendly
 
   private
 
-    def set_attributes(attrs) # rubocop:disable all
+    def set_attributes(attrs) # rubocop:disable Naming/AccessorMethodName, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       return if attrs.nil?
       return unless attrs.is_a? Hash
       return if attrs.empty?
@@ -70,8 +81,14 @@ module Calendly
         next unless respond_to? "#{key}=".to_sym
 
         if value && defined?(self.class::ASSOCIATION) && self.class::ASSOCIATION.key?(key)
-          associated_attrs = value.is_a?(Hash) ? value : {uri: value}
-          value = self.class::ASSOCIATION[key].new associated_attrs, @client
+          klass = self.class::ASSOCIATION[key]
+          if value.is_a? String # rubocop:disable Style/CaseLikeIf
+            value = klass.new({uri: value}, @client)
+          elsif value.is_a? Hash
+            value = klass.new(value, @client)
+          elsif value.is_a? Array
+            value = value.map { |v| klass.new(v, @client) }
+          end
         elsif value && defined?(self.class::TIME_FIELDS) && self.class::TIME_FIELDS.include?(key)
           value = Time.parse value
         end
@@ -102,5 +119,14 @@ module Calendly
       end
       items
     end
+
+    #
+    # Basic attributes used by inspect method.
+    #
+    # @return [Array<Symbol>]
+    # @since 0.6.0
+    def inspect_attributes
+      %i[uuid name type slug status email]
+    end
   end
 end

data/lib/calendly/models/organization.rb

@@ -12,6 +12,7 @@ module Calendly
     # @return [String]
     # unique id of the Organization object.
     attr_accessor :uuid
+
     # @return [String]
     # Canonical resource reference.
     attr_accessor :uri
@@ -19,52 +20,52 @@ module Calendly
     #
     # Get List memberships of all users belonging to self.
     #
-    # @param [Hash] opts the optional request parameters.
-    # @option opts [Integer] :count Number of rows to return.
-    # @option opts [String] :email Filter by email.
-    # @option opts [String] :page_token Pass this to get the next portion of collection.
+    # @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
-    def memberships(opts = {})
-      return @cached_memberships if @cached_memberships
+    def memberships(options: nil)
+      return @cached_memberships if defined?(@cached_memberships) && @cached_memberships
 
-      request_proc = proc { |options| client.memberships uri, options }
-      @cached_memberships = auto_pagination request_proc, opts
+      request_proc = proc { |opts| client.memberships uri, options: opts }
+      @cached_memberships = auto_pagination request_proc, options
     end
 
     # @since 0.2.0
-    def memberships!(opts = {})
+    def memberships!(options: nil)
       @cached_memberships = nil
-      memberships opts
+      memberships options: options
     end
 
     #
     # Get Organization Invitations.
     #
-    # @param [Hash] opts the optional request parameters.
-    # @option opts [Integer] :count Number of rows to return.
-    # @option opts [String] :email Filter by email.
-    # @option opts [String] :page_token Pass this to get the next portion of collection.
-    # @option opts [String] :sort Order results by the specified field and directin.
+    # @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 opts [String] :status Filter by status.
+    # @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
-    def invitations(opts = {})
-      return @cached_invitations if @cached_invitations
+    def invitations(options: nil)
+      return @cached_invitations if defined?(@cached_invitations) && @cached_invitations
 
-      request_proc = proc { |options| client.invitations uuid, options }
-      @cached_invitations = auto_pagination request_proc, opts
+      request_proc = proc { |opts| client.invitations uuid, options: opts }
+      @cached_invitations = auto_pagination request_proc, options
     end
 
     # @since 0.2.0
-    def invitations!(opts = {})
+    def invitations!(options: nil)
       @cached_invitations = nil
-      invitations opts
+      invitations options: options
     end
 
     #
@@ -80,58 +81,83 @@ module Calendly
       client.create_invitation uuid, email
     end
 
+    #
+    # 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
+    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
+
+    # @since 0.6.0
+    def event_types!(options: nil)
+      @cached_event_types = nil
+      event_types options: options
+    end
+
     #
     # Returns all Scheduled Events associated with self.
     #
-    # @param [Hash] opts the optional request parameters.
-    # @option opts [Integer] :count Number of rows to return.
-    # @option opts [String] :invitee_email Return events scheduled with the specified invitee email
-    # @option opts [String] :max_start_timeUpper bound (inclusive) for an event's start time to filter by.
-    # @option opts [String] :min_start_time Lower bound (inclusive) for an event's start time to filter by.
-    # @option opts [String] :page_token Pass this to get the next portion of collection.
-    # @option opts [String] :sort Order results by the specified field and directin.
+    # @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 opts [String] :status Whether the scheduled event is active or canceled
+    # @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
-    def scheduled_events(opts = {})
-      return @cached_scheduled_events if @cached_scheduled_events
+    def scheduled_events(options: nil)
+      return @cached_scheduled_events if defined?(@cached_scheduled_events) && @cached_scheduled_events
 
-      request_proc = proc { |options| client.scheduled_events uri, options }
-      @cached_scheduled_events = auto_pagination request_proc, opts
+      request_proc = proc { |opts| client.scheduled_events uri, options: opts }
+      @cached_scheduled_events = auto_pagination request_proc, options
     end
 
     # @since 0.5.0
-    def scheduled_events!(opts = {})
+    def scheduled_events!(options: nil)
       @cached_scheduled_events = nil
-      scheduled_events opts
+      scheduled_events options: options
     end
 
     #
     # Get List of organization scope Webhooks associated with self.
     #
-    # @param [Hash] opts the optional request parameters.
-    # @option opts [Integer] :count Number of rows to return.
-    # @option opts [String] :page_token Pass this to get the next portion of collection.
-    # @option opts [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values.
+    # @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
-    def webhooks(opts = {})
-      return @cached_webhooks if @cached_webhooks
+    def webhooks(options: nil)
+      return @cached_webhooks if defined?(@cached_webhooks) && @cached_webhooks
 
-      request_proc = proc { |options| client.webhooks uri, options }
-      @cached_webhooks = auto_pagination request_proc, opts
+      request_proc = proc { |opts| client.webhooks uri, options: opts }
+      @cached_webhooks = auto_pagination request_proc, options
     end
 
     # @since 0.2.0
-    def webhooks!(opts = {})
+    def webhooks!(options: nil)
       @cached_webhooks = nil
-      webhooks opts
+      webhooks options: options
     end
 
     #
@@ -139,14 +165,15 @@ module Calendly
     #
     # @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
-    def create_webhook(url, events)
-      client.create_webhook url, events, uri
+    def create_webhook(url, events, signing_key: nil)
+      client.create_webhook url, events, uri, signing_key: signing_key
     end
   end
 end