trycourier 4.21.0 → 4.23.0

data/rbi/courier/client.rbi

@@ -13,60 +13,101 @@ module Courier
     sig { returns(String) }
     attr_reader :api_key
 
+    # Send a message to one or more recipients — users, lists, audiences, or tenants —
+    # across every channel you have configured.
     sig { returns(Courier::Resources::Send) }
     attr_reader :send_
 
+    # Define filter-based groups whose membership Courier recalculates as user
+    # profiles change.
     sig { returns(Courier::Resources::Audiences) }
     attr_reader :audiences
 
+    # Configure the channel providers Courier delivers through, and browse the
+    # provider types it supports.
     sig { returns(Courier::Resources::Providers) }
     attr_reader :providers
 
+    # Read the audit trail of configuration and access changes in your workspace.
     sig { returns(Courier::Resources::AuditEvents) }
     attr_reader :audit_events
 
+    # Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the
+    # embedded designer — can call Courier as a single user. Server-side requests
+    # authenticate with your workspace API key instead.
     sig { returns(Courier::Resources::Auth) }
     attr_reader :auth
 
+    # Invoke a stored automation template or an ad hoc automation defined in the
+    # request.
     sig { returns(Courier::Resources::Automations) }
     attr_reader :automations
 
+    # Build, version, publish, invoke, and cancel multi-step notification workflows,
+    # along with the templates scoped to them.
     sig { returns(Courier::Resources::Journeys) }
     attr_reader :journeys
 
+    sig { returns(Courier::Resources::Broadcasts) }
+    attr_reader :broadcasts
+
+    # Manage the logos, colors, and layout that give the templates you send a
+    # consistent look.
     sig { returns(Courier::Resources::Brands) }
     attr_reader :brands
 
     sig { returns(Courier::Resources::Digests) }
     attr_reader :digests
 
+    # Record an inbound event that triggers the journeys and automations mapped to it.
     sig { returns(Courier::Resources::Inbound) }
     attr_reader :inbound
 
+    # Manage static groups of users that you subscribe explicitly, and send to them by
+    # list id or list pattern.
     sig { returns(Courier::Resources::Lists) }
     attr_reader :lists
 
+    sig { returns(Courier::Resources::Inbox) }
+    attr_reader :inbox
+
+    # Look up the messages Courier has accepted, inspect their delivery history and
+    # rendered output, and cancel, resend, or archive them.
     sig { returns(Courier::Resources::Messages) }
     attr_reader :messages
 
+    # Look up the messages Courier has accepted, inspect their delivery history and
+    # rendered output, and cancel, resend, or archive them.
     sig { returns(Courier::Resources::Requests) }
     attr_reader :requests
 
+    # Create, update, version, publish, and localize notification templates and their
+    # content.
     sig { returns(Courier::Resources::Notifications) }
     attr_reader :notifications
 
+    # Define reusable channel routing and failover strategies, and see which templates
+    # use them.
     sig { returns(Courier::Resources::RoutingStrategies) }
     attr_reader :routing_strategies
 
+    # Manage the workspace catalog of subscription topics, the sections that group
+    # them, and publishing the preference page.
     sig { returns(Courier::Resources::WorkspacePreferences) }
     attr_reader :workspace_preferences
 
+    # Store the contact information Courier delivers to for each user — email, phone
+    # number, push tokens, and any custom data you send to.
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles
 
+    # Manage tenants — the organizations, teams, or accounts your users belong to —
+    # along with their users and default preferences.
     sig { returns(Courier::Resources::Tenants) }
     attr_reader :tenants
 
+    # Store and retrieve the translation strings Courier uses to render localized
+    # template content.
     sig { returns(Courier::Resources::Translations) }
     attr_reader :translations
 

data/rbi/courier/models/automations/invoke_invoke_ad_hoc_params.rbi

@@ -43,6 +43,18 @@ module Courier
         sig { returns(T.nilable(String)) }
         attr_accessor :template
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             automation:
@@ -52,6 +64,8 @@ module Courier
             profile: T.nilable(T::Hash[Symbol, T.anything]),
             recipient: T.nilable(String),
             template: T.nilable(String),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -62,6 +76,8 @@ module Courier
           profile: nil,
           recipient: nil,
           template: nil,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
           request_options: {}
         )
         end
@@ -76,6 +92,8 @@ module Courier
               profile: T.nilable(T::Hash[Symbol, T.anything]),
               recipient: T.nilable(String),
               template: T.nilable(String),
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi

@@ -33,6 +33,18 @@ module Courier
         sig { returns(T.nilable(String)) }
         attr_accessor :template
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             template_id: String,
@@ -41,6 +53,8 @@ module Courier
             data: T.nilable(T::Hash[Symbol, T.anything]),
             profile: T.nilable(T::Hash[Symbol, T.anything]),
             template: T.nilable(String),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -51,6 +65,8 @@ module Courier
           data: nil,
           profile: nil,
           template: nil,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
           request_options: {}
         )
         end
@@ -64,6 +80,8 @@ module Courier
               data: T.nilable(T::Hash[Symbol, T.anything]),
               profile: T.nilable(T::Hash[Symbol, T.anything]),
               template: T.nilable(String),
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/brand_create_params.rbi

@@ -29,12 +29,26 @@ module Courier
       sig { params(snippets: T.nilable(Courier::BrandSnippets::OrHash)).void }
       attr_writer :snippets
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           name: String,
           settings: Courier::BrandSettings::OrHash,
           id: T.nilable(String),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -43,6 +57,8 @@ module Courier
         settings:,
         id: nil,
         snippets: nil,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
         request_options: {}
       )
       end
@@ -54,6 +70,8 @@ module Courier
             settings: Courier::BrandSettings,
             id: T.nilable(String),
             snippets: T.nilable(Courier::BrandSnippets),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/broadcast.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Broadcast < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Broadcast, Courier::Internal::AnyHash) }
+
+      # The broadcast ID (bst\_ prefix).
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The broadcast's delivery channel.
+      sig { returns(Courier::Broadcast::Channel::TaggedSymbol) }
+      attr_accessor :channel
+
+      # ISO 8601 timestamp when the broadcast was created.
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # Actor that created the broadcast.
+      sig { returns(String) }
+      attr_accessor :created_by
+
+      # Human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Lifecycle status of the broadcast.
+      sig { returns(Courier::Broadcast::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # ISO 8601 timestamp of the last update.
+      sig { returns(String) }
+      attr_accessor :updated_at
+
+      # Actor that last updated the broadcast.
+      sig { returns(String) }
+      attr_accessor :updated_by
+
+      # ISO 8601 timestamp when the broadcast was archived, if archived.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :archived_at
+
+      # Actor that archived the broadcast, if archived.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :archived_by
+
+      # The delivery schedule and recipient targeting for a broadcast.
+      sig { returns(T.nilable(Courier::BroadcastSchedule)) }
+      attr_reader :schedule
+
+      sig do
+        params(schedule: T.nilable(Courier::BroadcastSchedule::OrHash)).void
+      end
+      attr_writer :schedule
+
+      # A broadcast — a single-channel message delivered to a known set of recipients (a
+      # list or audience).
+      sig do
+        params(
+          id: String,
+          channel: Courier::Broadcast::Channel::OrSymbol,
+          created_at: String,
+          created_by: String,
+          name: String,
+          status: Courier::Broadcast::Status::OrSymbol,
+          updated_at: String,
+          updated_by: String,
+          archived_at: T.nilable(String),
+          archived_by: T.nilable(String),
+          schedule: T.nilable(Courier::BroadcastSchedule::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The broadcast ID (bst\_ prefix).
+        id:,
+        # The broadcast's delivery channel.
+        channel:,
+        # ISO 8601 timestamp when the broadcast was created.
+        created_at:,
+        # Actor that created the broadcast.
+        created_by:,
+        # Human-readable name.
+        name:,
+        # Lifecycle status of the broadcast.
+        status:,
+        # ISO 8601 timestamp of the last update.
+        updated_at:,
+        # Actor that last updated the broadcast.
+        updated_by:,
+        # ISO 8601 timestamp when the broadcast was archived, if archived.
+        archived_at: nil,
+        # Actor that archived the broadcast, if archived.
+        archived_by: nil,
+        # The delivery schedule and recipient targeting for a broadcast.
+        schedule: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            channel: Courier::Broadcast::Channel::TaggedSymbol,
+            created_at: String,
+            created_by: String,
+            name: String,
+            status: Courier::Broadcast::Status::TaggedSymbol,
+            updated_at: String,
+            updated_by: String,
+            archived_at: T.nilable(String),
+            archived_by: T.nilable(String),
+            schedule: T.nilable(Courier::BroadcastSchedule)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The broadcast's delivery channel.
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Broadcast::Channel) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL = T.let(:email, Courier::Broadcast::Channel::TaggedSymbol)
+        SMS = T.let(:sms, Courier::Broadcast::Channel::TaggedSymbol)
+        PUSH = T.let(:push, Courier::Broadcast::Channel::TaggedSymbol)
+        INBOX = T.let(:inbox, Courier::Broadcast::Channel::TaggedSymbol)
+        SLACK = T.let(:slack, Courier::Broadcast::Channel::TaggedSymbol)
+        MSTEAMS = T.let(:msteams, Courier::Broadcast::Channel::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Courier::Broadcast::Channel::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # Lifecycle status of the broadcast.
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Broadcast::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT = T.let(:draft, Courier::Broadcast::Status::TaggedSymbol)
+        SCHEDULED = T.let(:scheduled, Courier::Broadcast::Status::TaggedSymbol)
+        SENDING = T.let(:sending, Courier::Broadcast::Status::TaggedSymbol)
+        SENT = T.let(:sent, Courier::Broadcast::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Courier::Broadcast::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_archive_params.rbi

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

data/rbi/courier/models/broadcast_cancel_params.rbi

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

data/rbi/courier/models/broadcast_create_params.rbi

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

data/rbi/courier/models/broadcast_duplicate_params.rbi

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

data/rbi/courier/models/broadcast_list_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastListParams, Courier::Internal::AnyHash)
+        end
+
+      # Opaque pagination cursor from a previous response. Omit for the first page.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      # Maximum number of results per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of results per page.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: T.nilable(String),
+            limit: Integer,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_list_response.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastListResponse, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::Broadcast]) }
+      attr_accessor :results
+
+      # Paginated list of broadcasts.
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          results: T::Array[Courier::Broadcast::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, results:)
+      end
+
+      sig do
+        override.returns(
+          { paging: Courier::Paging, results: T::Array[Courier::Broadcast] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_put_content_params.rbi

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