knockapi 0.6.1 → 1.0.0

data/rbi/knockapi/resources/schedules.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Schedules
+      sig { returns(Knockapi::Resources::Schedules::Bulk) }
+      attr_reader :bulk
+
+      # Creates one or more schedules for a workflow with the specified recipients,
+      # timing, and data. Schedules can be one-time or recurring. This endpoint also
+      # handles
+      # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+      # for the `actor`, `recipient`, and `tenant` fields.
+      sig do
+        params(
+          recipients: T::Array[
+            T.any(
+              String,
+              Knockapi::Models::InlineIdentifyUserRequest,
+              Knockapi::Internal::AnyHash,
+              Knockapi::Models::InlineObjectRequest
+            )
+          ],
+          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          workflow: String,
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          ending_at: T.nilable(Time),
+          scheduled_at: T.nilable(Time),
+          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
+          request_options: Knockapi::RequestOpts
+        )
+          .returns(T::Array[Knockapi::Models::Schedule])
+      end
+      def create(
+        # The recipients to trigger the workflow for. Can inline identify users, objects,
+        # or use a list of user IDs. Limited to 1,000 recipients.
+        recipients:,
+        # The repeat rule for the schedule.
+        repeats:,
+        # The key of the workflow.
+        workflow:,
+        # An optional map of data to pass into the workflow execution.
+        data: nil,
+        # The ending date and time for the schedule.
+        ending_at: nil,
+        # The starting date and time for the schedule.
+        scheduled_at: nil,
+        # An request to set a tenant inline.
+        tenant: nil,
+        request_options: {}
+      ); end
+      # Updates one or more existing schedules with new timing, data, or other
+      # properties. All specified schedule IDs will be updated with the same values.
+      # This endpoint also handles
+      # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+      # for the `actor`, `recipient`, and `tenant` fields.
+      sig do
+        params(
+          schedule_ids: T::Array[String],
+          actor: T.nilable(
+            T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)
+          ),
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          ending_at: T.nilable(Time),
+          repeats: T::Array[T.any(Knockapi::Models::ScheduleRepeatRule, Knockapi::Internal::AnyHash)],
+          scheduled_at: T.nilable(Time),
+          tenant: T.nilable(T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)),
+          request_options: Knockapi::RequestOpts
+        )
+          .returns(T::Array[Knockapi::Models::Schedule])
+      end
+      def update(
+        # A list of schedule IDs.
+        schedule_ids:,
+        # A reference to a recipient, either a user identifier (string) or an object
+        # reference (ID, collection).
+        actor: nil,
+        # An optional map of data to pass into the workflow execution.
+        data: nil,
+        # The ending date and time for the schedule.
+        ending_at: nil,
+        # The repeat rule for the schedule.
+        repeats: nil,
+        # The starting date and time for the schedule.
+        scheduled_at: nil,
+        # An request to set a tenant inline.
+        tenant: nil,
+        request_options: {}
+      ); end
+      # Returns a paginated list of schedules for the current environment, filtered by
+      # workflow and optionally by recipients and tenant.
+      sig do
+        params(
+          workflow: String,
+          after: String,
+          before: String,
+          page_size: Integer,
+          recipients: T::Array[String],
+          tenant: String,
+          request_options: Knockapi::RequestOpts
+        )
+          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Schedule])
+      end
+      def list(
+        # Filter by workflow key.
+        workflow:,
+        # 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 by recipient IDs.
+        recipients: nil,
+        # Filter by tenant ID.
+        tenant: nil,
+        request_options: {}
+      ); end
+      # Permanently deletes one or more schedules identified by the provided schedule
+      # IDs. This operation cannot be undone.
+      sig do
+        params(schedule_ids: T::Array[String], request_options: Knockapi::RequestOpts)
+          .returns(T::Array[Knockapi::Models::Schedule])
+      end
+      def delete(
+        # A list of schedule IDs.
+        schedule_ids:,
+        request_options: {}
+      ); end
+      # @api private
+      sig { params(client: Knockapi::Client).returns(T.attached_class) }
+      def self.new(client:); end
+    end
+  end
+end

data/rbi/knockapi/resources/shared.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Shared
+      # @api private
+      sig { params(client: Knockapi::Client).returns(T.attached_class) }
+      def self.new(client:); end
+    end
+  end
+end

