trycourier 6.1.0 → 6.3.0

data/rbi/courier/models.rbi

@@ -288,6 +288,16 @@ module Courier
 
   JourneySendNode = Courier::Models::JourneySendNode
 
+  JourneySendNodeToMsTeams = Courier::Models::JourneySendNodeToMsTeams
+
+  JourneySendNodeToSlack = Courier::Models::JourneySendNodeToSlack
+
+  JourneySendNodeToSlackChannel = Courier::Models::JourneySendNodeToSlackChannel
+
+  JourneySendNodeToSlackEmail = Courier::Models::JourneySendNodeToSlackEmail
+
+  JourneySendNodeToSlackUserID = Courier::Models::JourneySendNodeToSlackUserID
+
   JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
 
   JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
@@ -392,6 +402,8 @@ module Courier
 
   NotificationGetContent = Courier::Models::NotificationGetContent
 
+  NotificationGetMetricsParams = Courier::Models::NotificationGetMetricsParams
+
   NotificationListParams = Courier::Models::NotificationListParams
 
   NotificationListVersionsParams =
@@ -399,6 +411,8 @@ module Courier
 
   NotificationLocalePutRequest = Courier::Models::NotificationLocalePutRequest
 
+  NotificationMetricsResponse = Courier::Models::NotificationMetricsResponse
+
   NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
   NotificationPublishParams = Courier::Models::NotificationPublishParams

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

data/sig/courier/models/journey_send_node.rbs

@@ -125,7 +125,9 @@ module Courier
         type to =
           {
             email_override: String,
+            ms_teams: Courier::JourneySendNodeToMsTeams,
             phone_number_override: String,
+            slack: Courier::Models::journey_send_node_to_slack,
             user_id_override: String
           }
 
@@ -134,23 +136,39 @@ module Courier
 
           def email_override=: (String) -> String
 
+          attr_reader ms_teams: Courier::JourneySendNodeToMsTeams?
+
+          def ms_teams=: (
+            Courier::JourneySendNodeToMsTeams
+          ) -> Courier::JourneySendNodeToMsTeams
+
           attr_reader phone_number_override: String?
 
           def phone_number_override=: (String) -> String
 
+          attr_reader slack: Courier::Models::journey_send_node_to_slack?
+
+          def slack=: (
+            Courier::Models::journey_send_node_to_slack
+          ) -> Courier::Models::journey_send_node_to_slack
+
           attr_reader user_id_override: String?
 
           def user_id_override=: (String) -> String
 
           def initialize: (
             ?email_override: String,
+            ?ms_teams: Courier::JourneySendNodeToMsTeams,
             ?phone_number_override: String,
+            ?slack: Courier::Models::journey_send_node_to_slack,
             ?user_id_override: String
           ) -> void
 
           def to_hash: -> {
             email_override: String,
+            ms_teams: Courier::JourneySendNodeToMsTeams,
             phone_number_override: String,
+            slack: Courier::Models::journey_send_node_to_slack,
             user_id_override: String
           }
         end

data/sig/courier/models/journey_send_node_to_ms_teams.rbs

@@ -0,0 +1,64 @@
+module Courier
+  module Models
+    type journey_send_node_to_ms_teams =
+      {
+        channel_id: String,
+        channel_name: String,
+        email: String,
+        service_url: String,
+        team_id: String,
+        tenant_id: String,
+        user_id: String
+      }
+
+    class JourneySendNodeToMsTeams < Courier::Internal::Type::BaseModel
+      attr_reader channel_id: String?
+
+      def channel_id=: (String) -> String
+
+      attr_reader channel_name: String?
+
+      def channel_name=: (String) -> String
+
+      attr_reader email: String?
+
+      def email=: (String) -> String
+
+      attr_reader service_url: String?
+
+      def service_url=: (String) -> String
+
+      attr_reader team_id: String?
+
+      def team_id=: (String) -> String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
+
+      attr_reader user_id: String?
+
+      def user_id=: (String) -> String
+
+      def initialize: (
+        ?channel_id: String,
+        ?channel_name: String,
+        ?email: String,
+        ?service_url: String,
+        ?team_id: String,
+        ?tenant_id: String,
+        ?user_id: String
+      ) -> void
+
+      def to_hash: -> {
+        channel_id: String,
+        channel_name: String,
+        email: String,
+        service_url: String,
+        team_id: String,
+        tenant_id: String,
+        user_id: String
+      }
+    end
+  end
+end

data/sig/courier/models/journey_send_node_to_slack.rbs

@@ -0,0 +1,14 @@
+module Courier
+  module Models
+    type journey_send_node_to_slack =
+      Courier::JourneySendNodeToSlackChannel
+      | Courier::JourneySendNodeToSlackUserID
+      | Courier::JourneySendNodeToSlackEmail
+
+    module JourneySendNodeToSlack
+      extend Courier::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Courier::Models::journey_send_node_to_slack]
+    end
+  end
+end

data/sig/courier/models/journey_send_node_to_slack_channel.rbs

@@ -0,0 +1,18 @@
+module Courier
+  module Models
+    type journey_send_node_to_slack_channel =
+      { channel: String, access_token: String }
+
+    class JourneySendNodeToSlackChannel < Courier::Internal::Type::BaseModel
+      attr_accessor channel: String
+
+      attr_reader access_token: String?
+
+      def access_token=: (String) -> String
+
+      def initialize: (channel: String, ?access_token: String) -> void
+
+      def to_hash: -> { channel: String, access_token: String }
+    end
+  end
+end

data/sig/courier/models/journey_send_node_to_slack_email.rbs

@@ -0,0 +1,18 @@
+module Courier
+  module Models
+    type journey_send_node_to_slack_email =
+      { email: String, access_token: String }
+
+    class JourneySendNodeToSlackEmail < Courier::Internal::Type::BaseModel
+      attr_accessor email: String
+
+      attr_reader access_token: String?
+
+      def access_token=: (String) -> String
+
+      def initialize: (email: String, ?access_token: String) -> void
+
+      def to_hash: -> { email: String, access_token: String }
+    end
+  end
+end

data/sig/courier/models/journey_send_node_to_slack_user_id.rbs

@@ -0,0 +1,18 @@
+module Courier
+  module Models
+    type journey_send_node_to_slack_user_id =
+      { user_id: String, access_token: String }
+
+    class JourneySendNodeToSlackUserID < Courier::Internal::Type::BaseModel
+      attr_accessor user_id: String
+
+      attr_reader access_token: String?
+
+      def access_token=: (String) -> String
+
+      def initialize: (user_id: String, ?access_token: String) -> void
+
+      def to_hash: -> { user_id: String, access_token: String }
+    end
+  end
+end

data/sig/courier/models/ms_teams_base_properties.rbs

@@ -3,11 +3,15 @@ module Courier
     type ms_teams_base_properties = { service_url: String, tenant_id: String }
 
     class MsTeamsBaseProperties < Courier::Internal::Type::BaseModel
-      attr_accessor service_url: String
+      attr_reader service_url: String?
 
-      attr_accessor tenant_id: String
+      def service_url=: (String) -> String
 
-      def initialize: (service_url: String, tenant_id: String) -> void
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
+
+      def initialize: (?service_url: String, ?tenant_id: String) -> void
 
       def to_hash: -> { service_url: String, tenant_id: String }
     end

data/sig/courier/models/notification_get_metrics_params.rbs

@@ -0,0 +1,69 @@
+module Courier
+  module Models
+    type notification_get_metrics_params =
+      {
+        id: String,
+        end_: Time,
+        granularity: Courier::Models::NotificationGetMetricsParams::granularity,
+        lookback: String,
+        start: Time
+      }
+      & Courier::Internal::Type::request_parameters
+
+    class NotificationGetMetricsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader end_: Time?
+
+      def end_=: (Time) -> Time
+
+      attr_reader granularity: Courier::Models::NotificationGetMetricsParams::granularity?
+
+      def granularity=: (
+        Courier::Models::NotificationGetMetricsParams::granularity
+      ) -> Courier::Models::NotificationGetMetricsParams::granularity
+
+      attr_reader lookback: String?
+
+      def lookback=: (String) -> String
+
+      attr_reader start: Time?
+
+      def start=: (Time) -> Time
+
+      def initialize: (
+        id: String,
+        ?end_: Time,
+        ?granularity: Courier::Models::NotificationGetMetricsParams::granularity,
+        ?lookback: String,
+        ?start: Time,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        end_: Time,
+        granularity: Courier::Models::NotificationGetMetricsParams::granularity,
+        lookback: String,
+        start: Time,
+        request_options: Courier::RequestOptions
+      }
+
+      type granularity = :HOUR | :DAY | :WEEK | :MONTH
+
+      module Granularity
+        extend Courier::Internal::Type::Enum
+
+        HOUR: :HOUR
+        DAY: :DAY
+        WEEK: :WEEK
+        MONTH: :MONTH
+
+        def self?.values: -> ::Array[Courier::Models::NotificationGetMetricsParams::granularity]
+      end
+    end
+  end
+end

