trycourier 6.1.0 → 6.3.0

data/rbi/courier/models/ms_teams_base_properties.rbi

@@ -8,16 +8,26 @@ module Courier
           T.any(Courier::MsTeamsBaseProperties, Courier::Internal::AnyHash)
         end
 
-      sig { returns(String) }
-      attr_accessor :service_url
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      # Tenant context shared by every MS Teams send variant. Provide at least one of
+      # `tenant_id` or `service_url`. If you provide both, they must agree — a
+      # `service_url` pointing at a different Microsoft tenant than `tenant_id` is
+      # rejected.
       sig do
         params(service_url: String, tenant_id: String).returns(T.attached_class)
       end
-      def self.new(service_url:, tenant_id:)
+      def self.new(service_url: nil, tenant_id: nil)
       end
 
       sig { override.returns({ service_url: String, tenant_id: String }) }

data/rbi/courier/models/ms_teams_recipient.rbi

@@ -8,6 +8,8 @@ module Courier
           T.any(Courier::MsTeamsRecipient, Courier::Internal::AnyHash)
         end
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
         returns(
           T.any(
@@ -34,7 +36,11 @@ module Courier
             )
         ).returns(T.attached_class)
       end
-      def self.new(ms_teams:)
+      def self.new(
+        # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+        # must agree.
+        ms_teams:
+      )
       end
 
       sig do

data/rbi/courier/models/notification_get_metrics_params.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationGetMetricsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationGetMetricsParams,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :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.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :end_
+
+      sig { params(end_: Time).void }
+      attr_writer :end_
+
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            Courier::NotificationGetMetricsParams::Granularity::OrSymbol
+          )
+        )
+      end
+      attr_reader :granularity
+
+      sig do
+        params(
+          granularity:
+            Courier::NotificationGetMetricsParams::Granularity::OrSymbol
+        ).void
+      end
+      attr_writer :granularity
+
+      # 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`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :lookback
+
+      sig { params(lookback: String).void }
+      attr_writer :lookback
+
+      # 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`.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :start
+
+      sig { params(start: Time).void }
+      attr_writer :start
+
+      sig do
+        params(
+          id: String,
+          end_: Time,
+          granularity:
+            Courier::NotificationGetMetricsParams::Granularity::OrSymbol,
+          lookback: String,
+          start: Time,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            end_: Time,
+            granularity:
+              Courier::NotificationGetMetricsParams::Granularity::OrSymbol,
+            lookback: String,
+            start: Time,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # 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.
+      module Granularity
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationGetMetricsParams::Granularity)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HOUR =
+          T.let(
+            :HOUR,
+            Courier::NotificationGetMetricsParams::Granularity::TaggedSymbol
+          )
+        DAY =
+          T.let(
+            :DAY,
+            Courier::NotificationGetMetricsParams::Granularity::TaggedSymbol
+          )
+        WEEK =
+          T.let(
+            :WEEK,
+            Courier::NotificationGetMetricsParams::Granularity::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :MONTH,
+            Courier::NotificationGetMetricsParams::Granularity::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationGetMetricsParams::Granularity::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

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/send_to_ms_teams_channel_id.rbi

@@ -11,12 +11,21 @@ module Courier
       sig { returns(String) }
       attr_accessor :channel_id
 
-      sig { returns(String) }
-      attr_accessor :service_url
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
 
+      # Sends directly to a Microsoft Teams channel by its Bot Framework ID. Still
+      # provide at least one of `tenant_id` or `service_url` — sends without either have
+      # failed Bot Framework authentication in testing.
       sig do
         params(
           channel_id: String,
@@ -24,7 +33,7 @@ module Courier
           tenant_id: String
         ).returns(T.attached_class)
       end
-      def self.new(channel_id:, service_url:, tenant_id:)
+      def self.new(channel_id:, service_url: nil, tenant_id: nil)
       end
 
       sig do

data/rbi/courier/models/send_to_ms_teams_channel_name.rbi

@@ -11,32 +11,40 @@ module Courier
       sig { returns(String) }
       attr_accessor :channel_name
 
-      sig { returns(String) }
-      attr_accessor :service_url
-
       sig { returns(String) }
       attr_accessor :team_id
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
+
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
 
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      # `team_id` is required alongside `channel_name`. Also provide at least one of
+      # `tenant_id` or `service_url`; if you provide both, they must agree.
       sig do
         params(
           channel_name: String,
-          service_url: String,
           team_id: String,
+          service_url: String,
           tenant_id: String
         ).returns(T.attached_class)
       end
-      def self.new(channel_name:, service_url:, team_id:, tenant_id:)
+      def self.new(channel_name:, team_id:, service_url: nil, tenant_id: nil)
       end
 
       sig do
         override.returns(
           {
             channel_name: String,
-            service_url: String,
             team_id: String,
+            service_url: String,
             tenant_id: String
           }
         )

data/rbi/courier/models/send_to_ms_teams_email.rbi

@@ -11,18 +11,26 @@ module Courier
       sig { returns(String) }
       attr_accessor :email
 
-      sig { returns(String) }
-      attr_accessor :service_url
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
         params(email: String, service_url: String, tenant_id: String).returns(
           T.attached_class
         )
       end
-      def self.new(email:, service_url:, tenant_id:)
+      def self.new(email:, service_url: nil, tenant_id: nil)
       end
 
       sig do

data/rbi/courier/models/send_to_ms_teams_user_id.rbi

@@ -9,25 +9,33 @@ module Courier
         end
 
       sig { returns(String) }
-      attr_accessor :service_url
+      attr_accessor :user_id
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :user_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
-        params(service_url: String, tenant_id: String, user_id: String).returns(
+        params(user_id: String, service_url: String, tenant_id: String).returns(
           T.attached_class
         )
       end
-      def self.new(service_url:, tenant_id:, user_id:)
+      def self.new(user_id:, service_url: nil, tenant_id: nil)
       end
 
       sig do
         override.returns(
-          { service_url: String, tenant_id: String, user_id: String }
+          { user_id: String, service_url: String, tenant_id: String }
         )
       end
       def to_hash

data/rbi/courier/models/user_profile.rbi

@@ -87,6 +87,8 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :middle_name
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
         returns(
           T.nilable(
@@ -240,6 +242,8 @@ module Courier
         intercom: nil,
         locale: nil,
         middle_name: nil,
+        # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+        # must agree.
         ms_teams: nil,
         name: nil,
         nickname: nil,