trycourier 5.0.0 → 6.1.0

data/rbi/courier/models/journey_webhook_trigger_node.rbi

@@ -0,0 +1,174 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyWebhookTriggerNode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyWebhookTriggerNode, Courier::Internal::AnyHash)
+        end
+
+      # The provider key the webhook URL is minted for. Required, and must not contain a
+      # forward slash.
+      sig { returns(String) }
+      attr_accessor :event_source
+
+      sig { returns(Courier::JourneyWebhookTriggerNode::TriggerType::OrSymbol) }
+      attr_accessor :trigger_type
+
+      sig { returns(Courier::JourneyWebhookTriggerNode::Type::OrSymbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+      # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+      # express "no conditions".
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup,
+              Courier::JourneyConditionNestedGroup
+            )
+          )
+        )
+      end
+      attr_reader :conditions
+
+      sig do
+        params(
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            )
+        ).void
+      end
+      attr_writer :conditions
+
+      # An optional event filter, matched against the payload's `event` field. A sender
+      # that supplies no `event` matches the literal `custom`. Must not contain a
+      # forward slash. Omit to accept every event delivered to the URL.
+      sig { returns(T.nilable(String)) }
+      attr_reader :event_id
+
+      sig { params(event_id: String).void }
+      attr_writer :event_id
+
+      # Trigger fired when an external system POSTs to the webhook URL minted for
+      # `event_source`. Narrow it to one event with `event_id`, or omit `event_id` to
+      # accept every event delivered to the URL.
+      sig do
+        params(
+          event_source: String,
+          trigger_type:
+            Courier::JourneyWebhookTriggerNode::TriggerType::OrSymbol,
+          type: Courier::JourneyWebhookTriggerNode::Type::OrSymbol,
+          id: String,
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            ),
+          event_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The provider key the webhook URL is minted for. Required, and must not contain a
+        # forward slash.
+        event_source:,
+        trigger_type:,
+        type:,
+        id: nil,
+        # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+        # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+        # express "no conditions".
+        conditions: nil,
+        # An optional event filter, matched against the payload's `event` field. A sender
+        # that supplies no `event` matches the literal `custom`. Must not contain a
+        # forward slash. Omit to accept every event delivered to the URL.
+        event_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event_source: String,
+            trigger_type:
+              Courier::JourneyWebhookTriggerNode::TriggerType::OrSymbol,
+            type: Courier::JourneyWebhookTriggerNode::Type::OrSymbol,
+            id: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              ),
+            event_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyWebhookTriggerNode::TriggerType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WEBHOOK =
+          T.let(
+            :webhook,
+            Courier::JourneyWebhookTriggerNode::TriggerType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::JourneyWebhookTriggerNode::TriggerType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyWebhookTriggerNode::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRIGGER =
+          T.let(
+            :trigger,
+            Courier::JourneyWebhookTriggerNode::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyWebhookTriggerNode::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys/run_list_params.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Journeys
+      class RunListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Courier::Journeys::RunListParams, Courier::Internal::AnyHash)
+          end
+
+        # A cursor token for pagination. Use the `next_cursor` from the previous response
+        # to fetch the next page of results. Treat it as opaque.
+        sig { returns(T.nilable(String)) }
+        attr_reader :cursor
+
+        sig { params(cursor: String).void }
+        attr_writer :cursor
+
+        # An inclusive upper bound on `created_at`, in the same format as `start_date`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :end_date
+
+        sig { params(end_date: String).void }
+        attr_writer :end_date
+
+        # The number of runs to return per page, between `1` and `50`. Defaults to `20`.
+        # Values outside the range are clamped, and a non-numeric value falls back to
+        # `20`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :limit
+
+        sig { params(limit: String).void }
+        attr_writer :limit
+
+        # An inclusive lower bound on `created_at`, as an ISO 8601 date or timestamp (e.g.
+        # `2026-08-18` or `2026-08-18T20:06:36.259Z`). Any other format returns `400`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :start_date
+
+        sig { params(start_date: String).void }
+        attr_writer :start_date
+
+        # A comma-separated list of run statuses to filter on, e.g. `PROCESSED,ERROR`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # A comma-separated list of Journey ids to filter on.
+        sig { returns(T.nilable(String)) }
+        attr_reader :template_id
+
+        sig { params(template_id: String).void }
+        attr_writer :template_id
+
+        sig do
+          params(
+            cursor: String,
+            end_date: String,
+            limit: String,
+            start_date: String,
+            status: String,
+            template_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A cursor token for pagination. Use the `next_cursor` from the previous response
+          # to fetch the next page of results. Treat it as opaque.
+          cursor: nil,
+          # An inclusive upper bound on `created_at`, in the same format as `start_date`.
+          end_date: nil,
+          # The number of runs to return per page, between `1` and `50`. Defaults to `20`.
+          # Values outside the range are clamped, and a non-numeric value falls back to
+          # `20`.
+          limit: nil,
+          # An inclusive lower bound on `created_at`, as an ISO 8601 date or timestamp (e.g.
+          # `2026-08-18` or `2026-08-18T20:06:36.259Z`). Any other format returns `400`.
+          start_date: nil,
+          # A comma-separated list of run statuses to filter on, e.g. `PROCESSED,ERROR`.
+          status: nil,
+          # A comma-separated list of Journey ids to filter on.
+          template_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              cursor: String,
+              end_date: String,
+              limit: String,
+              start_date: String,
+              status: String,
+              template_id: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys/run_list_steps_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Journeys
+      class RunListStepsParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Journeys::RunListStepsParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :run_id
+
+        sig do
+          params(
+            run_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(run_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { run_id: String, request_options: Courier::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys/run_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Journeys
+      class RunRetrieveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Journeys::RunRetrieveParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :run_id
+
+        sig do
+          params(
+            run_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(run_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { run_id: String, request_options: Courier::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/multiple_tokens.rbi

@@ -8,20 +8,48 @@ module Courier
           T.any(Courier::MultipleTokens, Courier::Internal::AnyHash)
         end
 
-      sig { returns(T::Array[Courier::Token]) }
+      # One device token, or an array of them. The values are the token strings
+      # themselves — not objects.
+      sig { returns(Courier::MultipleTokens::Tokens::Variants) }
       attr_accessor :tokens
 
       sig do
-        params(tokens: T::Array[Courier::Token::OrHash]).returns(
+        params(tokens: Courier::MultipleTokens::Tokens::Variants).returns(
           T.attached_class
         )
       end
-      def self.new(tokens:)
+      def self.new(
+        # One device token, or an array of them. The values are the token strings
+        # themselves — not objects.
+        tokens:
+      )
       end
 
-      sig { override.returns({ tokens: T::Array[Courier::Token] }) }
+      sig do
+        override.returns({ tokens: Courier::MultipleTokens::Tokens::Variants })
+      end
       def to_hash
       end
+
+      # One device token, or an array of them. The values are the token strings
+      # themselves — not objects.
+      module Tokens
+        extend Courier::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(String, T::Array[String]) }
+
+        sig do
+          override.returns(T::Array[Courier::MultipleTokens::Tokens::Variants])
+        end
+        def self.variants
+        end
+
+        StringArray =
+          T.let(
+            Courier::Internal::Type::ArrayOf[String],
+            Courier::Internal::Type::Converter
+          )
+      end
     end
   end
 end

data/rbi/courier/models/user_profile.rbi

@@ -20,7 +20,10 @@ module Courier
       sig { params(airship: T.nilable(Courier::AirshipProfile::OrHash)).void }
       attr_writer :airship
 
-      sig { returns(T.nilable(String)) }
+      # Apple Push Notification device tokens. Supply either a single `token` or a
+      # `tokens` value. A bare string is rejected by the provider — the token must be
+      # wrapped in this object.
+      sig { returns(T.nilable(T.any(Courier::Token, Courier::MultipleTokens))) }
       attr_accessor :apn
 
       # Routes a push notification through the AWS SNS provider. The target ARN must be
@@ -53,6 +56,7 @@ module Courier
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :email_verified
 
+      # Expo push tokens. Supply either a single `token` or a `tokens` value.
       sig { returns(T.nilable(T.any(Courier::Token, Courier::MultipleTokens))) }
       attr_accessor :expo
 
@@ -148,7 +152,10 @@ module Courier
         params(
           address: T.nilable(Courier::UserProfile::Address::OrHash),
           airship: T.nilable(Courier::AirshipProfile::OrHash),
-          apn: T.nilable(String),
+          apn:
+            T.nilable(
+              T.any(Courier::Token::OrHash, Courier::MultipleTokens::OrHash)
+            ),
           aws_sns: T.nilable(Courier::AwsSns::OrHash),
           birthdate: T.nilable(String),
           custom: T.nilable(T::Hash[Symbol, T.anything]),
@@ -208,6 +215,9 @@ module Courier
       def self.new(
         address: nil,
         airship: nil,
+        # Apple Push Notification device tokens. Supply either a single `token` or a
+        # `tokens` value. A bare string is rejected by the provider — the token must be
+        # wrapped in this object.
         apn: nil,
         # Routes a push notification through the AWS SNS provider. The target ARN must be
         # nested under `aws_sns` — a top-level `target_arn` on the profile is ignored by
@@ -220,6 +230,7 @@ module Courier
         discord: nil,
         email: nil,
         email_verified: nil,
+        # Expo push tokens. Supply either a single `token` or a `tokens` value.
         expo: nil,
         facebook_psid: nil,
         family_name: nil,
@@ -250,7 +261,7 @@ module Courier
           {
             address: T.nilable(Courier::UserProfile::Address),
             airship: T.nilable(Courier::AirshipProfile),
-            apn: T.nilable(String),
+            apn: T.nilable(T.any(Courier::Token, Courier::MultipleTokens)),
             aws_sns: T.nilable(Courier::AwsSns),
             birthdate: T.nilable(String),
             custom: T.nilable(T::Hash[Symbol, T.anything]),

data/rbi/courier/models/users/topic_preference.rbi

@@ -43,6 +43,24 @@ module Courier
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :has_custom_routing
 
+        # The unique identifier of the section this topic belongs to. Always present when
+        # listing a user's preferences; omitted by the single-topic read when the topic
+        # has no resolvable section.
+        sig { returns(T.nilable(String)) }
+        attr_reader :section_id
+
+        sig { params(section_id: String).void }
+        attr_writer :section_id
+
+        # The display name of the section this topic belongs to. Always present when
+        # listing a user's preferences; omitted by the single-topic read when the topic
+        # has no resolvable section.
+        sig { returns(T.nilable(String)) }
+        attr_reader :section_name
+
+        sig { params(section_name: String).void }
+        attr_writer :section_name
+
         sig do
           params(
             default_status: Courier::PreferenceStatus::OrSymbol,
@@ -51,7 +69,9 @@ module Courier
             topic_name: String,
             custom_routing:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
-            has_custom_routing: T.nilable(T::Boolean)
+            has_custom_routing: T.nilable(T::Boolean),
+            section_id: String,
+            section_name: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -72,7 +92,15 @@ module Courier
           custom_routing: nil,
           # Whether the user has chosen specific delivery channels for this topic (listed in
           # custom_routing) rather than the topic's default routing.
-          has_custom_routing: nil
+          has_custom_routing: nil,
+          # The unique identifier of the section this topic belongs to. Always present when
+          # listing a user's preferences; omitted by the single-topic read when the topic
+          # has no resolvable section.
+          section_id: nil,
+          # The display name of the section this topic belongs to. Always present when
+          # listing a user's preferences; omitted by the single-topic read when the topic
+          # has no resolvable section.
+          section_name: nil
         )
         end
 
@@ -87,7 +115,9 @@ module Courier
                 T.nilable(
                   T::Array[Courier::ChannelClassification::TaggedSymbol]
                 ),
-              has_custom_routing: T.nilable(T::Boolean)
+              has_custom_routing: T.nilable(T::Boolean),
+              section_id: String,
+              section_name: String
             }
           )
         end

data/rbi/courier/models.rbi

@@ -7,6 +7,8 @@ module Courier
 
   Alignment = Courier::Models::Alignment
 
+  Apn = Courier::Models::Apn
+
   AssociatedNotificationListResponse =
     Courier::Models::AssociatedNotificationListResponse
 
@@ -40,6 +42,14 @@ module Courier
 
   AutomationListParams = Courier::Models::AutomationListParams
 
+  AutomationRunListItem = Courier::Models::AutomationRunListItem
+
+  AutomationRunListResponse = Courier::Models::AutomationRunListResponse
+
+  AutomationRunStep = Courier::Models::AutomationRunStep
+
+  AutomationRunStepsResponse = Courier::Models::AutomationRunStepsResponse
+
   Automations = Courier::Models::Automations
 
   AutomationTemplate = Courier::Models::AutomationTemplate
@@ -208,6 +218,8 @@ module Courier
 
   JourneyArchiveParams = Courier::Models::JourneyArchiveParams
 
+  JourneyAudienceTriggerNode = Courier::Models::JourneyAudienceTriggerNode
+
   JourneyCancelParams = Courier::Models::JourneyCancelParams
 
   JourneyConditionAtom =
@@ -258,6 +270,18 @@ module Courier
 
   JourneyRetrieveParams = Courier::Models::JourneyRetrieveParams
 
+  JourneyRun = Courier::Models::JourneyRun
+
+  JourneyRunListItem = Courier::Models::JourneyRunListItem
+
+  JourneyRunListResponse = Courier::Models::JourneyRunListResponse
+
+  JourneyRunResponse = Courier::Models::JourneyRunResponse
+
+  JourneyRunStep = Courier::Models::JourneyRunStep
+
+  JourneyRunStepsResponse = Courier::Models::JourneyRunStepsResponse
+
   Journeys = Courier::Models::Journeys
 
   JourneySegmentTriggerNode = Courier::Models::JourneySegmentTriggerNode
@@ -292,6 +316,8 @@ module Courier
 
   JourneyVersionsListResponse = Courier::Models::JourneyVersionsListResponse
 
+  JourneyWebhookTriggerNode = Courier::Models::JourneyWebhookTriggerNode
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter
@@ -362,8 +388,6 @@ module Courier
 
   NotificationCreateParams = Courier::Models::NotificationCreateParams
 
-  NotificationDuplicateParams = Courier::Models::NotificationDuplicateParams
-
   NotificationElementPutRequest = Courier::Models::NotificationElementPutRequest
 
   NotificationGetContent = Courier::Models::NotificationGetContent

data/rbi/courier/resources/automations/runs.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Automations
+      # Invoke a stored automation template or an ad hoc automation defined in the
+      # request.
+      class Runs
+        # List runs of the workspace's v2 Automations, newest first, filtered by status,
+        # Template, or date range and paged by cursor. Journey (v3) runs are listed by
+        # `GET /journeys/runs` instead — the two surfaces never return each other's runs.
+        # Runs are retained for 95 days.
+        sig do
+          params(
+            cursor: String,
+            end_date: String,
+            limit: String,
+            start_date: String,
+            status: String,
+            template_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::AutomationRunListResponse)
+        end
+        def list(
+          # A cursor token for pagination. Use the `next_cursor` from the previous response
+          # to fetch the next page of results. Treat it as opaque.
+          cursor: nil,
+          # An inclusive upper bound on `created_at`, in the same format as `start_date`.
+          end_date: nil,
+          # The number of runs to return per page, between `1` and `50`. Defaults to `20`.
+          # Values outside the range are clamped, and a non-numeric value falls back to
+          # `20`.
+          limit: nil,
+          # An inclusive lower bound on `created_at`, as an ISO 8601 date or timestamp (e.g.
+          # `2026-08-18` or `2026-08-18T20:06:36.259Z`). Any other format returns `400`.
+          start_date: nil,
+          # A comma-separated list of run statuses to filter on, e.g. `PROCESSED,ERROR`.
+          status: nil,
+          # A comma-separated list of Automation Template ids to filter on.
+          template_id: nil,
+          request_options: {}
+        )
+        end
+
+        # List the per-step state of one Automation run, in full — this endpoint is not
+        # paginated. `message_id` is present on send steps that produced a message; follow
+        # it to `GET /messages/{message_id}` for delivery status. A send to a List or an
+        # Audience yields one `message_id` for the request, not one per recipient.
+        sig do
+          params(
+            id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::AutomationRunStepsResponse)
+        end
+        def list_steps(
+          # A unique identifier representing the Automation run.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Courier::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/courier/resources/automations.rbi

@@ -10,6 +10,11 @@ module Courier
       sig { returns(Courier::Resources::Automations::Invoke) }
       attr_reader :invoke
 
+      # Invoke a stored automation template or an ad hoc automation defined in the
+      # request.
+      sig { returns(Courier::Resources::Automations::Runs) }
+      attr_reader :runs
+
       # Lists the workspace's saved automation templates, each with its id and a cursor
       # for paging to the next page of results.
       sig do