calendly 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e93c2dc16d8ea8b5c14d890394dbaf898935d1ac3bfa85d091056be51fc5e30
-  data.tar.gz: 49b3c47b087a73d2fb86e00e301daa7661bf0b5d0bf3014142806dd64006f9a5
+  metadata.gz: b3d543d9baf7e5b5670b90c64e9caef192f1ef4c04c77fe7fe7cd188e0f15f37
+  data.tar.gz: a438d7738b377173cefbc501099da081231ed4ffc51cb69425b8ddc569d03121
 SHA512:
-  metadata.gz: 5e1d557c0df74d1ab77237bbea0199c0771576d780fac4e91147ee06cdbf7d215536220ff643b3167f026437c04ba650368f810cc3d554425c05eeb817b71d9e
-  data.tar.gz: 69d38a1904609257682374b562d3c45fc3cba63fdfab4654c83fa1739c1bb14bbbfb308a8b9a2a3aa1fdda69263a8fde3cc12e0d857d518e5ef0587c2963a7d0
+  metadata.gz: 178a1fcb7611cb0208b62240eb59b0da6db9a34f4a57cf146377e5f2cdb3119640cbbb20c9ce1ee452e22875a589a11cf2652629f2cb2a11a02f268565543344
+  data.tar.gz: 5a498df806931cf4aada531d804587ed601e05c14a1b0a52ee94ee13b6443a99290abb4b05c4d3f77a3e68ecda30f8c110ee076868c6d3522fb0612d053e2e38

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## 0.14.0 - 2022-11-06
+
+- supported Activity Log API. (#59, thanks to Calendly gave us a sample JSON file)
+  - `GET /activity_log_entries`
+  - changed were followings:
+    - Client
+      - (Add method) activity_log_entries
+    - Organization model
+      - (Add method) activity_log_entries
+
+## 0.13.0 - 2022-08-03
+
+- supported List Event Type Available Times API. (#57)
+  - `GET /event_type_available_times`
+  - 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.
     #
@@ -370,6 +400,40 @@ module Calendly
       true
     end
 
+    #
+    # Returns a list of activity log entries.
+    #
+    # @param [String] org_uri Return activity log entries from the organization associated with this URI.
+    # @param [Hash] options the optional request parameters. Optional.
+    # @option options [Array<String>] :action The action(s) associated with the entries.
+    # @option options [Array<String>] :actor Return entries from the user(s) associated with the provided URIs.
+    # @option options [Integer] :count The number of rows to return.
+    # @option options [String] :max_occurred_at include entries that occurred prior to this time.
+    # @option options [String] :min_occurred_at Include entries that occurred after this time.
+    # @option options [Array<String>] :namespace The categories of the entries.
+    # @option options [String] :page_token The token to pass to get the next portion of the collection.
+    # @option options [String] :search_term Filters entries based on the search term.
+    # @option options [Array<String>] :sort Order results by the specified field and direction. List of {field}:{direction} values.
+    # @return [Array<Array<Calendly::ActivityLogEntry>, Hash, Hash>]
+    #  - [Array<Calendly::ActivityLogEntry>] log_entries
+    #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
+    #  - [Hash] raw_response
+    # @raise [Calendly::Error] if the org_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.14.0
+    def activity_log_entries(org_uri, options: nil)
+      check_not_empty org_uri, 'org_uri'
+
+      opts_keys = %i[action actor count max_occurred_at min_occurred_at namespace page_token search_term sort]
+      params = {organization: org_uri}
+      params = merge_options options, opts_keys, params
+      body = request :get, 'activity_log_entries', params: params
+
+      items = body[:collection] || []
+      log_entries = items.map { |item| ActivityLogEntry.new item, self }
+      [log_entries, next_page_params(body), body]
+    end
+
     #
     # Returns information about a user's organization membership
     #

data/lib/calendly/models/activity_log_entry.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's activity log entry model.
+  class ActivityLogEntry
+    include ModelUtils
+    UUID_RE = %r{\A#{Client::API_HOST}/activity_log_entries/(#{UUID_FORMAT})\z}.freeze
+    TIME_FIELDS = %i[occurred_at].freeze
+
+    def self.association
+      {
+        organization: Organization
+      }
+    end
+
+    # @return [String]
+    # unique id of the ActivityLogEntry object.
+    attr_accessor :uuid
+
+    # @return [String]
+    # Canonical reference (unique identifier) for the activity log entry.
+    attr_accessor :uri
+
+    # @return [Time]
+    # The date and time of the entry.
+    attr_accessor :occurred_at
+
+    # @return [Hash]
+    # The Calendly actor that took the action creating the activity log entry.
+    attr_accessor :actor
+
+    # @return [Hash]
+    attr_accessor :details
+
+    # @return [String]
+    attr_accessor :fully_qualified_name
+
+    # @return [String]
+    # The category associated with the entry.
+    attr_accessor :namespace
+
+    # @return [String]
+    # The action associated with the entry.
+    attr_accessor :action
+
+    # @return [Organization]
+    # The organization associated with the entry.
+    attr_accessor :organization
+  end
+end

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/organization.rb

@@ -193,5 +193,29 @@ module Calendly
       @cached_routing_forms = nil
       routing_forms options: options
     end
+
+    #
+    # Returns a list of activity log entries.
+    #
+    # @param [Hash] options the optional request parameters. Optional.
+    # @option options [Array<String>] :action The action(s) associated with the entries.
+    # @option options [Array<String>] :actor Return entries from the user(s) associated with the provided URIs.
+    # @option options [Integer] :count The number of rows to return.
+    # @option options [String] :max_occurred_at include entries that occurred prior to this time.
+    # @option options [String] :min_occurred_at Include entries that occurred after this time.
+    # @option options [Array<String>] :namespace The categories of the entries.
+    # @option options [String] :page_token The token to pass to get the next portion of the collection.
+    # @option options [String] :search_term Filters entries based on the search term.
+    # @option options [Array<String>] :sort Order results by the specified field and direction. List of {field}:{direction} values.
+    # @return [Array<Array<Calendly::ActivityLogEntry>, Hash, Hash>]
+    #  - [Array<Calendly::ActivityLogEntry>] log_entries
+    #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
+    #  - [Hash] raw_response
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.14.0
+    def activity_log_entries(options: nil)
+      client.activity_log_entries uri, options: options
+    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.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-16 00:00:00.000000000 Z
+date: 2022-11-06 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
@@ -174,8 +188,10 @@ files:
 - lib/calendly/configuration.rb
 - lib/calendly/error.rb
 - lib/calendly/loggable.rb
+- lib/calendly/models/activity_log_entry.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 +225,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.14.0
 post_install_message: 
 rdoc_options: []
 require_paths: