calendly 0.5.2 → 0.6.0

data/lib/calendly/models/event_type_custom_question.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's custom question model.
+  class EventTypeCustomQuestion
+    include ModelUtils
+
+    # @return [String]
+    # The custom question that the host created for the event type.
+    attr_accessor :name
+
+    # @return [String]
+    # The type of response that the invitee provides to the custom question;
+    # can be one or multiple lines of text, a phone number, or single- or multiple-select.
+    attr_accessor :type
+
+    # @return [Integer]
+    # The numerical position of the question on the event booking page after the name and email address fields.
+    attr_accessor :position
+
+    # @return [Boolean]
+    # true if the question created by the host is turned ON and visible on the event booking page;
+    # false if turned OFF and invisible on the event booking page.
+    attr_accessor :enabled
+
+    # @return [Boolean]
+    # true if a response to the question created by the host is required for invitees to book the event type;
+    # false if not required.
+    attr_accessor :required
+
+    # @return [Array<String>]
+    # The invitee’s option(s) for single_select or multi_select type of responses.
+    attr_accessor :answer_choices
+
+    # @return [Boolean]
+    # true if the custom question lets invitees record a written response in addition to single-select or multiple-select type of responses;
+    # false if it doesn’t.
+    attr_accessor :include_other
+
+  private
+
+    def inspect_attributes
+      super + %i[enabled position]
+    end
+  end
+end

data/lib/calendly/models/event_type_profile.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's event type profile model.
+  class EventTypeProfile
+    include ModelUtils
+
+    # @return [String]
+    # Indicates if the profile belongs to a "user" (individual) or "team"
+    attr_accessor :type
+
+    # @return [String]
+    # Human-readable name for the profile of the user that's associated with the event type
+    attr_accessor :name
+
+    # @return [String]
+    # The unique reference to the user associated with the profile
+    attr_accessor :owner
+
+    # @return [User]
+    # The owner user if the profile belongs to a "user" (individual).
+    attr_accessor :owner_user
+
+    # @return [Team]
+    # The owner team if the profile belongs to a "team".
+    attr_accessor :owner_team
+
+    # whether type is user or not.
+    # @return [Boolean]
+    # @since 0.6.0
+    def type_user?
+      type&.downcase == 'user'
+    end
+
+    # whether type is team or not.
+    # @return [Boolean]
+    # @since 0.6.0
+    def type_team?
+      type&.downcase == 'team'
+    end
+
+  private
+
+    def after_set_attributes(attrs)
+      super attrs
+      if owner # rubocop:disable Style/GuardClause
+        @owner_user = User.new({uri: owner}, @client) if type_user?
+        @owner_team = Team.new({uri: owner}, @client) if type_team?
+      end
+    end
+  end
+end

data/lib/calendly/models/guest.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's guest model.
+  # Additional people added to an event by an invitee.
+  class Guest
+    include ModelUtils
+    TIME_FIELDS = %i[created_at updated_at].freeze
+
+    # @return [String]
+    attr_accessor :email
+
+    # @return [Time]
+    attr_accessor :created_at
+
+    # @return [Time]
+    attr_accessor :updated_at
+  end
+end

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