knockapi 0.4.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4565e1e9c707c9edcb5fad6fbe69c90dfabce8362507b7a1b817c1bf6440e094
-  data.tar.gz: cdf934876f3e28a57ac42e8f6af8746f1ff9114987f692d1d419ff2cdec2cf49
+  metadata.gz: 1bb4aabec2c7c629eb81d5471e1c1be91af2183336a751e212cf536299b2fd7e
+  data.tar.gz: 50f6206a65e9ffa3c7d2cf99692ad5acb6fd3d7c337304b6f4a814fa2ba756f6
 SHA512:
-  metadata.gz: c3e4cbf5daa9efb7c4c4ab1742ee403e2a3e7bd628c2b5540e93bfe6702dd99e4aae7a8748ced4bd5bd31942c454964ede695eceacf978e89ec608d39cc72520
-  data.tar.gz: 04d8e14f0c4244897f0a5f8083fd993a2aa306506c755f81163bc739f5b357b5a621cb10b2493c3b9a6916269f1eed710a9823798cf4c1292550363bdd327083
+  metadata.gz: 72a821d5baf5e43d50054f44193052e3eab317f59506a675085b481fec8490bec453ea2eaa01ff6b2a16df4aa7955f5f46544d93d193771e448915c520186b16
+  data.tar.gz: 94df91c57a491f60a2dd5a122b4b6d3cf37cda6a3f63e639b489b8d182c60dab4ed138dc9a48e8fab1be21a0ff10ab06b5bbd8edad393e8c297793bc1275770c

data/Gemfile.lock

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

data/lib/knock/client.rb

@@ -18,7 +18,9 @@ module Knock
       http_status = response.code.to_i
       handle_error_response(response: response) if http_status >= 400
 
-      JSON.parse(response.body)
+      if response.body and response.body != "" do
+        JSON.parse(response.body) 
+      end
     end
 
     def get_request(path:, auth: false, params: {}, access_token: nil)

data/lib/knock/messages.rb

@@ -0,0 +1,88 @@
+require "net/http"
+require "uri"
+
+module Knock
+  # Methods for interacting with messages in Knock
+  module Messages
+    class << self
+      include Base
+      include Client
+
+      # Retrieves a paginated list of messages for the provided environment
+      #
+      # @param [Hash] options Options to pass to the messages endpoint query
+      #
+      # @return [Hash] Paginated list of Message records
+      def list(options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/messages",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Retrieves a Message
+      #
+      # @param [String] id The message id
+      #
+      # @return [Hash] The Message
+      def get(id:)
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get a Message's content
+      #
+      # @param [String] id The message id
+      #
+      # @return [Hash] The Message content
+      def get_content(id:)
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}/content"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get a Message's activities
+      #
+      # @param [String] id The message id
+      # @param [Hash] options Options to pass to the paginated activities endpoint query
+      #
+      # @return [Hash] Paginated Message's activities
+      def get_activities(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}/activities",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get a Message's events
+      #
+      # @param [String] id The message id
+      # @param [Hash] options Options to pass to the paginated events endpoint query
+      #
+      # @return [Hash] Paginated Message's events
+      def get_events(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}/events",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+    end
+  end
+end
+

data/lib/knock/objects.rb

@@ -8,6 +8,8 @@ module Knock
       include Base
       include Client
 
+      DEFAULT_PREFERENCE_SET_ID = "default"
+
       # Retrieves an Object in a collection
       #
       # @param [String] collection The collection the object is in
@@ -111,7 +113,7 @@ module Knock
       # @param [Hash] channel_data channel data
       #
       # @return [Hash] channel data
-      def set_channel_data(id:, channel_id:, channel_data:)
+      def set_channel_data(collection:, id:, channel_id:, channel_data:)
         request = put_request(
           auth: true,
           path: "/v1/objects/#{collection}/#{id}/channel_data/#{channel_id}",
@@ -120,6 +122,179 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Unsets object channel data for the given channel id
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] channel_id target channel ID
+      #
+      # @return [Hash] channel data
+      def unset_channel_data(collection:, id:, channel_id:)
+        request = delete_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/channel_data/#{channel_id}"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get object's messages
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Hash] options Options to pass to the messages endpoint query
+      #
+      # @return [Hash] Paginated messages response
+      def get_messages(collection:, id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/messages",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      ##
+      # Preferences
+      ##
+
+      # Returns all preference sets for the object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      #
+      # @return [Array] The preference sets
+      def get_all_preferences(collection:, id:)
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences"
+
+        request = get_request(
+          auth: true,
+          path: endpoint
+        )
+
+        execute_request(request: request)
+      end
+
+      # Gets a single preference set, defaults to the 'default' set
+      # for the object given.
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] preference_set The preference set ID (defaults to `default`)
+      #
+      # @return [Hash] The preference set (if it exists)
+      def get_preferences(collection:, id:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences/#{preference_set}"
+
+        request = get_request(
+          auth: true,
+          path: endpoint
+        )
+
+        execute_request(request: request)
+      end
+
+      # Sets multiple preferences at once for the preference set.
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] preference_set The preference set ID (defaults to `default`)
+      # @param [Hash] channel_types The channel_types hash to set
+      # @param [Hash] workflows The workflows hash to set
+      # @param [Hash] categories The categories hash to set
+      #
+      # @return [Hash] The preference set
+      def set_preferences(
+        collection:,
+        id:,
+        channel_types: nil,
+        workflows: nil,
+        categories: nil,
+        preference_set: DEFAULT_PREFERENCE_SET_ID
+      )
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences/#{preference_set}"
+
+        request = put_request(
+          auth: true,
+          path: endpoint,
+          body: {
+            channel_types: channel_types,
+            workflows: workflows,
+            categories: categories
+          }
+        )
+
+        execute_request(request: request)
+      end
+
+      # Sets preferences for the given channel type
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] preference_set The preference set ID (defaults to `default`)
+      # @param [String] channel_type The channel type to set
+      # @param [Bool] setting Whether the channel type is enabled or not
+      #
+      # @return [Hash] The preference set
+      def set_channel_type_preferences(collection:, id:, channel_type:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences/#{preference_set}/channel_types/#{channel_type}"
+
+        request = put_request(
+          auth: true,
+          path: endpoint,
+          body: {subscribed: setting}
+        )
+
+        execute_request(request: request)
+      end
+
+      # Sets preferences for the given workflow
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] preference_set The preference set ID (defaults to `default`)
+      # @param [String] workflow The workflow to set preferences for
+      # @param [Bool | Hash] setting Either a boolean to indicate if the type is enabled
+      #  or a hash containing channel types and settings
+      #
+      # @return [Hash] The preference set
+      def set_workflow_preferences(collection:, id:, workflow:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        params = setting.is_a?(Hash) ? setting : {subscribed: setting}
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences/#{preference_set}/workflows/#{workflow}"
+
+        request = put_request(
+          auth: true,
+          path: endpoint,
+          body: params
+        )
+
+        execute_request(request: request)
+      end
+
+      # Sets preferences for the given category
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] preference_set The preference set ID (defaults to `default`)
+      # @param [String] category The category to set preferences for
+      # @param [Bool | Hash] setting Either a boolean to indicate if the type is enabled
+      #  or a hash containing channel types and settings
+      #
+      # @return [Hash] The preference set
+      def set_category_preferences(collection:, id:, category:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        params = setting.is_a?(Hash) ? setting : {subscribed: setting}
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences/#{preference_set}/categories/#{category}"
+
+        request = put_request(
+          auth: true,
+          path: endpoint,
+          body: params
+        )
+
+        execute_request(request: request)
+      end
     end
   end
 end

data/lib/knock/users.rb

@@ -101,6 +101,22 @@ module Knock
         execute_request(request: request)
       end
 
+      # Merges the user specified with `from_user_id` into the user specified with `user_id`.
+      #
+      # @param [String] id The user id to merge into.
+      # @param [String] from_user_id The user id to merge from
+      #
+      # @return [Hash] the merged User
+      def merge(id:, from_user_id:)
+        request = post_request(
+          auth: true,
+          path: "/v1/users/#{id}/merge",
+          body: {from_user_id: from_user_id}
+        )
+
+        execute_request(request: request)
+      end
+
       ##
       # Preferences
       ##
@@ -300,6 +316,42 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Unsets user's channel data for the given channel id
+      #
+      # @param [String] id the user ID
+      # @param [String] channel_id target channel ID
+      # @param [Hash] channel_data channel data
+      #
+      # @return [Hash] channel data
+      def unset_channel_data(id:, channel_id:)
+        request = delete_request(
+          auth: true,
+          path: "/v1/users/#{id}/channel_data/#{channel_id}"
+        )
+
+        execute_request(request: request)
+      end
+
+      ##
+      # Messages
+      ##
+
+      # Get user's messages
+      #
+      # @param [String] id the user ID
+      # @param [Hash] options Options to pass to the messages endpoint query
+      #
+      # @return [Hash] Paginated messages response
+      def get_messages(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/users/#{id}/messages",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
     end
   end
 end

data/lib/knock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knock
-  VERSION = "0.4.0"
+  VERSION = "0.4.3"
 end

data/lib/knock/workflows.rb

@@ -11,7 +11,7 @@ module Knock
       # Triggers the workflow with the given key
       #
       # @param [String] key The workflow key
-      # @param [String, Hash] actor The actor identifier
+      # @param [String, Hash] actor The actor identifier (optional)
       # @param [Array<String, Hash>] recipients The recipient identifiers
       # @param [Hash] data The data to pass to the workflow
       # @param [String] cancellation_key An optional key to identify this workflow

data/lib/knock.rb

@@ -27,6 +27,7 @@ module Knock
   autoload :Workflows, "knock/workflows"
   autoload :BulkOperations, "knock/bulk_operations"
   autoload :Objects, "knock/objects"
+  autoload :Messages, "knock/messages"
 
   # Errors
   autoload :APIError, "knock/errors"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - lib/knock/bulk_operations.rb
 - lib/knock/client.rb
 - lib/knock/errors.rb
+- lib/knock/messages.rb
 - lib/knock/objects.rb
 - lib/knock/preferences.rb
 - lib/knock/users.rb
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: API client for Knock