calendly 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e93c2dc16d8ea8b5c14d890394dbaf898935d1ac3bfa85d091056be51fc5e30
-  data.tar.gz: 49b3c47b087a73d2fb86e00e301daa7661bf0b5d0bf3014142806dd64006f9a5
+  metadata.gz: f28a38b908de51d9f237545fcf0d59aab6a6d25747c2118b17529380c68c7918
+  data.tar.gz: 126bbd0048717b51f5c923e48b74928263eaa1f55865dc73ef790ee11f097133
 SHA512:
-  metadata.gz: 5e1d557c0df74d1ab77237bbea0199c0771576d780fac4e91147ee06cdbf7d215536220ff643b3167f026437c04ba650368f810cc3d554425c05eeb817b71d9e
-  data.tar.gz: 69d38a1904609257682374b562d3c45fc3cba63fdfab4654c83fa1739c1bb14bbbfb308a8b9a2a3aa1fdda69263a8fde3cc12e0d857d518e5ef0587c2963a7d0
+  metadata.gz: fad893cae7dbcbf7ab5c7d3aede8da1e7852885b3491eb65cad4ec7253a68d31655233d3308d00460a2a244756e7b4a7b31922381085f97c0e3229f775c50cc2
+  data.tar.gz: cc9aca55ae9c25bccb69a2a320526d449b2a5b70807bd47e4e4e1db5903ee2618b276065b400c0c60183a4625b82e04840a2620f6180e69577a841350806550c

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.13.0 - 2022-08-03
+
+- supported List Event Type Available Times API. (#57)
+  - changed were followings:
+    - Client
+      - (Add method) event_type_available_times
+    - EventType model
+      - (Add method) available_times
+
 ## 0.12.0 - 2022-07-16
 
 - supported Routing Form APIs. (#55)

data/README.md

@@ -64,9 +64,21 @@ me.scheduling_url
 #
 event_types = me.event_types
 # => [#<Calendly::EventType uuid="ET001", name="15 Minute Meeting", type="StandardEventType", slug="15min", active=true, kind="solo", scheduling_url="https://calendly.com/foobar/15min", ..>, #<Calendly::EventType uuid="ET002", name="30 Minute Meeting", type="StandardEventType", slug="30min", active=true, kind="solo", scheduling_url="https://calendly.com/foobar/30min", ..>]
-event_types.first.scheduling_url
+
+event_type = event_types.first
+event_type.scheduling_url
 # => "https://calendly.com/foobar/15min"
 
+#
+# get available times for the event type
+#
+available_times = event_type.available_times
+available_times.map(&:start_time)
+# => [2022-08-04 01:00:00 UTC, 2022-08-04 01:15:00 UTC, 2022-08-04 01:30:00 UTC]
+
+# you can specify the date range
+event_type.available_times(start_time: "2022-08-04T10:30:00Z", end_time: "2022-08-05T10:30:00Z")
+
 #
 # get scheduled events
 #

data/calendly.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday', '>= 1.0.0', '< 3.0.0'
   spec.add_runtime_dependency 'oauth2', '~> 1.4', '>= 1.4.4'
 
+  spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'minitest'

data/lib/calendly/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'time'
 require 'oauth2'
 require 'calendly/loggable'
 
@@ -159,6 +160,35 @@ module Calendly
       [ev_types, next_page_params(body)]
     end
 
+    #
+    # Returns a list of available times for an event type within a specified date range.
+    # Date range can be no greater than 1 week (7 days).
+    #
+    # @param [String] event_type_uri The uri associated with the event type.
+    # @param [String] start_time Start time of the requested availability range.
+    # @param [String] end_time End time of the requested availability range.
+    # @return [Array<Calendly::EventTypeAvailableTime>] The set of available times for the event type matching the criteria.
+    # @raise [Calendly::Error] if the event_type_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.13.0
+    def event_type_available_times(event_type_uri, start_time: nil, end_time: nil)
+      check_not_empty event_type_uri, 'event_type_uri'
+
+      start_time_buffer = 60 # For working around an invalid request which be caused by specifying a past time
+      max_date_range = 60 * 60 * 24 * 7 # 7 days
+
+      # If start_time is undefined, set it to now.
+      start_time ||= (Time.now + start_time_buffer).utc.iso8601
+      # If end_time is undefined, set it to in the max date range from start_time.
+      end_time ||= (Time.parse(start_time) + max_date_range).utc.iso8601
+
+      params = {event_type: event_type_uri, start_time: start_time, end_time: end_time}
+      body = request :get, 'event_type_available_times', params: params
+
+      items = body[:collection] || []
+      items.map { |item| EventTypeAvailableTime.new item, self }
+    end
+
     #
     # Returns a single Event by its URI.
     #

data/lib/calendly/models/event_type.rb

@@ -118,6 +118,20 @@ module Calendly
       client.event_type uuid
     end
 
+    #
+    # Returns a list of available times for an event type within a specified date range.
+    # Date range can be no greater than 1 week (7 days).
+    #
+    # @param [String] start_time Start time of the requested availability range.
+    # @param [String] end_time End time of the requested availability range.
+    # @return [Array<Calendly::EventTypeAvailableTime>] The set of available times for the event type matching the criteria.
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.13.0
+    def available_times(start_time: nil, end_time: nil)
+      client.event_type_available_times uri, start_time: start_time, end_time: end_time
+    end
+
     #
     # Create an associated scheduling link.
     #

data/lib/calendly/models/event_type_available_type.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Calendly
+  # An available meeting time slot for the given event type.
+  class EventTypeAvailableTime
+    include ModelUtils
+    TIME_FIELDS = %i[start_time].freeze
+
+    # Indicates that the open time slot is "available".
+    # @return [String]
+    attr_accessor :status
+
+    # Total remaining invitees for this available time.
+    # For Group Event Type, more than one invitee can book in this available time.
+    # For all other Event Types, only one invitee can book in this available time.
+    # @return [Integer]
+    attr_accessor :invitees_remaining
+
+    # The moment the event was scheduled to start in UTC time.
+    # @return [Time]
+    attr_accessor :start_time
+
+    # The URL of the user’s scheduling site where invitees book this event type.
+    # @return [Time]
+    attr_accessor :scheduling_url
+
+  private
+
+    def inspect_attributes
+      super + %i[start_time invitees_remaining]
+    end
+  end
+end

data/lib/calendly/models/routing_form.rb

@@ -42,7 +42,7 @@ module Calendly
     # The URI of the organization that's associated with the routing form.
     attr_accessor :organization
 
-    # @return [Calendly::RoutingFormQuestion]
+    # @return [Array<Calendly::RoutingFormQuestion>]
     # An ordered collection of Routing Form non-deleted questions.
     attr_accessor :questions
 

data/lib/calendly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Calendly
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-16 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +190,7 @@ files:
 - lib/calendly/loggable.rb
 - lib/calendly/models/event.rb
 - lib/calendly/models/event_type.rb
+- lib/calendly/models/event_type_available_type.rb
 - lib/calendly/models/event_type_custom_question.rb
 - lib/calendly/models/event_type_profile.rb
 - lib/calendly/models/guest.rb
@@ -209,7 +224,7 @@ metadata:
   homepage_uri: https://github.com/koshilife/calendly-api-ruby-client
   source_code_uri: https://github.com/koshilife/calendly-api-ruby-client
   changelog_uri: https://github.com/koshilife/calendly-api-ruby-client/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/calendly/0.12.0
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.13.0
 post_install_message: 
 rdoc_options: []
 require_paths: