calendly 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb02343424c86dc7fbc58c8b0874382d824ae2e2dca791e1346138ccb4a0608
-  data.tar.gz: 4ed30818c3094ed630718fced80fb7eb78569299a363e6e7bfbd788807c279cd
+  metadata.gz: 987260a701999245159a34a38b587e873a80272a3391b5909339c7b6cd01994a
+  data.tar.gz: bb1b11aba44dcfca555b97887611cc989921a972263ea071e1ec144cac7d2bf6
 SHA512:
-  metadata.gz: b76d91932bf624dd4bb997da1197670843cbf84ec3d8de7b848ffacc8345434cf08b08886558c8d93bbf146d746f9e6d1b8e65c495d73633e72d3e517b6da6ba
-  data.tar.gz: f35b3781d1fc979fa3d8207a120bf9ca07bf85a9b6aa69faa7713d64deb26d8b332525cf768653e65dba6c17558a26db95ed74ca7accda8eeb2d316a134ff1bb
+  metadata.gz: 62d40c515e6833f34ef591b8b2a2a8089970951f6eae3fb68190388de58919a67c16851426f11c0c7c2b06bbc89f9de5248223ed2bd0d4b45fe45c11c0e232d7
+  data.tar.gz: 58136d311993b7b3a1e352888eba6756c7235476078934f2b8e893f06a29af33e36cefd3bdb751d8540948953c1cfdd145c1e160779cad2d3c554eff3f1ccc31

data/CHANGELOG.md

@@ -1,16 +1,48 @@
 # CHANGELOG
 
+## 0.5.2
+
+- started to support a API
+  - `POST /scheduling_links`
+
+## 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
 
-- fix changed Location fields such as `kind` to `type`. (refs #18)
+- 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
 
@@ -22,59 +54,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.
@@ -466,7 +512,7 @@ module Calendly
       else
         params[:scope] = 'organization'
       end
-      body = request(:post, 'webhook_subscriptions', body: params)
+      body = request :post, 'webhook_subscriptions', body: params
       WebhookSubscription.new body[:resource], self
     end
 
@@ -484,11 +530,42 @@ module Calendly
       true
     end
 
+    #
+    # Create a scheduling link.
+    #
+    # @param [String] uri A link to the resource that owns this scheduling Link.
+    # @param [String] max_event_count The max number of events that can be scheduled using this scheduling link.
+    # @param [String] resource_type Resource type.
+    # @return [Hash]
+    # e.g.
+    # {
+    #   booking_url: "https://calendly.com/s/FOO-BAR-SLUG",
+    #   owner: "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2",
+    #   owner_type: "EventType"
+    # }
+    # @raise [Calendly::Error] if the uri arg is empty.
+    # @raise [Calendly::Error] if the max_event_count arg is empty.
+    # @raise [Calendly::Error] if the resource_type arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.2
+    def create_schedule_link(uri, max_event_count = 1, resource_type: 'EventType')
+      check_not_empty uri, 'uri'
+      check_not_empty max_event_count, 'max_event_count'
+      check_not_empty resource_type, 'resource_type'
+      params = {
+        max_event_count: max_event_count,
+        owner: uri,
+        owner_type: resource_type
+      }
+      body = request :post, 'scheduling_links', body: params
+      body[:resource]
+    end
+
   private
 
     def request(method, path, params: nil, body: nil)
       debug_log "Request #{method.to_s.upcase} #{API_HOST}/#{path} params:#{params}, body:#{body}"
-      res = access_token.request(method, path, params: params, body: body)
+      res = access_token.request method, path, params: params, body: body
       debug_log "Response status:#{res.status}, body:#{res.body}"
       parse_as_json res
     rescue OAuth2::Error => e

data/lib/calendly/models/event_type.rb

@@ -75,6 +75,36 @@ 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
+
+    #
+    # Create an associated scheduling link.
+    #
+    # @param [String] max_event_count The max number of events that can be scheduled using this scheduling link.
+    # @return [Hash]
+    # e.g.
+    # {
+    #   booking_url: "https://calendly.com/s/FOO-BAR-SLUG",
+    #   owner: "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2",
+    #   owner_type: "EventType"
+    # }
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::Error] if the max_event_count arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.2
+    def create_schedule_link(max_event_count = 1)
+      client.create_schedule_link uri, max_event_count, resource_type: 'EventType'
+    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/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.4.0'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-21 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.4.0
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.5.2
 post_install_message: 
 rdoc_options: []
 require_paths: