knockapi 1.35.0 → 1.36.0

data/rbi/knockapi/models/workflow_recipient_run_list_params.rbi

@@ -0,0 +1,229 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowRecipientRunListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::WorkflowRecipientRunListParams,
+            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 workflow recipient runs started before the given date.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :ending_at
+
+      sig { params(ending_at: Time).void }
+      attr_writer :ending_at
+
+      # Limits the results to workflow recipient runs that have errors.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_errors
+
+      sig { params(has_errors: T::Boolean).void }
+      attr_writer :has_errors
+
+      # The number of items per page (defaults to 50).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Limits the results to workflow recipient runs for the given recipient. Accepts a
+      # user ID string or an object reference with `id` and `collection`.
+      sig do
+        returns(
+          T.nilable(
+            T.any(String, Knockapi::RecipientReference::ObjectReference)
+          )
+        )
+      end
+      attr_reader :recipient
+
+      sig do
+        params(
+          recipient:
+            T.any(String, Knockapi::RecipientReference::ObjectReference::OrHash)
+        ).void
+      end
+      attr_writer :recipient
+
+      # Limits the results to workflow recipient runs started after the given date.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :starting_at
+
+      sig { params(starting_at: Time).void }
+      attr_writer :starting_at
+
+      # Limits the results to workflow recipient runs with the given status.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Knockapi::WorkflowRecipientRunListParams::Status::OrSymbol]
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            T::Array[Knockapi::WorkflowRecipientRunListParams::Status::OrSymbol]
+        ).void
+      end
+      attr_writer :status
+
+      # Limits the results to workflow recipient runs for the given tenant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant
+
+      sig { params(tenant: String).void }
+      attr_writer :tenant
+
+      # Limits the results to workflow recipient runs for the given workflow key.
+      sig { returns(T.nilable(String)) }
+      attr_reader :workflow
+
+      sig { params(workflow: String).void }
+      attr_writer :workflow
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          ending_at: Time,
+          has_errors: T::Boolean,
+          page_size: Integer,
+          recipient:
+            T.any(
+              String,
+              Knockapi::RecipientReference::ObjectReference::OrHash
+            ),
+          starting_at: Time,
+          status:
+            T::Array[
+              Knockapi::WorkflowRecipientRunListParams::Status::OrSymbol
+            ],
+          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,
+        # Limits the results to workflow recipient runs started before the given date.
+        ending_at: nil,
+        # Limits the results to workflow recipient runs that have errors.
+        has_errors: nil,
+        # The number of items per page (defaults to 50).
+        page_size: nil,
+        # Limits the results to workflow recipient runs for the given recipient. Accepts a
+        # user ID string or an object reference with `id` and `collection`.
+        recipient: nil,
+        # Limits the results to workflow recipient runs started after the given date.
+        starting_at: nil,
+        # Limits the results to workflow recipient runs with the given status.
+        status: nil,
+        # Limits the results to workflow recipient runs for the given tenant.
+        tenant: nil,
+        # Limits the results to workflow recipient runs for the given workflow key.
+        workflow: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            ending_at: Time,
+            has_errors: T::Boolean,
+            page_size: Integer,
+            recipient:
+              T.any(String, Knockapi::RecipientReference::ObjectReference),
+            starting_at: Time,
+            status:
+              T::Array[
+                Knockapi::WorkflowRecipientRunListParams::Status::OrSymbol
+              ],
+            tenant: String,
+            workflow: String,
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Knockapi::WorkflowRecipientRunListParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUED =
+          T.let(
+            :queued,
+            Knockapi::WorkflowRecipientRunListParams::Status::TaggedSymbol
+          )
+        PROCESSING =
+          T.let(
+            :processing,
+            Knockapi::WorkflowRecipientRunListParams::Status::TaggedSymbol
+          )
+        PAUSED =
+          T.let(
+            :paused,
+            Knockapi::WorkflowRecipientRunListParams::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(
+            :completed,
+            Knockapi::WorkflowRecipientRunListParams::Status::TaggedSymbol
+          )
+        CANCELLED =
+          T.let(
+            :cancelled,
+            Knockapi::WorkflowRecipientRunListParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Knockapi::WorkflowRecipientRunListParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -45,11 +45,11 @@ module Knockapi
       end
       attr_accessor :actor
 
-      # An optional key that is used to reference a specific workflow trigger request
-      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-      # request. Must be provided while triggering a workflow in order to enable
-      # subsequent cancellation. Should be unique across trigger requests to avoid
-      # unintentional cancellations.
+      # A key that is used to reference a specific workflow trigger request when issuing
+      # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+      # be provided while triggering a workflow in order to enable subsequent
+      # cancellation. Should be unique across trigger requests to avoid unintentional
+      # cancellations.
       sig { returns(T.nilable(String)) }
       attr_accessor :cancellation_key
 
@@ -60,6 +60,17 @@ module Knockapi
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :data
 
+      # Optional settings that control how this workflow trigger is executed.
+      sig { returns(T.nilable(Knockapi::WorkflowTriggerParams::Settings)) }
+      attr_reader :settings
+
+      sig do
+        params(
+          settings: T.nilable(Knockapi::WorkflowTriggerParams::Settings::OrHash)
+        ).void
+      end
+      attr_writer :settings
+
       # An request to set a tenant inline.
       sig { returns(T.nilable(T.any(String, Knockapi::TenantRequest))) }
       attr_accessor :tenant
@@ -85,6 +96,8 @@ module Knockapi
             ),
           cancellation_key: T.nilable(String),
           data: T.nilable(T::Hash[Symbol, T.anything]),
+          settings:
+            T.nilable(Knockapi::WorkflowTriggerParams::Settings::OrHash),
           tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -98,17 +111,19 @@ module Knockapi
         # (string), an inline user request (object), or an inline object request, which is
         # determined by the presence of a `collection` property.
         actor: nil,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key: nil,
         # An optional map of data to pass into the workflow execution. There is a 10MB
         # limit on the size of the full `data` payload. Any individual string value
         # greater than 1024 bytes in length will be
         # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
+        # Optional settings that control how this workflow trigger is executed.
+        settings: nil,
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}
@@ -137,6 +152,7 @@ module Knockapi
               ),
             cancellation_key: T.nilable(String),
             data: T.nilable(T::Hash[Symbol, T.anything]),
+            settings: T.nilable(Knockapi::WorkflowTriggerParams::Settings),
             tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
             request_options: Knockapi::RequestOptions
           }
@@ -144,6 +160,56 @@ module Knockapi
       end
       def to_hash
       end
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::WorkflowTriggerParams::Settings,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # When set to true, overrides the sandbox mode for all channels in this workflow
+        # run, messages are not delivered to the underlying providers. If false or not
+        # set, the workflow delivers messages normally.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :sandbox_mode
+
+        # When set to true, skips all delay steps in the workflow for this trigger
+        # request. If false or not set, delay steps execute normally.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :skip_delay
+
+        # Optional settings that control how this workflow trigger is executed.
+        sig do
+          params(
+            sandbox_mode: T.nilable(T::Boolean),
+            skip_delay: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # When set to true, overrides the sandbox mode for all channels in this workflow
+          # run, messages are not delivered to the underlying providers. If false or not
+          # set, the workflow delivers messages normally.
+          sandbox_mode: nil,
+          # When set to true, skips all delay steps in the workflow for this trigger
+          # request. If false or not set, delay steps execute normally.
+          skip_delay: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              sandbox_mode: T.nilable(T::Boolean),
+              skip_delay: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/knockapi/models.rbi

@@ -101,6 +101,8 @@ module Knockapi
 
   ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
 
+  ObjectUnsetPreferencesParams = Knockapi::Models::ObjectUnsetPreferencesParams
+
   PageInfo = Knockapi::Models::PageInfo
 
   Providers = Knockapi::Models::Providers
@@ -171,9 +173,23 @@ module Knockapi
 
   UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
 
+  UserUnsetPreferencesParams = Knockapi::Models::UserUnsetPreferencesParams
+
   UserUpdateParams = Knockapi::Models::UserUpdateParams
 
   WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
 
+  WorkflowRecipientRun = Knockapi::Models::WorkflowRecipientRun
+
+  WorkflowRecipientRunDetail = Knockapi::Models::WorkflowRecipientRunDetail
+
+  WorkflowRecipientRunEvent = Knockapi::Models::WorkflowRecipientRunEvent
+
+  WorkflowRecipientRunGetParams =
+    Knockapi::Models::WorkflowRecipientRunGetParams
+
+  WorkflowRecipientRunListParams =
+    Knockapi::Models::WorkflowRecipientRunListParams
+
   WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
 end

data/rbi/knockapi/resources/objects.rbi

@@ -532,6 +532,26 @@ module Knockapi
       )
       end
 
+      # Unsets the preference set for the object, removing it entirely.
+      sig do
+        params(
+          collection: String,
+          object_id_: String,
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).void
+      end
+      def unset_preferences(
+        # The collection this object belongs to.
+        collection,
+        # Unique identifier for the object.
+        object_id_,
+        # Unique identifier for the preference set.
+        id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
       def self.new(client:)

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

@@ -43,13 +43,15 @@ module Knockapi
         # the preferences sent.
         sig do
           params(
-            preferences: Knockapi::Recipients::PreferenceSetRequest::OrHash,
+            preferences:
+              Knockapi::Users::BulkSetPreferencesParams::Preferences::OrHash,
             user_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
           ).returns(Knockapi::BulkOperation)
         end
         def set_preferences(
-          # A request to set a preference set for a recipient.
+          # A preference set to apply in a bulk operation. Always replaces existing
+          # preferences for the specified set.
           preferences:,
           # A list of user IDs.
           user_ids:,

data/rbi/knockapi/resources/users.rbi

@@ -464,6 +464,23 @@ module Knockapi
       )
       end
 
+      # Unsets the preference set for the user, removing it entirely.
+      sig do
+        params(
+          user_id: String,
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).void
+      end
+      def unset_preferences(
+        # The unique identifier of the user.
+        user_id,
+        # Unique identifier for the preference set.
+        id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/knockapi/resources/workflow_recipient_runs.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    # A workflow run represents an individual execution of a workflow for a specific
+    # recipient.
+    class WorkflowRecipientRuns
+      # Returns a paginated list of workflow recipient runs for the current environment.
+      sig do
+        params(
+          after: String,
+          before: String,
+          ending_at: Time,
+          has_errors: T::Boolean,
+          page_size: Integer,
+          recipient:
+            T.any(
+              String,
+              Knockapi::RecipientReference::ObjectReference::OrHash
+            ),
+          starting_at: Time,
+          status:
+            T::Array[
+              Knockapi::WorkflowRecipientRunListParams::Status::OrSymbol
+            ],
+          tenant: String,
+          workflow: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(
+          Knockapi::Internal::ItemsCursor[Knockapi::WorkflowRecipientRun]
+        )
+      end
+      def list(
+        # The cursor to fetch entries after.
+        after: nil,
+        # The cursor to fetch entries before.
+        before: nil,
+        # Limits the results to workflow recipient runs started before the given date.
+        ending_at: nil,
+        # Limits the results to workflow recipient runs that have errors.
+        has_errors: nil,
+        # The number of items per page (defaults to 50).
+        page_size: nil,
+        # Limits the results to workflow recipient runs for the given recipient. Accepts a
+        # user ID string or an object reference with `id` and `collection`.
+        recipient: nil,
+        # Limits the results to workflow recipient runs started after the given date.
+        starting_at: nil,
+        # Limits the results to workflow recipient runs with the given status.
+        status: nil,
+        # Limits the results to workflow recipient runs for the given tenant.
+        tenant: nil,
+        # Limits the results to workflow recipient runs for the given workflow key.
+        workflow: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a single workflow recipient run with its associated events.
+      sig do
+        params(
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::WorkflowRecipientRunDetail)
+      end
+      def get(
+        # The unique identifier for the workflow recipient run (per-recipient).
+        id,
+        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/workflows.rbi

@@ -27,11 +27,11 @@ module Knockapi
       def cancel(
         # The key of the workflow to cancel.
         key,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key:,
         # A list of recipients to cancel the notification for. If omitted, cancels for all
         # recipients associated with the cancellation key.
@@ -66,6 +66,8 @@ module Knockapi
             ),
           cancellation_key: T.nilable(String),
           data: T.nilable(T::Hash[Symbol, T.anything]),
+          settings:
+            T.nilable(Knockapi::WorkflowTriggerParams::Settings::OrHash),
           tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(Knockapi::Models::WorkflowTriggerResponse)
@@ -80,17 +82,19 @@ module Knockapi
         # (string), an inline user request (object), or an inline object request, which is
         # determined by the presence of a `collection` property.
         actor: nil,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key: nil,
         # An optional map of data to pass into the workflow execution. There is a 10MB
         # limit on the size of the full `data` payload. Any individual string value
         # greater than 1024 bytes in length will be
         # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
+        # Optional settings that control how this workflow trigger is executed.
+        settings: nil,
         # An request to set a tenant inline.
         tenant: nil,
         request_options: {}

data/sig/knockapi/client.rbs

@@ -30,6 +30,8 @@ module Knockapi
 
     attr_reader workflows: Knockapi::Resources::Workflows
 
+    attr_reader workflow_recipient_runs: Knockapi::Resources::WorkflowRecipientRuns
+
     attr_reader schedules: Knockapi::Resources::Schedules
 
     attr_reader channels: Knockapi::Resources::Channels

data/sig/knockapi/internal/util.rbs

@@ -45,8 +45,12 @@ module Knockapi
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]

data/sig/knockapi/models/condition.rbs

@@ -40,6 +40,7 @@ module Knockapi
         | :exists
         | :not_exists
         | :contains_all
+        | :not_contains_all
         | :is_timestamp
         | :is_not_timestamp
         | :is_timestamp_on_or_after
@@ -67,6 +68,7 @@ module Knockapi
         EXISTS: :exists
         NOT_EXISTS: :not_exists
         CONTAINS_ALL: :contains_all
+        NOT_CONTAINS_ALL: :not_contains_all
         IS_TIMESTAMP: :is_timestamp
         IS_NOT_TIMESTAMP: :is_not_timestamp
         IS_TIMESTAMP_ON_OR_AFTER: :is_timestamp_on_or_after

data/sig/knockapi/models/message.rbs

@@ -20,6 +20,7 @@ module Knockapi
         link_clicked_at: Time?,
         metadata: ::Hash[Symbol, top]?,
         read_at: Time?,
+        recipient_snapshot: Knockapi::Message::RecipientSnapshot?,
         scheduled_at: Time?,
         seen_at: Time?,
         tenant: String?,
@@ -69,6 +70,8 @@ module Knockapi
 
       attr_accessor read_at: Time?
 
+      attr_accessor recipient_snapshot: Knockapi::Message::RecipientSnapshot?
+
       attr_accessor scheduled_at: Time?
 
       attr_accessor seen_at: Time?
@@ -96,6 +99,7 @@ module Knockapi
         ?link_clicked_at: Time?,
         ?metadata: ::Hash[Symbol, top]?,
         ?read_at: Time?,
+        ?recipient_snapshot: Knockapi::Message::RecipientSnapshot?,
         ?scheduled_at: Time?,
         ?seen_at: Time?,
         ?tenant: String?,
@@ -121,6 +125,7 @@ module Knockapi
         link_clicked_at: Time?,
         metadata: ::Hash[Symbol, top]?,
         read_at: Time?,
+        recipient_snapshot: Knockapi::Message::RecipientSnapshot?,
         scheduled_at: Time?,
         seen_at: Time?,
         tenant: String?,
@@ -304,6 +309,20 @@ module Knockapi
           def self?.values: -> ::Array[Knockapi::Models::Message::Channel::type_]
         end
       end
+
+      type recipient_snapshot = { email: String, name: String? }
+
+      class RecipientSnapshot < Knockapi::Internal::Type::BaseModel
+        attr_reader email: String?
+
+        def email=: (String) -> String
+
+        attr_accessor name: String?
+
+        def initialize: (?email: String, ?name: String?) -> void
+
+        def to_hash: -> { email: String, name: String? }
+      end
     end
   end
 end