knockapi 0.4.4 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0a730346c7c39ec862f160ac31fd80844b3f0907129a02ad320bf724e74888
-  data.tar.gz: bab747c80c86891e7e5d8135748deec4cd8c6bee1b20fbddf19546aefebe5646
+  metadata.gz: bb2117c38dcd672ea551af82b0803b141576d46ba155bbb345e3dd3136c8ad13
+  data.tar.gz: eebda102aea7791d7b664f244dadb26b98d529d4eb197227684dcb1f64bbdfe4
 SHA512:
-  metadata.gz: a7e879b66a557daac3950155ec7429cbfe72b7f6d7f2491eb440f92cf1b1f620753a2dab325751bdb704933df7be8c598b9b47c67b191c7659dbd9470c888f2c
-  data.tar.gz: 689dba9548ddba6fe5e2e90fb339eb2dee6c23f9c8d51ce878d4d163da70453482a1fae0806c7fa56638e3dec9aa0cf38f3c5669c657b11768d7e1087a57dd47
+  metadata.gz: 7f56c9b141388fbf5793b1699a958b71b321593acc86f19afaadb96c15425c3ce0895e47d2e7f229d36a0a512a55a77cad90ae8da5e5c9e812833d035db93eb1
+  data.tar.gz: a1837d1bc86cecf3250ac99286e0a46c8ea6f3bc5b7c07cca6f806fe6b443a02ee7996daa7009f39169065ba377b5acce24c337ad7fc9a05d37cad7f383be1d7

data/Gemfile.lock

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

data/lib/knock/client.rb

@@ -45,7 +45,7 @@ module Knock
       request
     end
 
-    def delete_request(path:, auth: false, params: {})
+    def delete_request(path:, auth: false, params: {}, body: nil)
       uri = URI(path)
       uri.query = URI.encode_www_form(params) if params
 
@@ -54,6 +54,7 @@ module Knock
         'Content-Type' => 'application/json'
       )
 
+      request.body = body.to_json if body
       request['Authorization'] = "Bearer #{Knock.key!}" if auth
       request['User-Agent'] = user_agent
       request

data/lib/knock/messages.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'net/http'
 require 'uri'
 
@@ -16,6 +17,8 @@ module Knock
       #
       # @return [Hash] Paginated list of Message records
       def list(options: {})
+        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
+
         request = get_request(
           auth: true,
           path: '/v1/messages',
@@ -60,6 +63,8 @@ module Knock
       #
       # @return [Hash] Paginated Message's activities
       def get_activities(id:, options: {})
+        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
+
         request = get_request(
           auth: true,
           path: "/v1/messages/#{id}/activities",

data/lib/knock/objects.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'net/http'
 require 'uri'
 
@@ -150,6 +151,8 @@ module Knock
       #
       # @return [Hash] Paginated messages response
       def get_messages(collection:, id:, options: {})
+        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
+
         request = get_request(
           auth: true,
           path: "/v1/objects/#{collection}/#{id}/messages",
@@ -303,6 +306,58 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Lists all subscriptiopns for the given object
+      #
+      # @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
+      #
+      # @return [Hash] Paginated subscriptions response
+      def list_subscriptions(collection:, id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Creates a set of subscriptions for the recipients on the object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Array<String, Hash>] recipients An array of recipients
+      # @param [Hash] properties A set of custom properties to set on the subscriptions
+      #
+      # @return [Array<Hash>] List of created subscriptions
+      def add_subscriptions(collection:, id:, recipients: [], properties: {})
+        request = post_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          body: { recipients: recipients, properties: properties }
+        )
+
+        execute_request(request: request)
+      end
+
+      # Removes subscriptions for the recipients on the object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Array<String, Hash>] recipients An array of recipients
+      #
+      # @return [Array<Hash>] List of deleted subscriptions
+      def delete_subscriptions(collection:, id:, recipients: [])
+        request = delete_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          body: { recipients: recipients }
+        )
+
+        execute_request(request: request)
+      end
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/lib/knock/users.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'net/http'
 require 'uri'
 
@@ -95,6 +96,8 @@ module Knock
       #
       # @return [Hash] the feed response
       def get_feed(id:, channel_id:, options: {})
+        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
+
         request = get_request(
           auth: true,
           path: "/v1/users/#{id}/feeds/#{channel_id}",
@@ -345,6 +348,8 @@ module Knock
       #
       # @return [Hash] Paginated messages response
       def get_messages(id:, options: {})
+        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
+
         request = get_request(
           auth: true,
           path: "/v1/users/#{id}/messages",

data/lib/knock/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.6
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: API client for Knock