knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/models/user.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class User < Knockapi::Internal::Type::BaseModel
+      # The ID for the user that you set when identifying them in Knock.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The typename of the schema.
+      sig { returns(String) }
+      attr_accessor :_typename
+
+      # The timestamp when the resource was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # URL to the user's avatar image.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :avatar
+
+      # The creation date of the user from your system.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # The primary email address for the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Display name of the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      # user (required for SMS channels).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
+      # The timezone of the user. Must be a valid
+      # [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+      # Used for
+      # [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
+      # A [User](/concepts/users) represents an individual in your system who can
+      # receive notifications through Knock. Users are the most common recipients of
+      # notifications and are always referenced by your internal identifier.
+      sig do
+        params(
+          id: String,
+          _typename: String,
+          updated_at: Time,
+          avatar: T.nilable(String),
+          created_at: T.nilable(Time),
+          email: T.nilable(String),
+          name: T.nilable(String),
+          phone_number: T.nilable(String),
+          timezone: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The ID for the user that you set when identifying them in Knock.
+        id:,
+        # The typename of the schema.
+        _typename:,
+        # The timestamp when the resource was last updated.
+        updated_at:,
+        # URL to the user's avatar image.
+        avatar: nil,
+        # The creation date of the user from your system.
+        created_at: nil,
+        # The primary email address for the user.
+        email: nil,
+        # Display name of the user.
+        name: nil,
+        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+        # user (required for SMS channels).
+        phone_number: nil,
+        # The timezone of the user. Must be a valid
+        # [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+        # Used for
+        # [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+        timezone: nil
+      ); end
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              _typename: String,
+              updated_at: Time,
+              avatar: T.nilable(String),
+              created_at: T.nilable(Time),
+              email: T.nilable(String),
+              name: T.nilable(String),
+              phone_number: T.nilable(String),
+              timezone: T.nilable(String)
+            }
+          )
+      end
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/user_delete_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserDeleteParams < 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/user_get_channel_data_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserGetChannelDataParams < 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/user_get_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserGetParams < 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/user_get_preferences_params.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserGetPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # The unique identifier for the tenant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant
+
+      sig { params(tenant: String).void }
+      attr_writer :tenant
+
+      sig do
+        params(tenant: String, request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the tenant.
+        tenant: nil,
+        request_options: {}
+      ); end
+      sig { override.returns({tenant: String, request_options: Knockapi::RequestOptions}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/knockapi/models/user_list_messages_params.rbi

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

data/rbi/knockapi/models/user_list_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListParams < 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
+
+      # Associated resources to include in the response.
+      sig { returns(T.nilable(T::Array[Knockapi::Models::UserListParams::Include::OrSymbol])) }
+      attr_reader :include
+
+      sig { params(include: T::Array[Knockapi::Models::UserListParams::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::UserListParams::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,
+        # 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::Models::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::Models::UserListParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREFERENCES = T.let(:preferences, Knockapi::Models::UserListParams::Include::TaggedSymbol)
+
+        sig { override.returns(T::Array[Knockapi::Models::UserListParams::Include::TaggedSymbol]) }
+        def self.values; end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/user_list_preferences_params.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListPreferencesParams < 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/user_list_preferences_response.rbi

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

data/rbi/knockapi/models/user_list_schedules_params.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class UserListSchedulesParams < 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
+
+      # 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: 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,
+        # 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