calendly 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3656dc7886aad2a35932152a25f601d2160bed7f53b4ead91e67eb4cb82bb433
-  data.tar.gz: 337d5637a69e30e1dcc943ac1332f38b1675e3d55e0c09049d9308661b4edbe3
+  metadata.gz: 707a9cda35428975745f73c6c9b714bda1ec4bfd769f3b21cd66cf53e45e5eee
+  data.tar.gz: 8d249367bc1d6ffe766adf653f624ca4d15cf7c8fa4a51cca1a2329f3cbfbdeb
 SHA512:
-  metadata.gz: 32d0c18ebb375a99fb1b23b4365f99ba5957ebbbfed497690ef7d6db8bb0e0ada413853a927892963af62cc21afe39ad6f8d5740831af2e4e881fcc8e9bb5017
-  data.tar.gz: 81a59436778d27892dd325496bc234bea9380fba303b872a2d04ba6ea4b18d73b94d3a13133f7b90f2a68f19a994263ef464a60332239df3f61e064a6d116841
+  metadata.gz: 7685bb924251ccdaa0b93e4b95e43bd4ede147d2029ca83f1b2af1eff9f21e13a64b7acb88c5f63e1e8cfd84bcec8ba61fadbc7f577eaeb52e144ffa50fb4243
+  data.tar.gz: e01999d2785ebbe123ab08e63689a509ddf595433efa35b621c1d4e6bcdc94dea0b6df3fc87e2260147036cc9a85a85023c8c24e3bc6c8cd186cda16afcec92b

data/CHANGELOG.md

@@ -1,12 +1,43 @@
 # CHANGELOG
 
+## 0.5.1
+
+- added method EventType#fetch
+
+## 0.5.0
+
+- changed Calendly::Client#scheduled_events behavior (refs #21)
+  - previous version:
+    - getting events belonging to a specific USER
+  - current version:
+    - getting all events belonging to a specific ORGANIZATION
+- added Calendly::Client#scheduled_events_by_user method instead_of the before behavior
+
+## 0.4.2
+
+- added new following fields to Invitee model (refs #21)
+  - :rescheduled
+  - :old_invitee
+  - :new_invitee
+  - :cancel_url
+  - :reschedule_url
+
+## 0.4.1
+
+- started to support a API
+  - `GET /event_types/{uuid}`
+
+## 0.4.0
+
+- fixed a changes for Location fields such as `kind` to `type`. (refs #18)
+
 ## 0.3.0
 
-- remove zeitwerk dependency. (refs #16)
+- removed zeitwerk dependency. (refs #16)
 
 ## 0.2.0
 
-- save fetched data in cache. (refs #14)
+- added caching features in object when fetching data. (refs #14)
 
 ## 0.1.3
 
@@ -18,59 +49,59 @@
 
 ## 0.1.2
 
-- fix rubocop warnings.
+- fixed rubocop warnings.
 
 ## 0.1.1
 
-- add tests to make coverage 100%.
+- added tests to make coverage 100%.
 
 ## 0.1.0
 
-- define methods to access associated resources with each model.
-- rename methods:
+- defined methods to access associated resources with each model.
+- renamed methods:
   - `Calendly::Client#events` to `Calendly::Client#scheduled_events`
 
 ## 0.0.7.alpha
 
-- support APIs
+- started to support APIs
   - `POST /organizations/{uuid}/invitations`
   - `DELETE /organizations/{org_uuid}/invitations/{invitation_uuid}`
   - `DELETE /organization_memberships/{uuid}`
 
 ## 0.0.6.alpha
 
-- support APIs
+- started to support APIs
   - `GET /organizations/{uuid}/invitations`
   - `GET /organizations/{organization_uuid}/invitations/{invitation_uuid}`
 
 ## 0.0.5.alpha
 
-- support APIs
+- started to support APIs
   - `GET /organization_memberships`
   - `GET /organization_memberships/{uuid}`
-- rename fields
+- renamed fields
   - Invitee#event to Invitee#event_uri
   - Event#event_type to Event#event_type_uri
 
 ## 0.0.4.alpha
 
-- support APIs
+- started to support APIs
   - `GET /scheduled_events/{event_uuid}/invitees`
   - `GET /scheduled_events/{event_uuid}/invitees/{invitee_uuid}`
 
 ## 0.0.3.alpha
 
-- support APIs
+- started to support APIs
   - `GET /scheduled_events`
   - `GET /scheduled_events/{uuid}`
 
 ## 0.0.2.alpha
 
-- support APIs
+- started to support APIs
   - `GET /event_types`
 
 ## 0.0.1.alpha
 
 - Initial release
-- support APIs
+- started to support a API
   - `GET /users/{uuid}`

data/lib/calendly/client.rb

@@ -88,6 +88,20 @@ module Calendly
       User.new body[:resource], self
     end
 
+    #
+    # Returns a single Event Type by its UUID.
+    #
+    # @param [String] uuid the specified event type (event type's uuid).
+    # @return [Calendly::EventType]
+    # @raise [Calendly::Error] if the uuid arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.4.1
+    def event_type(uuid)
+      check_not_empty uuid, 'uuid'
+      body = request :get, "event_types/#{uuid}"
+      EventType.new body[:resource], self
+    end
+
     #
     # Returns all Event Types associated with a specified User.
     #
@@ -130,10 +144,42 @@ module Calendly
     end
 
     #
-    # Get List of User Events.
+    # Get List of scheduled events belonging to a specific organization.
+    #
+    # @param [String] org_uri the specified organization (organization's uri).
+    # @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_time Upper 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. Accepts comma-separated list of {field}:{direction} values.
+    # @option opts [String] :status Whether the scheduled event is active or canceled.
+    # @return [Array<Array<Calendly::Event>, Hash>]
+    #  - [Array<Calendly::Event>] events
+    #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
+    # @raise [Calendly::Error] if the org_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.0
+    def scheduled_events(org_uri, opts = {})
+      check_not_empty org_uri, 'org_uri'
+
+      opts_keys = %i[count invitee_email max_start_time min_start_time page_token sort status]
+      params = {organization: org_uri}
+      params = merge_options opts, opts_keys, params
+      body = request :get, 'scheduled_events', params: params
+
+      items = body[:collection] || []
+      evs = items.map { |item| Event.new item, self }
+      [evs, next_page_params(body)]
+    end
+
+    #
+    # Get List of scheduled events belonging to a specific user.
     #
     # @param [String] user_uri the specified user (user's uri).
     # @param [Hash] opts the optional request parameters.
+    # @option opts [String] :organization the specified organization (organization's uri).
     # @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_time Upper bound (inclusive) for an event's start time to filter by.
@@ -147,10 +193,10 @@ module Calendly
     # @raise [Calendly::Error] if the user_uri arg is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.0.3
-    def scheduled_events(user_uri, opts = {})
+    def scheduled_events_by_user(user_uri, opts = {})
       check_not_empty user_uri, 'user_uri'
 
-      opts_keys = %i[count invitee_email max_start_time min_start_time page_token sort status]
+      opts_keys = %i[organization count invitee_email max_start_time min_start_time page_token sort status]
       params = {user: user_uri}
       params = merge_options opts, opts_keys, params
       body = request :get, 'scheduled_events', params: params
@@ -221,7 +267,7 @@ module Calendly
     end
 
     #
-    # Get List memberships of all users belonging to an organization.
+    # Get List of memberships belonging to specific an organization.
     #
     # @param [String] org_uri the specified organization (organization's uri).
     # @param [Hash] opts the optional request parameters.
@@ -248,7 +294,7 @@ module Calendly
     end
 
     #
-    # Get List memberships of all users belonging to an organization by user.
+    # Get List of memberships belonging to specific a user.
     #
     # @param [String] user_uri the specified user (user's uri).
     # @param [Hash] opts the optional request parameters.

data/lib/calendly/models/event_type.rb

@@ -75,6 +75,17 @@ module Calendly
     # Whether the profile belongs to a “User” or a “Team”.
     attr_accessor :owner_type
 
+    #
+    # Get EventType associated with self.
+    #
+    # @return [Calendly::EventType]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.1
+    def fetch
+      client.event_type uuid
+    end
+
   private
 
     def after_set_attributes(attrs)

data/lib/calendly/models/invitee.rb

@@ -34,6 +34,22 @@ module Calendly
     # @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

data/lib/calendly/models/location.rb

@@ -4,51 +4,67 @@ require 'calendly/models/model_utils'
 
 module Calendly
   # Calendly's location model.
-  # Polymorphic base type for the various supported meeting locations.
+  # The polymorphic base type for an event location that Calendly supports
   class Location
     include ModelUtils
 
+    #
     # data patterns is below:
-    # - 1. A meeting at a pre-specified physical location
-    #  - [String] :kind
-    #  - [String] :location A physical location specified by the meeting publisher.
-    # - 2. Meeting publisher will call the invitee
-    #  - [String] :kind
-    # - 3. Invitee will call meeting publisher at the specified phone number.
-    #  - [String] :kind
-    #  - [String] :phone_number Phone number invitee should use to reach meeting publisher.
-    # - 4. Meeting will take place in a Google Meet / Hangout conference.
-    #  - [String] :kind
-    # - 5. Meeting will take place in a Zoom conference.
-    #  - [String] :kind
-    # - 6. Meeting will take place in a GotoMeeting conference.
-    #  - [String] :kind
-    #  - [String] :external_id Zoom-supplied conference id.
-    #  - [String] :state Current state of the conference in Zoom.
-    #  - [Hash] :data Arbitrary conference metadata supplied by Zoom.
-    # - 7. Arbitrary conference metadata supplied by GotoMeeting.
-    #  - [String] :kind
-    #  - [String] :external_id GotoMeeting-supplied conference id.
-    #  - [String] :state Current state of the conference in GotoMeeting.
-    #  - [String] :data Arbitrary conference metadata supplied by GotoMeeting.
-    # - 8. Meeting location does not fall in a standard category, and is as described by the meeting publisher.
-    #  - [String] :kind
-    #  - [String] :location Location description provided by meeting publisher.
-    # - 9. Meeting location was specified by invitee.
-    #  - [String] :kind
-    #  - [String] :location Meeting location was specified by invitee.
+    #
+    # 1. In-Person Meeting: Information about the physical (in-person) event location.
+    # @param [String] type Indicates that the event host (publisher) will call the invitee.
+    # @param [String] location The physical location specified by the event host (publisher).
+    #
+    # 2. Outbound Call: Meeting publisher will call the Invitee
+    # @param [String] type Indicates that the event host (publisher) will call the invitee.
+    # @param [String] location The phone number the event host (publisher) will use to call the invitee.
+    #
+    # 3. Inbound Call: Invitee will call meeting publisher at the specified phone number.
+    # @param [String] type Indicates that the invitee will call the event host.
+    # @param [String] location The phone number the invitee will use to call the event host (publisher).
+    #
+    # 4. Google Conference: Details about an Event that will take place using a Google Meet / Hangout conference.
+    # @param [String] type The event location is a Google Meet or Hangouts conference.
+    # @param [String] status Indicates the current status of the Google conference.
+    # @param [String] join_url Google conference meeting url.
+    #
+    # 5. Zoom Conference: Meeting will take place in a Zoom conference.
+    # @param [String] type The event location is a Zoom conference
+    # @param [String] status Indicates the current status of the Zoom conference.
+    # @param [String] join_url Zoom meeting url.
+    # @param [Hash] data The conference metadata supplied by Zoom.
+    #
+    # 6. GoToMeeting Conference: Details about an Event that will take place using a GotoMeeting conference
+    # @param [String] type The event location is a GoToMeeting conference.
+    # @param [String] status Indicates the current status of the GoToMeeting conference.
+    # @param [String] join_url GoToMeeting conference meeting url.
+    # @param [Hash] data The conference metadata supplied by GoToMeeting.
+    #
+    # 7. Microsoft Teams Conference:
+    # @param [String] type The event location is a Zoom conference.
+    # @param [String] status Indicates the current status of the Microsoft Teams conference.
+    # @param [String] join_url Microsoft Teams meeting url.
+    # @param [Hash] data The conference metadata supplied by Microsoft Teams.
+    #
+    # 8. Custom Location:
+    # Use this to describe an existing Calendly-supported event location.
+    # @param [String] type The event location doesn't fall into a standard category defined by the event host (publisher).
+    # @param [String] location The event location description provided by the invitee.
+    #
+    # 9. Invitee Specified Location:
+    # Information about an event location that’s specified by the invitee.
+    # @param [String] type The event location selected by the invitee.
+    # @param [String] location The event location description provided by the invitee.
     #
 
     # @return [String]
-    attr_accessor :kind
+    attr_accessor :type
     # @return [String]
     attr_accessor :location
     # @return [String]
-    attr_accessor :phone_number
-    # @return [String]
-    attr_accessor :external_id
+    attr_accessor :status
     # @return [String]
-    attr_accessor :state
+    attr_accessor :join_url
     # @return [Hash]
     attr_accessor :data
   end

data/lib/calendly/models/organization.rb

@@ -80,6 +80,35 @@ module Calendly
       client.create_invitation uuid, email
     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.
+    # Accepts comma-separated list of {field}:{direction} values.
+    # @option opts [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
+
+      request_proc = proc { |options| client.scheduled_events uri, options }
+      @cached_scheduled_events = auto_pagination request_proc, opts
+    end
+
+    # @since 0.5.0
+    def scheduled_events!(opts = {})
+      @cached_scheduled_events = nil
+      scheduled_events opts
+    end
+
     #
     # Get List of organization scope Webhooks associated with self.
     #

data/lib/calendly/models/user.rb

@@ -116,7 +116,7 @@ module Calendly
     def scheduled_events(opts = {})
       return @cached_scheduled_events if @cached_scheduled_events
 
-      request_proc = proc { |options| client.scheduled_events uri, options }
+      request_proc = proc { |options| client.scheduled_events_by_user uri, options }
       @cached_scheduled_events = auto_pagination request_proc, opts
     end
 

data/lib/calendly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -154,7 +154,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.3.0
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.5.1
 post_install_message: 
 rdoc_options: []
 require_paths: