knockapi 0.6.1 → 1.1.0

data/lib/knockapi/resources/channels/bulk.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Channels
+      class Bulk
+        # Some parameter documentations has been truncated, see
+        # {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
+        #
+        # Bulk update the status of messages for a specific channel. The channel is
+        # specified by the `channel_id` parameter. The action to perform is specified by
+        # the `action` parameter, where the action is a status change action (e.g.
+        # `archive`, `unarchive`).
+        #
+        # @overload update_message_status(channel_id, action, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {})
+        #
+        # @param channel_id [String] The ID of the channel to update messages for.
+        #
+        # @param action [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
+        #
+        # @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
+        #
+        # @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
+        #
+        # @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
+        #
+        # @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
+        #
+        # @param newer_than [Time] Limits the results to messages inserted after the given date.
+        #
+        # @param older_than [Time] Limits the results to messages inserted before the given date.
+        #
+        # @param recipient_ids [Array<String>] Limits the results to messages with the given recipient IDs.
+        #
+        # @param tenants [Array<String>] Limits the results to messages with the given tenant IDs.
+        #
+        # @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
+        #
+        # @param workflows [Array<String>] Limits the results to messages with the given workflow keys.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Channels::BulkUpdateMessageStatusParams
+        def update_message_status(channel_id, action, params = {})
+          parsed, options = Knockapi::Channels::BulkUpdateMessageStatusParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/channels/%1$s/messages/bulk/%2$s", channel_id, action],
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/channels.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Channels
+      # @return [Knockapi::Resources::Channels::Bulk]
+      attr_reader :bulk
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @bulk = Knockapi::Resources::Channels::Bulk.new(client: client)
+      end
+    end
+  end
+end

data/lib/knockapi/resources/integrations/census.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Integrations
+      class Census
+        # Processes a Census custom destination RPC request.
+        #
+        # @overload custom_destination(id:, jsonrpc:, method_:, params: nil, request_options: {})
+        #
+        # @param id [String] The unique identifier for the RPC request.
+        #
+        # @param jsonrpc [String] The JSON-RPC version.
+        #
+        # @param method_ [String] The method name to execute.
+        #
+        # @param params [Hash{Symbol=>Object}] The parameters for the method.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Integrations::CensusCustomDestinationResponse]
+        #
+        # @see Knockapi::Models::Integrations::CensusCustomDestinationParams
+        def custom_destination(params)
+          parsed, options = Knockapi::Integrations::CensusCustomDestinationParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/integrations/census/custom-destination",
+            body: parsed,
+            model: Knockapi::Models::Integrations::CensusCustomDestinationResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/integrations/hightouch.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Integrations
+      class Hightouch
+        # Processes a Hightouch embedded destination RPC request.
+        #
+        # @overload embedded_destination(id:, jsonrpc:, method_:, params: nil, request_options: {})
+        #
+        # @param id [String] The unique identifier for the RPC request.
+        #
+        # @param jsonrpc [String] The JSON-RPC version.
+        #
+        # @param method_ [String] The method name to execute.
+        #
+        # @param params [Hash{Symbol=>Object}] The parameters for the method.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse]
+        #
+        # @see Knockapi::Models::Integrations::HightouchEmbeddedDestinationParams
+        def embedded_destination(params)
+          parsed, options = Knockapi::Integrations::HightouchEmbeddedDestinationParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/integrations/hightouch/embedded-destination",
+            body: parsed,
+            model: Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/integrations.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Integrations
+      # @return [Knockapi::Resources::Integrations::Census]
+      attr_reader :census
+
+      # @return [Knockapi::Resources::Integrations::Hightouch]
+      attr_reader :hightouch
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @census = Knockapi::Resources::Integrations::Census.new(client: client)
+        @hightouch = Knockapi::Resources::Integrations::Hightouch.new(client: client)
+      end
+    end
+  end
+end

data/lib/knockapi/resources/messages/batch.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Messages
+      class Batch
+        # Marks the given messages as archived. Archived messages are hidden from the
+        # default message list in the feed but can still be accessed and unarchived later.
+        #
+        # @overload archive(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchArchiveParams
+        def archive(params)
+          parsed, options = Knockapi::Messages::BatchArchiveParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/archived",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # Get the contents of multiple messages in a single request.
+        #
+        # @overload get_content(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The IDs of the messages to fetch contents of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Models::Messages::BatchGetContentResponseItem>]
+        #
+        # @see Knockapi::Models::Messages::BatchGetContentParams
+        def get_content(params)
+          parsed, options = Knockapi::Messages::BatchGetContentParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "v1/messages/batch/content",
+            query: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Messages::BatchGetContentResponseItem],
+            options: options
+          )
+        end
+
+        # Marks the given messages as interacted with by the user. This can include any
+        # user action on the message, with optional metadata about the specific
+        # interaction. Cannot include more than 5 key-value pairs, must not contain nested
+        # data. Read more about message engagement statuses
+        # [here](/send-notifications/message-statuses#engagement-status).
+        #
+        # @overload mark_as_interacted(message_ids:, metadata: nil, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to batch mark as interacted with.
+        #
+        # @param metadata [Hash{Symbol=>Object}, nil] Metadata about the interaction.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchMarkAsInteractedParams
+        def mark_as_interacted(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsInteractedParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/interacted",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # Marks the given messages as `read`. Read more about message engagement statuses
+        # [here](/send-notifications/message-statuses#engagement-status).
+        #
+        # @overload mark_as_read(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchMarkAsReadParams
+        def mark_as_read(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsReadParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/read",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # Marks the given messages as `seen`. This indicates that the user has viewed the
+        # message in their feed or inbox. Read more about message engagement statuses
+        # [here](/send-notifications/message-statuses#engagement-status).
+        #
+        # @overload mark_as_seen(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchMarkAsSeenParams
+        def mark_as_seen(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsSeenParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/seen",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # Marks the given messages as `unread`. This reverses the `read` state. Read more
+        # about message engagement statuses
+        # [here](/send-notifications/message-statuses#engagement-status).
+        #
+        # @overload mark_as_unread(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchMarkAsUnreadParams
+        def mark_as_unread(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsUnreadParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/unread",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # Marks the given messages as `unseen`. This reverses the `seen` state. Read more
+        # about message engagement statuses
+        # [here](/send-notifications/message-statuses#engagement-status).
+        #
+        # @overload mark_as_unseen(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchMarkAsUnseenParams
+        def mark_as_unseen(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsUnseenParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/unseen",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # Marks the given messages as unarchived. This reverses the `archived` state.
+        # Archived messages are hidden from the default message list in the feed but can
+        # still be accessed and unarchived later.
+        #
+        # @overload unarchive(message_ids:, request_options: {})
+        #
+        # @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Knockapi::Message>]
+        #
+        # @see Knockapi::Models::Messages::BatchUnarchiveParams
+        def unarchive(params)
+          parsed, options = Knockapi::Messages::BatchUnarchiveParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/messages/batch/unarchived",
+            body: parsed,
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end