knockapi 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5539a9d4052b39167c0aa22d71eb9848ab0c6ad0c2812bf72e09cc446256868
-  data.tar.gz: 7b08912b135c05a15d528527788a3f7aa8d7b67b7c14e0e5bcbac8f80fb5fe4e
+  metadata.gz: ed79d84e9b6070feed5df6299073f396d7739c43a5a7c5a1ed2bb87e91722f5a
+  data.tar.gz: 99360a722f4a6f669940d38c08688edb64effb68f4805f26fe3d790dce7038bc
 SHA512:
-  metadata.gz: 2e2976916846b11c9a8ccb6cdacba9f12fecb0e113f8114cb1eed77a248b53156cdf025ffd823148567675489d988f655d80fec43cdb8a2174f6d6cce5a0db02
-  data.tar.gz: 83b75fd115a9ce6905629cc20bbdf1550eb726e2e39ece0e4d4215a1203ee1b6af46877d1dd50cda0de1c1230a5f948a9e6e974cdd600ca62794a154ba9f1ab6
+  metadata.gz: 670a433ef51923fb02f0af1abd618e848c6b5574dc919766ccec8583d364f9a6f3ca2f618592a1c3ed95245a028302eaa2d288d6a1b0b2d8eb979153e4dbaf16
+  data.tar.gz: 9bcbe07af9a0125fb77d1f3ce50bc190ecf12ac2c32f71e214c93a6492276960343d4e59ad7fe98411ebccbdeea7da29de54f78da5a1041471d6bed2d0e6eb55

data/Gemfile.lock

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

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

@@ -120,6 +120,23 @@ module Knock
 
         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
     end
   end
 end

data/lib/knock/users.rb

@@ -316,6 +316,26 @@ module Knock
 
         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.1"
+  VERSION = "0.4.2"
 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.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-04-19 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