trycourier 4.7.1 → 4.9.0

data/rbi/courier/models/users/token_retrieve_params.rbi

@@ -18,18 +18,26 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :token
+
         sig do
           params(
             user_id: String,
+            token: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, request_options: {})
+        def self.new(user_id:, token:, request_options: {})
         end
 
         sig do
           override.returns(
-            { user_id: String, request_options: Courier::RequestOptions }
+            {
+              user_id: String,
+              token: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/users/token_update_params.rbi

@@ -15,23 +15,28 @@ module Courier
         sig { returns(String) }
         attr_accessor :user_id
 
+        sig { returns(String) }
+        attr_accessor :token
+
         sig { returns(T::Array[Courier::Users::TokenUpdateParams::Patch]) }
         attr_accessor :patch
 
         sig do
           params(
             user_id: String,
+            token: String,
             patch: T::Array[Courier::Users::TokenUpdateParams::Patch::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, patch:, request_options: {})
+        def self.new(user_id:, token:, patch:, request_options: {})
         end
 
         sig do
           override.returns(
             {
               user_id: String,
+              token: String,
               patch: T::Array[Courier::Users::TokenUpdateParams::Patch],
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/version_node.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Courier
+  module Models
+    class VersionNode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::VersionNode, Courier::Internal::AnyHash) }
+
+      # Epoch milliseconds when this version was created.
+      sig { returns(Integer) }
+      attr_accessor :created
+
+      # User ID of the version creator.
+      sig { returns(String) }
+      attr_accessor :creator
+
+      # Version identifier. One of "draft", "published:vNNN" (current published
+      # version), or "vNNN" (historical version).
+      sig { returns(String) }
+      attr_accessor :version
+
+      # Whether the draft has unpublished changes. Only present on the draft version.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_changes
+
+      sig { params(has_changes: T::Boolean).void }
+      attr_writer :has_changes
+
+      # A version entry for a notification template.
+      sig do
+        params(
+          created: Integer,
+          creator: String,
+          version: String,
+          has_changes: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Epoch milliseconds when this version was created.
+        created:,
+        # User ID of the version creator.
+        creator:,
+        # Version identifier. One of "draft", "published:vNNN" (current published
+        # version), or "vNNN" (historical version).
+        version:,
+        # Whether the draft has unpublished changes. Only present on the draft version.
+        has_changes: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created: Integer,
+            creator: String,
+            version: String,
+            has_changes: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -84,8 +84,12 @@ module Courier
 
   BulkRunJobParams = Courier::Models::BulkRunJobParams
 
+  Channel = Courier::Models::Channel
+
   ChannelClassification = Courier::Models::ChannelClassification
 
+  ChannelMetadata = Courier::Models::ChannelMetadata
+
   ChannelPreference = Courier::Models::ChannelPreference
 
   Check = Courier::Models::Check
@@ -110,6 +114,8 @@ module Courier
 
   ElementalDividerNodeWithType = Courier::Models::ElementalDividerNodeWithType
 
+  ElementalHTMLNodeWithType = Courier::Models::ElementalHTMLNodeWithType
+
   ElementalImageNodeWithType = Courier::Models::ElementalImageNodeWithType
 
   ElementalMetaNodeWithType = Courier::Models::ElementalMetaNodeWithType
@@ -142,6 +148,18 @@ module Courier
 
   IntercomRecipient = Courier::Models::IntercomRecipient
 
+  Journey = Courier::Models::Journey
+
+  JourneyInvokeParams = Courier::Models::JourneyInvokeParams
+
+  JourneyListParams = Courier::Models::JourneyListParams
+
+  JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
+
+  JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
+
+  JourneysListResponse = Courier::Models::JourneysListResponse
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter
@@ -164,6 +182,9 @@ module Courier
 
   MessageCancelParams = Courier::Models::MessageCancelParams
 
+  MessageChannels =
+    T.let(Courier::Models::MessageChannels, Courier::Internal::Type::Converter)
+
   MessageContentParams = Courier::Models::MessageContentParams
 
   MessageContext = Courier::Models::MessageContext
@@ -174,12 +195,19 @@ module Courier
 
   MessageListParams = Courier::Models::MessageListParams
 
+  MessageProviders =
+    T.let(Courier::Models::MessageProviders, Courier::Internal::Type::Converter)
+
+  MessageProvidersType = Courier::Models::MessageProvidersType
+
   MessageRetrieveParams = Courier::Models::MessageRetrieveParams
 
   MessageRouting = Courier::Models::MessageRouting
 
   MessageRoutingChannel = Courier::Models::MessageRoutingChannel
 
+  Metadata = Courier::Models::Metadata
+
   MsTeams = Courier::Models::MsTeams
 
   MsTeamsBaseProperties = Courier::Models::MsTeamsBaseProperties
@@ -188,17 +216,52 @@ module Courier
 
   MultipleTokens = Courier::Models::MultipleTokens
 
+  NotificationArchiveParams = Courier::Models::NotificationArchiveParams
+
+  NotificationCreateParams = Courier::Models::NotificationCreateParams
+
   NotificationGetContent = Courier::Models::NotificationGetContent
 
   NotificationListParams = Courier::Models::NotificationListParams
 
+  NotificationListVersionsParams =
+    Courier::Models::NotificationListVersionsParams
+
   NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
+  NotificationPublishParams = Courier::Models::NotificationPublishParams
+
+  NotificationReplaceParams = Courier::Models::NotificationReplaceParams
+
   NotificationRetrieveContentParams =
     Courier::Models::NotificationRetrieveContentParams
 
+  NotificationRetrieveParams = Courier::Models::NotificationRetrieveParams
+
   Notifications = Courier::Models::Notifications
 
+  NotificationTemplateCreateRequest =
+    Courier::Models::NotificationTemplateCreateRequest
+
+  NotificationTemplateGetResponse =
+    Courier::Models::NotificationTemplateGetResponse
+
+  NotificationTemplateMutationResponse =
+    Courier::Models::NotificationTemplateMutationResponse
+
+  NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
+
+  NotificationTemplatePublishRequest =
+    Courier::Models::NotificationTemplatePublishRequest
+
+  NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
+
+  NotificationTemplateUpdateRequest =
+    Courier::Models::NotificationTemplateUpdateRequest
+
+  NotificationTemplateVersionListResponse =
+    Courier::Models::NotificationTemplateVersionListResponse
+
   Pagerduty = Courier::Models::Pagerduty
 
   PagerdutyRecipient = Courier::Models::PagerdutyRecipient
@@ -227,6 +290,22 @@ module Courier
 
   ProfileUpdateParams = Courier::Models::ProfileUpdateParams
 
+  Provider = Courier::Models::Provider
+
+  ProviderCreateParams = Courier::Models::ProviderCreateParams
+
+  ProviderDeleteParams = Courier::Models::ProviderDeleteParams
+
+  ProviderListParams = Courier::Models::ProviderListParams
+
+  ProviderRetrieveParams = Courier::Models::ProviderRetrieveParams
+
+  Providers = Courier::Models::Providers
+
+  ProvidersCatalogEntry = Courier::Models::ProvidersCatalogEntry
+
+  ProviderUpdateParams = Courier::Models::ProviderUpdateParams
+
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest
@@ -237,6 +316,29 @@ module Courier
 
   RequestArchiveParams = Courier::Models::RequestArchiveParams
 
+  RoutingStrategyArchiveParams = Courier::Models::RoutingStrategyArchiveParams
+
+  RoutingStrategyCreateParams = Courier::Models::RoutingStrategyCreateParams
+
+  RoutingStrategyCreateRequest = Courier::Models::RoutingStrategyCreateRequest
+
+  RoutingStrategyGetResponse = Courier::Models::RoutingStrategyGetResponse
+
+  RoutingStrategyListParams = Courier::Models::RoutingStrategyListParams
+
+  RoutingStrategyListResponse = Courier::Models::RoutingStrategyListResponse
+
+  RoutingStrategyMutationResponse =
+    Courier::Models::RoutingStrategyMutationResponse
+
+  RoutingStrategyReplaceParams = Courier::Models::RoutingStrategyReplaceParams
+
+  RoutingStrategyReplaceRequest = Courier::Models::RoutingStrategyReplaceRequest
+
+  RoutingStrategyRetrieveParams = Courier::Models::RoutingStrategyRetrieveParams
+
+  RoutingStrategySummary = Courier::Models::RoutingStrategySummary
+
   Rule = Courier::Models::Rule
 
   SendDirectMessage = Courier::Models::SendDirectMessage
@@ -293,6 +395,8 @@ module Courier
 
   TextStyle = Courier::Models::TextStyle
 
+  Timeouts = Courier::Models::Timeouts
+
   Token = Courier::Models::Token
 
   TranslationRetrieveParams = Courier::Models::TranslationRetrieveParams
@@ -309,6 +413,8 @@ module Courier
 
   Utm = Courier::Models::Utm
 
+  VersionNode = Courier::Models::VersionNode
+
   WebhookAuthentication = Courier::Models::WebhookAuthentication
 
   WebhookAuthMode = Courier::Models::WebhookAuthMode

data/rbi/courier/resources/journeys.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Journeys
+      # Get the list of journeys.
+      sig do
+        params(
+          cursor: String,
+          version: Courier::JourneyListParams::Version::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneysListResponse)
+      end
+      def list(
+        # A cursor token for pagination. Use the cursor from the previous response to
+        # fetch the next page of results.
+        cursor: nil,
+        # The version of journeys to retrieve. Accepted values are published (for
+        # published journeys) or draft (for draft journeys). Defaults to published.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      # Invoke a journey run from a journey template.
+      sig do
+        params(
+          template_id: String,
+          data: T::Hash[Symbol, T.anything],
+          profile: T::Hash[Symbol, T.anything],
+          user_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneysInvokeResponse)
+      end
+      def invoke(
+        # A unique identifier representing the journey template to be invoked. This could
+        # be the Journey Template ID or the Journey Template Alias.
+        template_id,
+        # Data payload passed to the journey. The expected shape can be predefined using
+        # the schema builder in the journey editor. This data is available in journey
+        # steps for condition evaluation and template variable interpolation. Can also
+        # contain user identifiers (user_id, userId, anonymousId) if not provided
+        # elsewhere.
+        data: nil,
+        # Profile data for the user. Can contain contact information (email,
+        # phone_number), user identifiers (user_id, userId, anonymousId), or any custom
+        # profile fields. Profile fields are merged with any existing stored profile for
+        # the user. Include context.tenant_id to load a tenant-scoped profile for
+        # multi-tenant scenarios.
+        profile: nil,
+        # A unique identifier for the user. If not provided, the system will attempt to
+        # resolve the user identifier from profile or data objects.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/courier/resources/notifications.rbi

@@ -9,21 +9,139 @@ module Courier
       sig { returns(Courier::Resources::Notifications::Checks) }
       attr_reader :checks
 
+      # Create a notification template. Requires all fields in the notification object.
+      # Templates are created in draft state by default.
+      sig do
+        params(
+          notification: Courier::NotificationTemplatePayload::OrHash,
+          state: Courier::NotificationTemplateCreateRequest::State::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationTemplateMutationResponse)
+      end
+      def create(
+        # Full document shape used in POST and PUT request bodies, and returned inside the
+        # GET response envelope.
+        notification:,
+        # Template state after creation. Case-insensitive input, normalized to uppercase
+        # in the response. Defaults to "DRAFT".
+        state: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a notification template by ID. Returns the published version by
+      # default. Pass version=draft to retrieve an unpublished template.
+      sig do
+        params(
+          id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationTemplateGetResponse)
+      end
+      def retrieve(
+        # Template ID (nt\_ prefix).
+        id,
+        # Version to retrieve. One of "draft", "published", or a version string like
+        # "v001". Defaults to "published".
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      # List notification templates in your workspace.
       sig do
         params(
           cursor: T.nilable(String),
+          event_id: String,
           notes: T.nilable(T::Boolean),
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Models::NotificationListResponse)
       end
       def list(
+        # Opaque pagination cursor from a previous response. Omit for the first page.
         cursor: nil,
-        # Retrieve the notes from the Notification template settings.
+        # Filter to templates linked to this event map ID.
+        event_id: nil,
+        # Include template notes in the response. Only applies to legacy templates.
         notes: nil,
         request_options: {}
       )
       end
 
+      # Archive a notification template.
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def archive(
+        # Template ID (nt\_ prefix).
+        id,
+        request_options: {}
+      )
+      end
+
+      # List versions of a notification template.
+      sig do
+        params(
+          id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationTemplateVersionListResponse)
+      end
+      def list_versions(
+        # Template ID (nt\_ prefix).
+        id,
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of versions to return per page. Default 10, max 10.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Publish a notification template. Publishes the current draft by default. Pass a
+      # version in the request body to publish a specific historical version.
+      sig do
+        params(
+          id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def publish(
+        # Template ID (nt\_ prefix).
+        id,
+        # Historical version to publish (e.g. "v001"). Omit to publish the current draft.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      # Replace a notification template. All fields are required.
+      sig do
+        params(
+          id: String,
+          notification: Courier::NotificationTemplatePayload::OrHash,
+          state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationTemplateMutationResponse)
+      end
+      def replace(
+        # Template ID (nt\_ prefix).
+        id,
+        # Full document shape used in POST and PUT request bodies, and returned inside the
+        # GET response envelope.
+        notification:,
+        # Template state after update. Case-insensitive input, normalized to uppercase in
+        # the response. Defaults to "DRAFT".
+        state: nil,
+        request_options: {}
+      )
+      end
+
       sig do
         params(
           id: String,

data/rbi/courier/resources/providers/catalog.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Providers
+      class Catalog
+        # Returns the catalog of available provider types with their display names,
+        # descriptions, and configuration schema fields (snake_case, with `type` and
+        # `required`). Providers with no configurable schema return only `provider`,
+        # `name`, and `description`.
+        sig do
+          params(
+            channel: String,
+            keys: String,
+            name: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::Models::Providers::CatalogListResponse)
+        end
+        def list(
+          # Exact match (case-insensitive) against the provider channel taxonomy (e.g.
+          # `email`, `sms`, `push`).
+          channel: nil,
+          # Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+          keys: nil,
+          # Case-insensitive substring match against the provider display name.
+          name: nil,
+          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/providers.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Providers
+      sig { returns(Courier::Resources::Providers::Catalog) }
+      attr_reader :catalog
+
+      # Create a new provider configuration. The `provider` field must be a known
+      # Courier provider key (see catalog).
+      sig do
+        params(
+          provider: String,
+          alias_: String,
+          settings: T::Hash[Symbol, T.anything],
+          title: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Provider)
+      end
+      def create(
+        # The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a
+        # known Courier provider — see the catalog endpoint for valid keys.
+        provider:,
+        # Optional alias for this configuration.
+        alias_: nil,
+        # Provider-specific settings (snake_case keys). Defaults to an empty object when
+        # omitted. Use the catalog endpoint to discover required fields for a given
+        # provider — omitting a required field returns a 400 validation error.
+        settings: nil,
+        # Optional display title. Omit to use "Default Configuration".
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # Fetch a single provider configuration by ID.
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Provider)
+      end
+      def retrieve(
+        # A unique identifier of the provider configuration.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update an existing provider configuration. The `provider` key is required. All
+      # other fields are optional — omitted fields are cleared from the stored
+      # configuration (this is a full replacement, not a partial merge).
+      sig do
+        params(
+          id: String,
+          provider: String,
+          alias_: String,
+          settings: T::Hash[Symbol, T.anything],
+          title: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Provider)
+      end
+      def update(
+        # A unique identifier of the provider configuration to update.
+        id,
+        # The provider key identifying the type.
+        provider:,
+        # Updated alias. Omit to clear.
+        alias_: nil,
+        # Provider-specific settings (snake_case keys). Replaces the full settings object
+        # — omitted settings fields are removed. Use the catalog endpoint to check
+        # required fields.
+        settings: nil,
+        # Updated display title.
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # List configured provider integrations for the current workspace. Supports
+      # cursor-based pagination.
+      sig do
+        params(
+          cursor: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Models::ProviderListResponse)
+      end
+      def list(
+        # Opaque cursor for fetching the next page.
+        cursor: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a provider configuration. Returns 409 if the provider is still referenced
+      # by routing or notifications.
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # A unique identifier of the provider configuration to delete.
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end