data/sig/courier/models/notification_metrics_response.rbs

@@ -0,0 +1,127 @@
+module Courier
+  module Models
+    type notification_metrics_response =
+      {
+        end_: Time,
+        granularity: Courier::Models::NotificationMetricsResponse::granularity,
+        notification_id: String,
+        series: ::Array[Courier::NotificationMetricsResponse::Series],
+        start: Time
+      }
+
+    class NotificationMetricsResponse < Courier::Internal::Type::BaseModel
+      attr_accessor end_: Time
+
+      attr_accessor granularity: Courier::Models::NotificationMetricsResponse::granularity
+
+      attr_accessor notification_id: String
+
+      attr_accessor series: ::Array[Courier::NotificationMetricsResponse::Series]
+
+      attr_accessor start: Time
+
+      def initialize: (
+        end_: Time,
+        granularity: Courier::Models::NotificationMetricsResponse::granularity,
+        notification_id: String,
+        series: ::Array[Courier::NotificationMetricsResponse::Series],
+        start: Time
+      ) -> void
+
+      def to_hash: -> {
+        end_: Time,
+        granularity: Courier::Models::NotificationMetricsResponse::granularity,
+        notification_id: String,
+        series: ::Array[Courier::NotificationMetricsResponse::Series],
+        start: Time
+      }
+
+      type granularity = :HOUR | :DAY | :WEEK | :MONTH
+
+      module Granularity
+        extend Courier::Internal::Type::Enum
+
+        HOUR: :HOUR
+        DAY: :DAY
+        WEEK: :WEEK
+        MONTH: :MONTH
+
+        def self?.values: -> ::Array[Courier::Models::NotificationMetricsResponse::granularity]
+      end
+
+      type series =
+        {
+          data: ::Array[Courier::NotificationMetricsResponse::Series::Data],
+          period: Time
+        }
+
+      class Series < Courier::Internal::Type::BaseModel
+        attr_accessor data: ::Array[Courier::NotificationMetricsResponse::Series::Data]
+
+        attr_accessor period: Time
+
+        def initialize: (
+          data: ::Array[Courier::NotificationMetricsResponse::Series::Data],
+          period: Time
+        ) -> void
+
+        def to_hash: -> {
+          data: ::Array[Courier::NotificationMetricsResponse::Series::Data],
+          period: Time
+        }
+
+        type data =
+          {
+            channel: String,
+            clicked: Integer,
+            delivered: Integer,
+            errors: Integer,
+            opened: Integer,
+            provider: String,
+            sent: Integer,
+            undeliverable: Integer
+          }
+
+        class Data < Courier::Internal::Type::BaseModel
+          attr_accessor channel: String
+
+          attr_accessor clicked: Integer
+
+          attr_accessor delivered: Integer
+
+          attr_accessor errors: Integer
+
+          attr_accessor opened: Integer
+
+          attr_accessor provider: String
+
+          attr_accessor sent: Integer
+
+          attr_accessor undeliverable: Integer
+
+          def initialize: (
+            channel: String,
+            clicked: Integer,
+            delivered: Integer,
+            errors: Integer,
+            opened: Integer,
+            provider: String,
+            sent: Integer,
+            undeliverable: Integer
+          ) -> void
+
+          def to_hash: -> {
+            channel: String,
+            clicked: Integer,
+            delivered: Integer,
+            errors: Integer,
+            opened: Integer,
+            provider: String,
+            sent: Integer,
+            undeliverable: Integer
+          }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/send_to_ms_teams_channel_id.rbs

@@ -6,14 +6,18 @@ module Courier
     class SendToMsTeamsChannelID < Courier::Internal::Type::BaseModel
       attr_accessor channel_id: String
 
-      attr_accessor service_url: String
+      attr_reader service_url: String?
 
-      attr_accessor tenant_id: String
+      def service_url=: (String) -> String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
 
       def initialize: (
         channel_id: String,
-        service_url: String,
-        tenant_id: String
+        ?service_url: String,
+        ?tenant_id: String
       ) -> void
 
       def to_hash: -> {

data/sig/courier/models/send_to_ms_teams_channel_name.rbs

@@ -3,31 +3,35 @@ module Courier
     type send_to_ms_teams_channel_name =
       {
         channel_name: String,
-        service_url: String,
         team_id: String,
+        service_url: String,
         tenant_id: String
       }
 
     class SendToMsTeamsChannelName < Courier::Internal::Type::BaseModel
       attr_accessor channel_name: String
 
-      attr_accessor service_url: String
-
       attr_accessor team_id: String
 
-      attr_accessor tenant_id: String
+      attr_reader service_url: String?
+
+      def service_url=: (String) -> String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
 
       def initialize: (
         channel_name: String,
-        service_url: String,
         team_id: String,
-        tenant_id: String
+        ?service_url: String,
+        ?tenant_id: String
       ) -> void
 
       def to_hash: -> {
         channel_name: String,
-        service_url: String,
         team_id: String,
+        service_url: String,
         tenant_id: String
       }
     end

data/sig/courier/models/send_to_ms_teams_email.rbs

@@ -6,14 +6,18 @@ module Courier
     class SendToMsTeamsEmail < Courier::Internal::Type::BaseModel
       attr_accessor email: String
 
-      attr_accessor service_url: String
+      attr_reader service_url: String?
 
-      attr_accessor tenant_id: String
+      def service_url=: (String) -> String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
 
       def initialize: (
         email: String,
-        service_url: String,
-        tenant_id: String
+        ?service_url: String,
+        ?tenant_id: String
       ) -> void
 
       def to_hash: -> { email: String, service_url: String, tenant_id: String }

data/sig/courier/models/send_to_ms_teams_user_id.rbs

@@ -1,25 +1,29 @@
 module Courier
   module Models
     type send_to_ms_teams_user_id =
-      { service_url: String, tenant_id: String, user_id: String }
+      { user_id: String, service_url: String, tenant_id: String }
 
     class SendToMsTeamsUserID < Courier::Internal::Type::BaseModel
-      attr_accessor service_url: String
+      attr_accessor user_id: String
 
-      attr_accessor tenant_id: String
+      attr_reader service_url: String?
 
-      attr_accessor user_id: String
+      def service_url=: (String) -> String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
 
       def initialize: (
-        service_url: String,
-        tenant_id: String,
-        user_id: String
+        user_id: String,
+        ?service_url: String,
+        ?tenant_id: String
       ) -> void
 
       def to_hash: -> {
+        user_id: String,
         service_url: String,
-        tenant_id: String,
-        user_id: String
+        tenant_id: String
       }
     end
   end

data/sig/courier/models.rbs

@@ -279,6 +279,16 @@ module Courier
 
   class JourneySendNode = Courier::Models::JourneySendNode
 
+  class JourneySendNodeToMsTeams = Courier::Models::JourneySendNodeToMsTeams
+
+  module JourneySendNodeToSlack = Courier::Models::JourneySendNodeToSlack
+
+  class JourneySendNodeToSlackChannel = Courier::Models::JourneySendNodeToSlackChannel
+
+  class JourneySendNodeToSlackEmail = Courier::Models::JourneySendNodeToSlackEmail
+
+  class JourneySendNodeToSlackUserID = Courier::Models::JourneySendNodeToSlackUserID
+
   class JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
 
   class JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
@@ -379,12 +389,16 @@ module Courier
 
   class NotificationGetContent = Courier::Models::NotificationGetContent
 
+  class NotificationGetMetricsParams = Courier::Models::NotificationGetMetricsParams
+
   class NotificationListParams = Courier::Models::NotificationListParams
 
   class NotificationListVersionsParams = Courier::Models::NotificationListVersionsParams
 
   class NotificationLocalePutRequest = Courier::Models::NotificationLocalePutRequest
 
+  class NotificationMetricsResponse = Courier::Models::NotificationMetricsResponse
+
   class NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
   class NotificationPublishParams = Courier::Models::NotificationPublishParams

data/sig/courier/resources/notifications.rbs

@@ -26,6 +26,15 @@ module Courier
 
       def archive: (String id, ?request_options: Courier::request_opts) -> nil
 
+      def get_metrics: (
+        String id,
+        ?end_: Time,
+        ?granularity: Courier::Models::NotificationGetMetricsParams::granularity,
+        ?lookback: String,
+        ?start: Time,
+        ?request_options: Courier::request_opts
+      ) -> Courier::NotificationMetricsResponse
+
       def list_versions: (
         String id,
         ?cursor: String,