knockapi 0.6.1 → 1.1.0

data/lib/knockapi/models/message_list_params.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#list
+    class MessageListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute channel_id
+      #   Limits the results to items with the corresponding channel ID.
+      #
+      #   @return [String, nil]
+      optional :channel_id, String
+
+      # @!attribute engagement_status
+      #   Limits the results to messages with the given engagement status.
+      #
+      #   @return [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>, nil]
+      optional :engagement_status,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::EngagementStatus] }
+
+      # @!attribute inserted_at
+      #
+      #   @return [Knockapi::MessageListParams::InsertedAt, nil]
+      optional :inserted_at, -> { Knockapi::MessageListParams::InsertedAt }
+
+      # @!attribute message_ids
+      #   Limits the results to only the message IDs given (max 50). Note: when using this
+      #   option, the results will be subject to any other filters applied to the query.
+      #
+      #   @return [Array<String>, nil]
+      optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute source
+      #   Limits the results to messages triggered by the given workflow key.
+      #
+      #   @return [String, nil]
+      optional :source, String
+
+      # @!attribute status
+      #   Limits the results to messages with the given delivery status.
+      #
+      #   @return [Array<Symbol, Knockapi::MessageListParams::Status>, nil]
+      optional :status, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::Status] }
+
+      # @!attribute tenant
+      #   Limits the results to items with the corresponding tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute trigger_data
+      #   Limits the results to only messages that were generated with the given data. See
+      #   [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
+      #   more information.
+      #
+      #   @return [String, nil]
+      optional :trigger_data, String
+
+      # @!attribute workflow_categories
+      #   Limits the results to messages related to any of the provided categories.
+      #
+      #   @return [Array<String>, nil]
+      optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute workflow_recipient_run_id
+      #   Limits the results to messages for a specific recipient's workflow run.
+      #
+      #   @return [String, nil]
+      optional :workflow_recipient_run_id, String
+
+      # @!attribute workflow_run_id
+      #   Limits the results to messages associated with the top-level workflow run ID
+      #   returned by the workflow trigger request.
+      #
+      #   @return [String, nil]
+      optional :workflow_run_id, String
+
+      # @!method initialize(after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::MessageListParams} for more details.
+      #
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param channel_id [String] Limits the results to items with the corresponding channel ID.
+      #
+      #   @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      #
+      #   @param inserted_at [Knockapi::MessageListParams::InsertedAt]
+      #
+      #   @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param source [String] Limits the results to messages triggered by the given workflow key.
+      #
+      #   @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
+      #
+      #   @param tenant [String] Limits the results to items with the corresponding tenant.
+      #
+      #   @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
+      #
+      #   @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
+      #
+      #   @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
+      #
+      #   @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module EngagementStatus
+        extend Knockapi::Internal::Type::Enum
+
+        SEEN = :seen
+        READ = :read
+        INTERACTED = :interacted
+        LINK_CLICKED = :link_clicked
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        # @!attribute gt
+        #   Limits the results to messages inserted after the given date.
+        #
+        #   @return [String, nil]
+        optional :gt, String
+
+        # @!attribute gte
+        #   Limits the results to messages inserted after or on the given date.
+        #
+        #   @return [String, nil]
+        optional :gte, String
+
+        # @!attribute lt
+        #   Limits the results to messages inserted before the given date.
+        #
+        #   @return [String, nil]
+        optional :lt, String
+
+        # @!attribute lte
+        #   Limits the results to messages inserted before or on the given date.
+        #
+        #   @return [String, nil]
+        optional :lte, String
+
+        # @!method initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+        #   @param gt [String] Limits the results to messages inserted after the given date.
+        #
+        #   @param gte [String] Limits the results to messages inserted after or on the given date.
+        #
+        #   @param lt [String] Limits the results to messages inserted before the given date.
+        #
+        #   @param lte [String] Limits the results to messages inserted before or on the given date.
+      end
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED = :queued
+        SENT = :sent
+        DELIVERED = :delivered
+        DELIVERY_ATTEMPTED = :delivery_attempted
+        UNDELIVERED = :undelivered
+        NOT_SENT = :not_sent
+        BOUNCED = :bounced
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/message_mark_as_interacted_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#mark_as_interacted
+    class MessageMarkAsInteractedParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute metadata
+      #   Metadata about the interaction.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+      # @!method initialize(metadata: nil, request_options: {})
+      #   @param metadata [Hash{Symbol=>Object}] Metadata about the interaction.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/message_mark_as_read_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#mark_as_read
+    class MessageMarkAsReadParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/message_mark_as_seen_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#mark_as_seen
+    class MessageMarkAsSeenParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/message_mark_as_unread_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#mark_as_unread
+    class MessageMarkAsUnreadParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/message_mark_as_unseen_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#mark_as_unseen
+    class MessageMarkAsUnseenParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/message_unarchive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#unarchive
+    class MessageUnarchiveParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/messages/batch_archive_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Messages
+      # @see Knockapi::Resources::Messages::Batch#archive
+      class BatchArchiveParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute message_ids
+        #   The message IDs to update the status of.
+        #
+        #   @return [Array<String>]
+        required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(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}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/messages/batch_archive_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Messages
+      # @type [Knockapi::Internal::Type::Converter]
+      BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
+    end
+  end
+end

data/lib/knockapi/models/messages/batch_get_content_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Messages
+      # @see Knockapi::Resources::Messages::Batch#get_content
+      class BatchGetContentParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute message_ids
+        #   The IDs of the messages to fetch contents of.
+        #
+        #   @return [Array<String>]
+        required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(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}]
+      end
+    end
+  end
+end