knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/object_list_messages_params.rbi

@@ -0,0 +1,281 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectListMessagesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The cursor to fetch entries after.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # The cursor to fetch entries before.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Limits the results to items with the corresponding channel ID.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel_id
+
+      sig { params(channel_id: String).void }
+      attr_writer :channel_id
+
+      # Limits the results to messages with the given engagement status.
+      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol])) }
+      attr_reader :engagement_status
+
+      sig do
+        params(
+          engagement_status: T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol]
+        )
+          .void
+      end
+      attr_writer :engagement_status
+
+      sig { returns(T.nilable(Knockapi::Models::ObjectListMessagesParams::InsertedAt)) }
+      attr_reader :inserted_at
+
+      sig do
+        params(
+          inserted_at: T.any(Knockapi::Models::ObjectListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash)
+        )
+          .void
+      end
+      attr_writer :inserted_at
+
+      # 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.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :message_ids
+
+      sig { params(message_ids: T::Array[String]).void }
+      attr_writer :message_ids
+
+      # The number of items per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Limits the results to messages triggered by the given workflow key.
+      sig { returns(T.nilable(String)) }
+      attr_reader :source
+
+      sig { params(source: String).void }
+      attr_writer :source
+
+      # Limits the results to messages with the given delivery status.
+      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol])) }
+      attr_reader :status
+
+      sig { params(status: T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol]).void }
+      attr_writer :status
+
+      # Limits the results to items with the corresponding tenant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant
+
+      sig { params(tenant: String).void }
+      attr_writer :tenant
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :trigger_data
+
+      sig { params(trigger_data: String).void }
+      attr_writer :trigger_data
+
+      # Limits the results to messages related to any of the provided categories.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :workflow_categories
+
+      sig { params(workflow_categories: T::Array[String]).void }
+      attr_writer :workflow_categories
+
+      # Limits the results to messages for a specific recipient's workflow run.
+      sig { returns(T.nilable(String)) }
+      attr_reader :workflow_recipient_run_id
+
+      sig { params(workflow_recipient_run_id: String).void }
+      attr_writer :workflow_recipient_run_id
+
+      # Limits the results to messages associated with the top-level workflow run ID
+      # returned by the workflow trigger request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :workflow_run_id
+
+      sig { params(workflow_run_id: String).void }
+      attr_writer :workflow_run_id
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          channel_id: String,
+          engagement_status: T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol],
+          inserted_at: T.any(Knockapi::Models::ObjectListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash),
+          message_ids: T::Array[String],
+          page_size: Integer,
+          source: String,
+          status: T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol],
+          tenant: String,
+          trigger_data: String,
+          workflow_categories: T::Array[String],
+          workflow_recipient_run_id: String,
+          workflow_run_id: String,
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Limits the results to items with the corresponding channel ID.
+        channel_id: nil,
+        # Limits the results to messages with the given engagement status.
+        engagement_status: nil,
+        inserted_at: nil,
+        # 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.
+        message_ids: nil,
+        # The number of items per page.
+        page_size: nil,
+        # Limits the results to messages triggered by the given workflow key.
+        source: nil,
+        # Limits the results to messages with the given delivery status.
+        status: nil,
+        # Limits the results to items with the corresponding tenant.
+        tenant: nil,
+        # 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.
+        trigger_data: nil,
+        # Limits the results to messages related to any of the provided categories.
+        workflow_categories: nil,
+        # Limits the results to messages for a specific recipient's workflow run.
+        workflow_recipient_run_id: nil,
+        # Limits the results to messages associated with the top-level workflow run ID
+        # returned by the workflow trigger request.
+        workflow_run_id: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              after: String,
+              before: String,
+              channel_id: String,
+              engagement_status: T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol],
+              inserted_at: Knockapi::Models::ObjectListMessagesParams::InsertedAt,
+              message_ids: T::Array[String],
+              page_size: Integer,
+              source: String,
+              status: T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol],
+              tenant: String,
+              trigger_data: String,
+              workflow_categories: T::Array[String],
+              workflow_recipient_run_id: String,
+              workflow_run_id: String,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+
+      module EngagementStatus
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SEEN = T.let(:seen, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
+        READ = T.let(:read, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
+        INTERACTED =
+          T.let(:interacted, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
+        LINK_CLICKED =
+          T.let(:link_clicked, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
+        ARCHIVED = T.let(:archived, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
+
+        sig { override.returns(T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol]) }
+        def self.values; end
+      end
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        # Limits the results to messages inserted after the given date.
+        sig { returns(T.nilable(String)) }
+        attr_reader :gt
+
+        sig { params(gt: String).void }
+        attr_writer :gt
+
+        # Limits the results to messages inserted after or on the given date.
+        sig { returns(T.nilable(String)) }
+        attr_reader :gte
+
+        sig { params(gte: String).void }
+        attr_writer :gte
+
+        # Limits the results to messages inserted before the given date.
+        sig { returns(T.nilable(String)) }
+        attr_reader :lt
+
+        sig { params(lt: String).void }
+        attr_writer :lt
+
+        # Limits the results to messages inserted before or on the given date.
+        sig { returns(T.nilable(String)) }
+        attr_reader :lte
+
+        sig { params(lte: String).void }
+        attr_writer :lte
+
+        sig { params(gt: String, gte: String, lt: String, lte: String).returns(T.attached_class) }
+        def self.new(
+          # Limits the results to messages inserted after the given date.
+          gt: nil,
+          # Limits the results to messages inserted after or on the given date.
+          gte: nil,
+          # Limits the results to messages inserted before the given date.
+          lt: nil,
+          # Limits the results to messages inserted before or on the given date.
+          lte: nil
+        ); end
+        sig { override.returns({gt: String, gte: String, lt: String, lte: String}) }
+        def to_hash; end
+      end
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListMessagesParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUED = T.let(:queued, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+        SENT = T.let(:sent, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+        DELIVERED = T.let(:delivered, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+        DELIVERY_ATTEMPTED =
+          T.let(:delivery_attempted, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+        UNDELIVERED = T.let(:undelivered, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+        NOT_SENT = T.let(:not_sent, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+        BOUNCED = T.let(:bounced, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol]) }
+        def self.values; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_list_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The cursor to fetch entries after.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # The cursor to fetch entries before.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Includes preferences of the objects in the response.
+      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol])) }
+      attr_reader :include
+
+      sig { params(include: T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol]).void }
+      attr_writer :include
+
+      # The number of items per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          include: T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol],
+          page_size: Integer,
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Includes preferences of the objects in the response.
+        include: nil,
+        # The number of items per page.
+        page_size: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              after: String,
+              before: String,
+              include: T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol],
+              page_size: Integer,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREFERENCES = T.let(:preferences, Knockapi::Models::ObjectListParams::Include::TaggedSymbol)
+
+        sig { override.returns(T::Array[Knockapi::Models::ObjectListParams::Include::TaggedSymbol]) }
+        def self.values; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_list_preferences_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectListPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: Knockapi::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/object_list_preferences_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    ObjectListPreferencesResponse =
+      T.let(
+        Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::PreferenceSet],
+        Knockapi::Internal::Type::Converter
+      )
+  end
+end

data/rbi/knockapi/models/object_list_schedules_params.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectListSchedulesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The cursor to fetch entries after.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # The cursor to fetch entries before.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # The number of items per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Filter schedules by tenant id.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant
+
+      sig { params(tenant: String).void }
+      attr_writer :tenant
+
+      # Filter schedules by workflow id.
+      sig { returns(T.nilable(String)) }
+      attr_reader :workflow
+
+      sig { params(workflow: String).void }
+      attr_writer :workflow
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          page_size: Integer,
+          tenant: String,
+          workflow: String,
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # The number of items per page.
+        page_size: nil,
+        # Filter schedules by tenant id.
+        tenant: nil,
+        # Filter schedules by workflow id.
+        workflow: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              after: String,
+              before: String,
+              page_size: Integer,
+              tenant: String,
+              workflow: String,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/object_list_subscriptions_params.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectListSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The cursor to fetch entries after.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # The cursor to fetch entries before.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Additional fields to include in the response.
+      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol])) }
+      attr_reader :include
+
+      sig { params(include: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol]).void }
+      attr_writer :include
+
+      # Mode of the request. `recipient` to list the objects that the provided object is
+      # subscribed to, `object` to list the recipients that subscribe to the provided
+      # object.
+      sig { returns(T.nilable(Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol)) }
+      attr_reader :mode
+
+      sig { params(mode: Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol).void }
+      attr_writer :mode
+
+      # Objects to filter by (only used if mode is `recipient`).
+      sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object])) }
+      attr_reader :objects
+
+      sig do
+        params(
+          objects: T::Array[T.any(Knockapi::Models::ObjectListSubscriptionsParams::Object, Knockapi::Internal::AnyHash)]
+        )
+          .void
+      end
+      attr_writer :objects
+
+      # The number of items per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Recipients to filter by (only used if mode is `object`).
+      sig { returns(T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)])) }
+      attr_reader :recipients
+
+      sig do
+        params(
+          recipients: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)]
+        )
+          .void
+      end
+      attr_writer :recipients
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          include: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol],
+          mode: Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol,
+          objects: T::Array[T.any(Knockapi::Models::ObjectListSubscriptionsParams::Object, Knockapi::Internal::AnyHash)],
+          page_size: Integer,
+          recipients: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)],
+          request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Additional fields to include in the response.
+        include: nil,
+        # Mode of the request. `recipient` to list the objects that the provided object is
+        # subscribed to, `object` to list the recipients that subscribe to the provided
+        # object.
+        mode: nil,
+        # Objects to filter by (only used if mode is `recipient`).
+        objects: nil,
+        # The number of items per page.
+        page_size: nil,
+        # Recipients to filter by (only used if mode is `object`).
+        recipients: nil,
+        request_options: {}
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              after: String,
+              before: String,
+              include: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::OrSymbol],
+              mode: Knockapi::Models::ObjectListSubscriptionsParams::Mode::OrSymbol,
+              objects: T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Object],
+              page_size: Integer,
+              recipients: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+      end
+      def to_hash; end
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREFERENCES = T.let(:preferences, Knockapi::Models::ObjectListSubscriptionsParams::Include::TaggedSymbol)
+
+        sig { override.returns(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Include::TaggedSymbol]) }
+        def self.values; end
+      end
+
+      # Mode of the request. `recipient` to list the objects that the provided object is
+      # subscribed to, `object` to list the recipients that subscribe to the provided
+      # object.
+      module Mode
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        RECIPIENT = T.let(:recipient, Knockapi::Models::ObjectListSubscriptionsParams::Mode::TaggedSymbol)
+        OBJECT = T.let(:object, Knockapi::Models::ObjectListSubscriptionsParams::Mode::TaggedSymbol)
+
+        sig { override.returns(T::Array[Knockapi::Models::ObjectListSubscriptionsParams::Mode::TaggedSymbol]) }
+        def self.values; end
+      end
+
+      class Object < Knockapi::Internal::Type::BaseModel
+        # An identifier for the recipient object.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The collection the recipient object belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :collection
+
+        sig { params(collection: String).void }
+        attr_writer :collection
+
+        # A reference to a recipient object.
+        sig { params(id: String, collection: String).returns(T.attached_class) }
+        def self.new(
+          # An identifier for the recipient object.
+          id: nil,
+          # The collection the recipient object belongs to.
+          collection: nil
+        ); end
+        sig { override.returns({id: String, collection: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/object_set_channel_data_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class ObjectSetChannelDataParams < Knockapi::Models::Recipients::ChannelDataRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      sig do
+        params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {}); end
+
+      sig { override.returns({request_options: Knockapi::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end