knockapi 0.4.8 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f76a1fe37f883f760b872f6b52bafb40e22a870f650fb0c4cc5b40e85912888c
-  data.tar.gz: 7dc8c721a049b9b3a25ff67db18dc9cdca1e551f1bbcdddbf025305f6b23e582
+  metadata.gz: 4beed298674955de29028de2c873e1ca06c6985ed1a39616002acdc6eff25c1f
+  data.tar.gz: f8917065b45cb5e3fb5bda5c695adcc2920b1a81f6b87350f2290c8931196196
 SHA512:
-  metadata.gz: 38e0c87a2c2e4fe46c1cc80c9a7707e1b26416f682a5de387f8725afa0e9a9599a9ee35b0b57e693b1a37897d2cf5e132c75595304497281f4b014e350946ef5
-  data.tar.gz: 4a3be25fd78f03bc7605fea581486950639ea333c819828e1859e30d94ea8f0e42d00807a5076ba9d97db508c48e08163dbe81f694adc49517401028b8f582f2
+  metadata.gz: '06358ec03b771befae371a2593af671d5722333cfe49b0e50366b86cad6a5ba3924e650e44064d152ea976251422c90092cfb8fd0bcf1303f5b46ba781f79f75'
+  data.tar.gz: 5153f8795549916a076b33f0650a15206f832f6415d71ea4b1737e0f713af5f28151538633f883f9f34410b3f078b4b0dadbdf27128403b3ec39ce668a5dbf5b

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile.lock

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

data/README.md

@@ -34,7 +34,7 @@ Knock.key = 'sk_12345'
 ### Identifying users
 
 ```ruby
-require "knockapi"
+require "knock"
 
 Knock.key = "sk_12345"
 
@@ -50,7 +50,7 @@ Knock::Users.identify(
 ### Sending notifies (triggering workflows)
 
 ```ruby
-require "knockapi"
+require "knock"
 
 Knock.key = "sk_12345"
 
@@ -74,7 +74,7 @@ Knock::Workflows.trigger(
 ### Retrieving users
 
 ```ruby
-require "knockapi"
+require "knock"
 
 Knock.key = "sk_12345"
 
@@ -84,7 +84,7 @@ Knock::Users.get(id: "jhammond")
 ### Deleting users
 
 ```ruby
-require "knockapi"
+require "knock"
 
 Knock.key = "sk_12345"
 
@@ -94,7 +94,7 @@ Knock::Users.delete(id: "jhammond")
 ### Preferences
 
 ```ruby
-require "knockapi"
+require "knock"
 Knock.key = "sk_12345"
 
 # Set an entire preference set
@@ -115,7 +115,7 @@ Knock::Users.get_preferences(user_id: "jhammond")
 ### Getting and setting channel data
 
 ```ruby
-require "knockapi"
+require "knock"
 Knock.key = "sk_12345"
 
 # Set channel data for an APNS
@@ -134,7 +134,7 @@ Knock::Users.get_channel_data(user_id: "jhammond", channel_id: KNOCK_APNS_CHANNE
 ### Cancelling workflows
 
 ```ruby
-require "knockapi"
+require "knock"
 Knock.key = "sk_12345"
 
 Knock::Workflows.cancel(

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: {})
@@ -375,6 +396,29 @@ module Knock
 
         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
@@ -378,6 +395,26 @@ module Knock
 
         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.8'
+  VERSION = '0.4.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.10
 platform: ruby
 authors:
 - Knock Labs, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
@@ -92,7 +93,7 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://docs.knock.app
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: API client for Knock
 test_files: