knockapi 0.4.7 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 829d797080c6841ef0bda6f2e775e17d45f4c30c466f2b0e1b8ea2abb7e8602e
-  data.tar.gz: 34bfb3a3bcad22f326a3195d67f879d57e746c1eaef1bb8fd5be490a5eac1058
+  metadata.gz: 1fe65a30d36b287d6c125fa1a2dab2cc5203b46ed782c80f4b8c794a131d746d
+  data.tar.gz: 2af32dacf68a984235ae45d9bb2cf7e67c22849cbf2e063d8e56ec56aae1fb22
 SHA512:
-  metadata.gz: 8da11f98837db48e400a3387a081f2309fc7302029b592b6990293127302fd9c17c8c50747e6786943ede84a6cbda9b9496dce58cca25f8f603d016b844d4c8c
-  data.tar.gz: fc8224278dc1ef927eed734a5e55877d9d934a204a8cf22bd11b32ddeee3d04281bbff1195da500755fb1e248e30f30f28967d42e010f79da96ae4f53cbf3436
+  metadata.gz: 6a6ba784cd2ab7ff11d2d0412522703a19a8f49ffe623589e50262d4eed97f80b423afb5cb9338d57ad8c6959daf12abb3bc58a95451741742f01966576d51f1
+  data.tar.gz: 7e47f4c8bfdf1ca6192f4d35cefe57bbd08746147099b802bd66caefb1e48ffeee5d16f0256fb274907e8636685a25b1049dfb7d4f156c1bcad8c252cad1685f

data/.rubocop.yml

@@ -5,4 +5,4 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 35
 Metrics/ParameterLists:
-  Max: 6
+  Max: 7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    knockapi (0.4.7)
+    knockapi (0.4.9)
 
 GEM
   remote: https://rubygems.org/

data/lib/knock/client.rb

@@ -8,8 +8,9 @@ module Knock
     def client
       return @client if defined?(@client)
 
-      @client = Net::HTTP.new(Knock::API_HOSTNAME, 443)
-      @client.use_ssl = true
+      @client = Net::HTTP.new(Knock::API_HOSTNAME, 4001)
+      # @client = Net::HTTP.new(Knock::API_HOSTNAME, 443)
+      # @client.use_ssl = true
 
       @client
     end

data/lib/knock/objects.rb

@@ -29,6 +29,23 @@ module Knock
         execute_request(request: request)
       end
 
+      # Retrieves paginated objects in a collection for the provided environment
+      #
+      # @param [Hash] options Options to pass to the paginated users endpoint query.
+      # These include:
+      # - page_size: size of page to be returned (max: 50)
+      # - after:  after cursor for pagination
+      # - before: before cursor for pagination
+      def list(collection:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
       # Upserts an Object in a collection
       #
       # @param [String] collection The collection the object is in
@@ -312,6 +329,10 @@ module Knock
       # @param [String] collection The collection the object is in
       # @param [String] id The object id
       # @param [Hash] options Options to pass to the subscriptions endpoint
+      # These include:
+      # - page_size: size of page to be returned (max: 50)
+      # - after:  after cursor for pagination
+      # - before: before cursor for pagination
       #
       # @return [Hash] Paginated subscriptions response
       def list_subscriptions(collection:, id:, options: {})
@@ -358,6 +379,46 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Get object's schedules
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Hash] options Options to pass to the schedules endpoint query
+      #
+      # @return [Hash] Paginated schedules response
+      def get_schedules(collection:, id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/schedules",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get object's subscriptions as recipient
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Hash] options Options to pass to the subscriptions endpoint query
+      # These include:
+      # - page_size: size of page to be returned (max: 50)
+      # - after:  after cursor for pagination
+      # - before: before cursor for pagination
+      #
+      # @return [Hash] Paginated subscriptions response
+      def get_subscriptions(collection:, id:, options: {})
+        options[:mode] = 'recipient'
+
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/lib/knock/users.rb

@@ -45,6 +45,23 @@ module Knock
         execute_request(request: request)
       end
 
+      # Retrieves paginated users for the provided environment
+      #
+      # @param [Hash] options Options to pass to the paginated users endpoint query.
+      # These include:
+      # - page_size: size of page to be returned (max: 50)
+      # - after:  after cursor for pagination
+      # - before: before cursor for pagination
+      def list(options: {})
+        request = get_request(
+          auth: true,
+          path: '/v1/users',
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
       # Retrieves the given user
       #
       # @param [String] id The user ID
@@ -358,6 +375,46 @@ module Knock
 
         execute_request(request: request)
       end
+
+      ##
+      # Schedules
+      ##
+
+      # Get user's schedules
+      #
+      # @param [String] id the user ID
+      # @param [Hash] options Options to pass to the schedules endpoint query
+      #
+      # @return [Hash] Paginated schedules response
+      def get_schedules(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/users/#{id}/schedules",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      ##
+      # Subscriptions
+      ##
+
+      # Get user's subscriptions
+      #
+      # @param [String] id the user ID
+      # @param [Hash] options Options to pass to the subscriptions endpoint query
+      #
+      # @return [Hash] Paginated subscriptions response
+      def get_subscriptions(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/users/#{id}/subscriptions",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/lib/knock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knock
-  VERSION = '0.4.7'
+  VERSION = '0.4.9'
 end

data/lib/knock/workflows.rb

@@ -23,7 +23,7 @@ module Knock
       #  duplicate workflow invocations
       #
       # @return [Hash] A workflow trigger result
-      def trigger(key:, actor:, recipients:, data: {}, cancellation_key: nil, tenant: nil, idempotency_key: nil) # rubocop:disable Metrics/ParameterLists
+      def trigger(key:, actor:, recipients:, data: {}, cancellation_key: nil, tenant: nil, idempotency_key: nil)
         attrs = {
           actor: actor,
           recipients: recipients,
@@ -63,6 +63,91 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Creates schedule instances for all recipients for the given
+      # workflow.
+      #
+      # @param [String] key The workflow key
+      # @param [String, Hash] actor An optional actor identifier to be used when trigger the workflow
+      # @param [Array<String, Hash>] recipients The recipient identifiers
+      # @param [Array<Hash>] repeats The repeat rules for when to schedule the workflow run
+      # @param [Hash] data Parameters to be used as variables on the workflow run
+      # @param [String] tenant An optional tenant identifier
+
+      def create_schedules(key:, recipients:, repeats:, scheduled_at: nil, data: {}, actor: nil, tenant: nil)
+        attrs = {
+          workflow: key,
+          actor: actor,
+          recipients: recipients,
+          repeats: repeats,
+          data: data,
+          tenant: tenant,
+          scheduled_at: scheduled_at
+        }
+
+        request = post_request(
+          auth: true,
+          path: '/v1/schedules',
+          body: attrs
+        )
+
+        execute_request(request: request)
+      end
+
+      # Updates schedule instances with the attributes passed as params
+      #
+      # @param [Array<String>] schedule_ids The ids of the schedules to be updated
+      # @param [Hash] schedule_attrs The attributes to be used to update the schedules
+      #   Possible attributes: actor, repeats, data and tenant
+
+      def update_schedules(schedule_ids:, schedule_attrs:)
+        attrs = {
+          schedule_ids: schedule_ids
+        }
+
+        attrs = attrs.merge(schedule_attrs)
+
+        request = put_request(
+          auth: true,
+          path: '/v1/schedules',
+          body: attrs
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get paginated workflow schedules
+      #
+      # @param [String] key The workflow key
+      # @param [Hash] opts Options to filter the results: recipients, tenant and pagination params
+      def list_schedules(key:, opts: {})
+        attrs = opts.merge(workflow: key)
+
+        request = get_request(
+          auth: true,
+          path: '/v1/schedules',
+          params: attrs
+        )
+
+        execute_request(request: request)
+      end
+
+      # Delete schedule instances
+      #
+      # @param [Array<String>] schedule_ids The ids of the schedules to be deleted
+      def delete_schedules(schedule_ids:)
+        attrs = {
+          schedule_ids: schedule_ids
+        }
+
+        request = delete_request(
+          auth: true,
+          path: '/v1/schedules',
+          body: attrs
+        )
+
+        execute_request(request: request)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.9
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler