calendly 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f28a38b908de51d9f237545fcf0d59aab6a6d25747c2118b17529380c68c7918
-  data.tar.gz: 126bbd0048717b51f5c923e48b74928263eaa1f55865dc73ef790ee11f097133
+  metadata.gz: b3d543d9baf7e5b5670b90c64e9caef192f1ef4c04c77fe7fe7cd188e0f15f37
+  data.tar.gz: a438d7738b377173cefbc501099da081231ed4ffc51cb69425b8ddc569d03121
 SHA512:
-  metadata.gz: fad893cae7dbcbf7ab5c7d3aede8da1e7852885b3491eb65cad4ec7253a68d31655233d3308d00460a2a244756e7b4a7b31922381085f97c0e3229f775c50cc2
-  data.tar.gz: cc9aca55ae9c25bccb69a2a320526d449b2a5b70807bd47e4e4e1db5903ee2618b276065b400c0c60183a4625b82e04840a2620f6180e69577a841350806550c
+  metadata.gz: 178a1fcb7611cb0208b62240eb59b0da6db9a34f4a57cf146377e5f2cdb3119640cbbb20c9ce1ee452e22875a589a11cf2652629f2cb2a11a02f268565543344
+  data.tar.gz: 5a498df806931cf4aada531d804587ed601e05c14a1b0a52ee94ee13b6443a99290abb4b05c4d3f77a3e68ecda30f8c110ee076868c6d3522fb0612d053e2e38

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # 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

data/README.md

@@ -77,7 +77,7 @@ 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")
+event_type.available_times(start_time: '2022-08-04T10:30:00Z', end_time: '2022-08-05T10:30:00Z')
 
 #
 # get scheduled events

data/lib/calendly/client.rb

@@ -400,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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,6 +188,7 @@ 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
@@ -224,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.13.0
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.14.0
 post_install_message: 
 rdoc_options: []
 require_paths: