knockapi 0.6.1 → 1.1.0

data/rbi/knockapi/models/user_list_messages_params.rbi

@@ -0,0 +1,386 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListMessagesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserListMessagesParams, Knockapi::Internal::AnyHash)
+        end
+
+      # 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 do
+        returns(
+          T.nilable(
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :engagement_status
+
+      sig do
+        params(
+          engagement_status:
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :engagement_status
+
+      sig { returns(T.nilable(Knockapi::UserListMessagesParams::InsertedAt)) }
+      attr_reader :inserted_at
+
+      sig do
+        params(
+          inserted_at: Knockapi::UserListMessagesParams::InsertedAt::OrHash
+        ).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 do
+        returns(
+          T.nilable(
+            T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol]
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: T::Array[Knockapi::UserListMessagesParams::Status::OrSymbol]
+        ).void
+      end
+      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::UserListMessagesParams::EngagementStatus::OrSymbol
+            ],
+          inserted_at: Knockapi::UserListMessagesParams::InsertedAt::OrHash,
+          message_ids: T::Array[String],
+          page_size: Integer,
+          source: String,
+          status: T::Array[Knockapi::UserListMessagesParams::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::OrHash
+        ).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::UserListMessagesParams::EngagementStatus::OrSymbol
+              ],
+            inserted_at: Knockapi::UserListMessagesParams::InsertedAt,
+            message_ids: T::Array[String],
+            page_size: Integer,
+            source: String,
+            status:
+              T::Array[Knockapi::UserListMessagesParams::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 do
+            T.all(Symbol, Knockapi::UserListMessagesParams::EngagementStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SEEN =
+          T.let(
+            :seen,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        READ =
+          T.let(
+            :read,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        INTERACTED =
+          T.let(
+            :interacted,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        LINK_CLICKED =
+          T.let(
+            :link_clicked,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+        ARCHIVED =
+          T.let(
+            :archived,
+            Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::UserListMessagesParams::EngagementStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::UserListMessagesParams::InsertedAt,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # 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 do
+          params(gt: String, gte: String, lt: String, lte: String).returns(
+            T.attached_class
+          )
+        end
+        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 do
+          override.returns({ gt: String, gte: String, lt: String, lte: String })
+        end
+        def to_hash
+        end
+      end
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::UserListMessagesParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUED =
+          T.let(:queued, Knockapi::UserListMessagesParams::Status::TaggedSymbol)
+        SENT =
+          T.let(:sent, Knockapi::UserListMessagesParams::Status::TaggedSymbol)
+        DELIVERED =
+          T.let(
+            :delivered,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        DELIVERY_ATTEMPTED =
+          T.let(
+            :delivery_attempted,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        UNDELIVERED =
+          T.let(
+            :undelivered,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        NOT_SENT =
+          T.let(
+            :not_sent,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+        BOUNCED =
+          T.let(
+            :bounced,
+            Knockapi::UserListMessagesParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Knockapi::UserListMessagesParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/user_list_params.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserListParams, Knockapi::Internal::AnyHash)
+        end
+
+      # 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
+
+      # Associated resources to include in the response.
+      sig do
+        returns(
+          T.nilable(T::Array[Knockapi::UserListParams::Include::OrSymbol])
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include: T::Array[Knockapi::UserListParams::Include::OrSymbol]
+        ).void
+      end
+      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::UserListParams::Include::OrSymbol],
+          page_size: Integer,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Associated resources to include 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::UserListParams::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::UserListParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREFERENCES =
+          T.let(:preferences, Knockapi::UserListParams::Include::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Knockapi::UserListParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/user_list_preferences_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::UserListPreferencesParams,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Knockapi::RequestOptions::OrHash).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/user_list_preferences_response.rbi

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

data/rbi/knockapi/models/user_list_schedules_params.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListSchedulesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::UserListSchedulesParams, Knockapi::Internal::AnyHash)
+        end
+
+      # 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
+
+      # The tenant ID to filter schedules for.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant
+
+      sig { params(tenant: String).void }
+      attr_writer :tenant
+
+      # The workflow key to filter schedules for.
+      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: Knockapi::RequestOptions::OrHash
+        ).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,
+        # The tenant ID to filter schedules for.
+        tenant: nil,
+        # The workflow key to filter schedules for.
+        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