data/rbi/knockapi/resources/tenants/bulk.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Tenants
+      class Bulk
+        # Delete multiple tenants in a single operation. This operation cannot be undone.
+        sig do
+          params(tenant_ids: T::Array[String], request_options: Knockapi::RequestOpts)
+            .returns(Knockapi::Models::BulkOperation)
+        end
+        def delete(
+          # The IDs of the tenants to delete.
+          tenant_ids:,
+          request_options: {}
+        ); end
+        # Set or update up to 1,000 tenants in a single operation.
+        sig do
+          params(
+            tenants: T::Array[T.any(String, Knockapi::Models::TenantRequest, Knockapi::Internal::AnyHash)],
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::BulkOperation)
+        end
+        def set(
+          # The tenants to be upserted.
+          tenants:,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: Knockapi::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end

data/rbi/knockapi/resources/tenants.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Tenants
+      sig { returns(Knockapi::Resources::Tenants::Bulk) }
+      attr_reader :bulk
+
+      # List tenants for the current environment.
+      sig do
+        params(
+          after: String,
+          before: String,
+          name: String,
+          page_size: Integer,
+          tenant_id: String,
+          request_options: Knockapi::RequestOpts
+        )
+          .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Tenant])
+      end
+      def list(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Filter tenants by name.
+        name: nil,
+        # The number of items per page.
+        page_size: nil,
+        # Filter tenants by ID.
+        tenant_id: nil,
+        request_options: {}
+      ); end
+      # Delete a tenant and all associated data. This operation cannot be undone.
+      sig { params(id: String, request_options: Knockapi::RequestOpts).returns(String) }
+      def delete(
+        # The unique identifier for the tenant.
+        id,
+        request_options: {}
+      ); end
+      # Get a tenant by ID.
+      sig { params(id: String, request_options: Knockapi::RequestOpts).returns(Knockapi::Models::Tenant) }
+      def get(
+        # The unique identifier for the tenant.
+        id,
+        request_options: {}
+      ); end
+      # Sets a tenant within an environment, performing an upsert operation. Any
+      # existing properties will be merged with the incoming properties.
+      sig do
+        params(
+          id: String,
+          channel_data: T.nilable(
+            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::ChannelDataRequest, Knockapi::Internal::AnyHash)]
+          ),
+          preferences: T.nilable(
+            T::Hash[Symbol, T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash)]
+          ),
+          settings: T.any(Knockapi::Models::TenantSetParams::Settings, Knockapi::Internal::AnyHash),
+          request_options: Knockapi::RequestOpts
+        )
+          .returns(Knockapi::Models::Tenant)
+      end
+      def set(
+        # The unique identifier for the tenant.
+        id,
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # Inline set preferences for a recipient, where the key is the preference set id.
+        preferences: nil,
+        # The settings for the tenant. Includes branding and preference set.
+        settings: nil,
+        request_options: {}
+      ); end
+      # @api private
+      sig { params(client: Knockapi::Client).returns(T.attached_class) }
+      def self.new(client:); end
+    end
+  end
+end

data/rbi/knockapi/resources/users/bulk.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Users
+      class Bulk
+        # Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+        # delete and returns a bulk operation that can be queried for progress.
+        sig do
+          params(user_ids: T::Array[String], request_options: Knockapi::RequestOpts)
+            .returns(Knockapi::Models::BulkOperation)
+        end
+        def delete(
+          # A list of user IDs.
+          user_ids:,
+          request_options: {}
+        ); end
+        # Identifies multiple users in a single operation. Allows creating or updating up
+        # to 100 users in a single batch with various properties, preferences, and channel
+        # data.
+        sig do
+          params(
+            users: T::Array[T.any(Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Internal::AnyHash)],
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::BulkOperation)
+        end
+        def identify(
+          # A list of users.
+          users:,
+          request_options: {}
+        ); end
+        # Sets preferences for multiple users in a single operation. Supports either
+        # setting the same preferences for multiple users or specific preferences for each
+        # user.
+        sig do
+          params(
+            preferences: T.any(Knockapi::Models::Recipients::PreferenceSetRequest, Knockapi::Internal::AnyHash),
+            user_ids: T::Array[String],
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::BulkOperation)
+        end
+        def set_preferences(
+          # A request to set a preference set for a recipient.
+          preferences:,
+          # A list of user IDs.
+          user_ids:,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: Knockapi::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end

data/rbi/knockapi/resources/users/feeds.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Users
+      class Feeds
+        # Returns the feed settings for a user.
+        sig do
+          params(user_id: String, id: String, request_options: Knockapi::RequestOpts)
+            .returns(Knockapi::Models::Users::FeedGetSettingsResponse)
+        end
+        def get_settings(
+          # The ID for the user that you set when identifying them in Knock.
+          user_id,
+          # The unique identifier for the channel.
+          id,
+          request_options: {}
+        ); end
+        # Returns a paginated list of feed items for a user, including metadata about the
+        # feed.
+        sig do
+          params(
+            user_id: String,
+            id: String,
+            after: String,
+            archived: Knockapi::Models::Users::FeedListItemsParams::Archived::OrSymbol,
+            before: String,
+            has_tenant: T::Boolean,
+            page_size: Integer,
+            source: String,
+            status: Knockapi::Models::Users::FeedListItemsParams::Status::OrSymbol,
+            tenant: String,
+            trigger_data: String,
+            workflow_categories: T::Array[String],
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Internal::EntriesCursor[Knockapi::Models::Users::FeedListItemsResponse])
+        end
+        def list_items(
+          # The ID for the user that you set when identifying them in Knock.
+          user_id,
+          # The unique identifier for the channel.
+          id,
+          # The cursor to fetch entries after.
+          after: nil,
+          # The archived status of the feed items.
+          archived: nil,
+          # The cursor to fetch entries before.
+          before: nil,
+          # Whether the feed items have a tenant.
+          has_tenant: nil,
+          # The number of items per page.
+          page_size: nil,
+          # The source of the feed items.
+          source: nil,
+          # The status of the feed items.
+          status: nil,
+          # The tenant associated with the feed items.
+          tenant: nil,
+          # The trigger data of the feed items (as a JSON string).
+          trigger_data: nil,
+          # The workflow categories of the feed items.
+          workflow_categories: nil,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: Knockapi::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end

data/rbi/knockapi/resources/users/guides.rbi

@@ -0,0 +1,170 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Users
+      class Guides
+        # Returns a list of eligible in-app guides for a specific user and channel.
+        sig do
+          params(
+            user_id: String,
+            channel_id: String,
+            data: String,
+            tenant: String,
+            type: String,
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::Users::GuideGetChannelResponse)
+        end
+        def get_channel(
+          # The ID for the user that you set when identifying them in Knock.
+          user_id,
+          # The unique identifier for the channel.
+          channel_id,
+          # The data (JSON encoded object) to use for targeting and rendering guides.
+          data: nil,
+          # The tenant ID to use for targeting and rendering guides.
+          tenant: nil,
+          # The type of guides to filter by.
+          type: nil,
+          request_options: {}
+        ); end
+        # Records that a guide has been archived by a user, triggering any associated
+        # archived events.
+        sig do
+          params(
+            user_id: String,
+            message_id: String,
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            content: T::Hash[Symbol, T.anything],
+            data: T::Hash[Symbol, T.anything],
+            is_final: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: T.nilable(String),
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse)
+        end
+        def mark_message_as_archived(
+          # The ID for the user that you set when identifying them in Knock.
+          user_id,
+          # The unique identifier for the message.
+          message_id,
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # The content of the guide.
+          content: nil,
+          # The data of the guide.
+          data: nil,
+          # Whether the guide is final.
+          is_final: nil,
+          # The metadata of the guide.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        ); end
+        # Records that a user has interacted with a guide, triggering any associated
+        # interacted events.
+        sig do
+          params(
+            user_id: String,
+            message_id: String,
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            content: T::Hash[Symbol, T.anything],
+            data: T::Hash[Symbol, T.anything],
+            is_final: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: T.nilable(String),
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse)
+        end
+        def mark_message_as_interacted(
+          # The ID for the user that you set when identifying them in Knock.
+          user_id,
+          # The unique identifier for the message.
+          message_id,
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # The content of the guide.
+          content: nil,
+          # The data of the guide.
+          data: nil,
+          # Whether the guide is final.
+          is_final: nil,
+          # The metadata of the guide.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        ); end
+        # Records that a guide has been seen by a user, triggering any associated seen
+        # events.
+        sig do
+          params(
+            user_id: String,
+            message_id: String,
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            content: T::Hash[Symbol, T.anything],
+            data: T::Hash[Symbol, T.anything],
+            is_final: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: T.nilable(String),
+            request_options: Knockapi::RequestOpts
+          )
+            .returns(Knockapi::Models::Users::GuideMarkMessageAsSeenResponse)
+        end
+        def mark_message_as_seen(
+          # The ID for the user that you set when identifying them in Knock.
+          user_id,
+          # The unique identifier for the message.
+          message_id,
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # The content of the guide.
+          content: nil,
+          # The data of the guide.
+          data: nil,
+          # Whether the guide is final.
+          is_final: nil,
+          # The metadata of the guide.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: Knockapi::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end