trycourier 6.0.0 → 6.2.0

data/rbi/courier/models/notification_metrics_response.rbi

@@ -0,0 +1,269 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationMetricsResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationMetricsResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # End of the window actually queried, ceiled onto the granularity grid.
+      # Second-precision UTC.
+      sig { returns(Time) }
+      attr_accessor :end_
+
+      # Bucket size the series was built at.
+      sig do
+        returns(Courier::NotificationMetricsResponse::Granularity::TaggedSymbol)
+      end
+      attr_accessor :granularity
+
+      # The template the series describes, echoed from the request.
+      sig { returns(String) }
+      attr_accessor :notification_id
+
+      # One entry per bucket between `start` and `end`, oldest first, including buckets
+      # with no activity.
+      sig { returns(T::Array[Courier::NotificationMetricsResponse::Series]) }
+      attr_accessor :series
+
+      # Inclusive start of the window actually queried, floored onto the granularity
+      # grid. Second-precision UTC.
+      sig { returns(Time) }
+      attr_accessor :start
+
+      sig do
+        params(
+          end_: Time,
+          granularity:
+            Courier::NotificationMetricsResponse::Granularity::OrSymbol,
+          notification_id: String,
+          series:
+            T::Array[Courier::NotificationMetricsResponse::Series::OrHash],
+          start: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # End of the window actually queried, ceiled onto the granularity grid.
+        # Second-precision UTC.
+        end_:,
+        # Bucket size the series was built at.
+        granularity:,
+        # The template the series describes, echoed from the request.
+        notification_id:,
+        # One entry per bucket between `start` and `end`, oldest first, including buckets
+        # with no activity.
+        series:,
+        # Inclusive start of the window actually queried, floored onto the granularity
+        # grid. Second-precision UTC.
+        start:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            end_: Time,
+            granularity:
+              Courier::NotificationMetricsResponse::Granularity::TaggedSymbol,
+            notification_id: String,
+            series: T::Array[Courier::NotificationMetricsResponse::Series],
+            start: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Bucket size the series was built at.
+      module Granularity
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationMetricsResponse::Granularity)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HOUR =
+          T.let(
+            :HOUR,
+            Courier::NotificationMetricsResponse::Granularity::TaggedSymbol
+          )
+        DAY =
+          T.let(
+            :DAY,
+            Courier::NotificationMetricsResponse::Granularity::TaggedSymbol
+          )
+        WEEK =
+          T.let(
+            :WEEK,
+            Courier::NotificationMetricsResponse::Granularity::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :MONTH,
+            Courier::NotificationMetricsResponse::Granularity::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationMetricsResponse::Granularity::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Series < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationMetricsResponse::Series,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # One entry per provider and channel that handled a message in this bucket. Empty
+        # when nothing was sent.
+        sig do
+          returns(T::Array[Courier::NotificationMetricsResponse::Series::Data])
+        end
+        attr_accessor :data
+
+        # Start of the bucket, second-precision UTC.
+        sig { returns(Time) }
+        attr_accessor :period
+
+        sig do
+          params(
+            data:
+              T::Array[
+                Courier::NotificationMetricsResponse::Series::Data::OrHash
+              ],
+            period: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # One entry per provider and channel that handled a message in this bucket. Empty
+          # when nothing was sent.
+          data:,
+          # Start of the bucket, second-precision UTC.
+          period:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                T::Array[Courier::NotificationMetricsResponse::Series::Data],
+              period: Time
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::NotificationMetricsResponse::Series::Data,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          # Channel the provider delivered on, e.g. `email`.
+          sig { returns(String) }
+          attr_accessor :channel
+
+          # Messages with at least one tracked link click.
+          sig { returns(Integer) }
+          attr_accessor :clicked
+
+          # Messages the provider confirmed as delivered.
+          sig { returns(Integer) }
+          attr_accessor :delivered
+
+          # Messages the provider rejected or failed on, including ones a later provider
+          # then delivered.
+          sig { returns(Integer) }
+          attr_accessor :errors
+
+          # Messages opened at least once. Always `0` on channels with no open tracking.
+          sig { returns(Integer) }
+          attr_accessor :opened
+
+          # Provider that handled the messages, e.g. `sendgrid`.
+          sig { returns(String) }
+          attr_accessor :provider
+
+          # Messages handed to the provider.
+          sig { returns(Integer) }
+          attr_accessor :sent
+
+          # Messages Courier could not deliver on any provider for the channel.
+          sig { returns(Integer) }
+          attr_accessor :undeliverable
+
+          sig do
+            params(
+              channel: String,
+              clicked: Integer,
+              delivered: Integer,
+              errors: Integer,
+              opened: Integer,
+              provider: String,
+              sent: Integer,
+              undeliverable: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Channel the provider delivered on, e.g. `email`.
+            channel:,
+            # Messages with at least one tracked link click.
+            clicked:,
+            # Messages the provider confirmed as delivered.
+            delivered:,
+            # Messages the provider rejected or failed on, including ones a later provider
+            # then delivered.
+            errors:,
+            # Messages opened at least once. Always `0` on channels with no open tracking.
+            opened:,
+            # Provider that handled the messages, e.g. `sendgrid`.
+            provider:,
+            # Messages handed to the provider.
+            sent:,
+            # Messages Courier could not deliver on any provider for the channel.
+            undeliverable:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                channel: String,
+                clicked: Integer,
+                delivered: Integer,
+                errors: Integer,
+                opened: Integer,
+                provider: String,
+                sent: Integer,
+                undeliverable: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -42,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
@@ -210,6 +218,8 @@ module Courier
 
   JourneyArchiveParams = Courier::Models::JourneyArchiveParams
 
+  JourneyAudienceTriggerNode = Courier::Models::JourneyAudienceTriggerNode
+
   JourneyCancelParams = Courier::Models::JourneyCancelParams
 
   JourneyConditionAtom =
@@ -260,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
@@ -294,6 +316,8 @@ module Courier
 
   JourneyVersionsListResponse = Courier::Models::JourneyVersionsListResponse
 
+  JourneyWebhookTriggerNode = Courier::Models::JourneyWebhookTriggerNode
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter
@@ -368,6 +392,8 @@ module Courier
 
   NotificationGetContent = Courier::Models::NotificationGetContent
 
+  NotificationGetMetricsParams = Courier::Models::NotificationGetMetricsParams
+
   NotificationListParams = Courier::Models::NotificationListParams
 
   NotificationListVersionsParams =
@@ -375,6 +401,8 @@ module Courier
 
   NotificationLocalePutRequest = Courier::Models::NotificationLocalePutRequest
 
+  NotificationMetricsResponse = Courier::Models::NotificationMetricsResponse
+
   NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
   NotificationPublishParams = Courier::Models::NotificationPublishParams

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

data/rbi/courier/resources/journeys/runs.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Journeys
+      # Build, version, publish, invoke, and cancel multi-step notification workflows,
+      # along with the templates scoped to them.
+      class Runs
+        # Fetch one Journey run by id. Returns `404` for an unknown run, a run belonging
+        # to another workspace, a run past the 95-day retention window, or an Automation
+        # run id — the same body in every case, so the response never reveals whether a
+        # run exists elsewhere.
+        sig do
+          params(
+            run_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::JourneyRunResponse)
+        end
+        def retrieve(
+          # A unique identifier representing the Journey run.
+          run_id,
+          request_options: {}
+        )
+        end
+
+        # List runs of the workspace's Journeys, newest first, filtered by status,
+        # Journey, or date range and paged by cursor. Runs of v2 Automations are listed by
+        # `GET /automations/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::JourneyRunListResponse)
+        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 Journey ids to filter on.
+          template_id: nil,
+          request_options: {}
+        )
+        end
+
+        # List the per-node state of one Journey run, in full — this endpoint is not
+        # paginated. Each step's `node_id` is the id of the node in the published Journey,
+        # so a step maps directly onto the Journey graph. `message_id` is present on send
+        # steps that produced a message; follow it to `GET /messages/{message_id}` for
+        # delivery status.
+        sig do
+          params(
+            run_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::JourneyRunStepsResponse)
+        end
+        def list_steps(
+          # A unique identifier representing the Journey run.
+          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/journeys.rbi

@@ -10,6 +10,11 @@ module Courier
       sig { returns(Courier::Resources::Journeys::Templates) }
       attr_reader :templates
 
+      # Build, version, publish, invoke, and cancel multi-step notification workflows,
+      # along with the templates scoped to them.
+      sig { returns(Courier::Resources::Journeys::Runs) }
+      attr_reader :runs
+
       # Creates a journey from a set of nodes, in draft state unless you pass a
       # published state. Send nodes cannot be included until their templates exist.
       sig do
@@ -20,6 +25,8 @@ module Courier
               T.any(
                 Courier::JourneyAPIInvokeTriggerNode::OrHash,
                 Courier::JourneySegmentTriggerNode::OrHash,
+                Courier::JourneyAudienceTriggerNode::OrHash,
+                Courier::JourneyWebhookTriggerNode::OrHash,
                 Courier::JourneySendNode::OrHash,
                 Courier::JourneyDelayDurationNode::OrHash,
                 Courier::JourneyDelayUntilNode::OrHash,
@@ -260,6 +267,8 @@ module Courier
               T.any(
                 Courier::JourneyAPIInvokeTriggerNode::OrHash,
                 Courier::JourneySegmentTriggerNode::OrHash,
+                Courier::JourneyAudienceTriggerNode::OrHash,
+                Courier::JourneyWebhookTriggerNode::OrHash,
                 Courier::JourneySendNode::OrHash,
                 Courier::JourneyDelayDurationNode::OrHash,
                 Courier::JourneyDelayUntilNode::OrHash,

data/rbi/courier/resources/notifications.rbi

@@ -99,6 +99,63 @@ module Courier
       )
       end
 
+      # Fetch the delivery funnel for one Notification Template as a time series — sent,
+      # delivered, opened, clicked, errors, and undeliverable — broken out per provider
+      # and channel inside each bucket. Sum the entries in a bucket for its totals;
+      # there is no bucket-level total.
+      #
+      # Choose the window absolutely with `start` and `end`, or relatively with
+      # `lookback` (an ISO 8601 duration). `start` and `end` take precedence when both
+      # are supplied, and a request carrying neither defaults to `lookback=P30D`. The
+      # window is snapped outwards onto the `granularity` grid so every bucket it
+      # overlaps is returned whole, and the snapped boundaries come back as `start` and
+      # `end` — align a chart on those rather than on what was requested. Every boundary
+      # is UTC; there is no timezone support.
+      #
+      # Every bucket in the window is returned, including the quiet ones, whose `data`
+      # array is empty, so a series is directly plottable with no gap filling
+      # client-side. An unknown template id returns `200` with an all-empty series
+      # rather than `404`, and messages sent without a Notification Template never
+      # appear here.
+      #
+      # Available in the US region only.
+      sig do
+        params(
+          id: String,
+          end_: Time,
+          granularity:
+            Courier::NotificationGetMetricsParams::Granularity::OrSymbol,
+          lookback: String,
+          start: Time,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationMetricsResponse)
+      end
+      def get_metrics(
+        # The Notification Template to report on — its ID (`nt_` prefix) or an alias. Must
+        # not contain commas or whitespace.
+        id,
+        # The end of the window, as an ISO 8601 timestamp with an offset. Must be supplied
+        # together with `start`. An `end` in the future is accepted and not clamped — the
+        # trailing buckets come back empty.
+        end_: nil,
+        # The size of each bucket in the series. Defaults to `DAY`. `WEEK` buckets start
+        # on Sunday. A fine granularity caps the window it can cover: `HOUR` spans at most
+        # 7 days and `DAY` at most 90 days, and a wider window returns `400` — request a
+        # coarser granularity instead. `WEEK` and `MONTH` are uncapped, subject to the
+        # 1000-bucket limit on a single response.
+        granularity: nil,
+        # The length of the window, counted back from now, as an ISO 8601 duration
+        # (`P30D`, `P12W`, `PT12H`). Defaults to `P30D`, and is ignored when `start` and
+        # `end` are supplied. A malformed or non-positive duration returns `400`.
+        lookback: nil,
+        # The inclusive start of the window, as an ISO 8601 timestamp with an offset
+        # (`2026-04-01T00:00:00Z`). Must be supplied together with `end` and be earlier
+        # than it; either one alone returns `400`.
+        start: nil,
+        request_options: {}
+      )
+      end
+
       # Returns a notification template's published versions, most recent first, for
       # comparison or rollback. Paged.
       sig do