trycourier 4.10.2 → 4.12.0

data/rbi/courier/models.rbi

@@ -97,6 +97,8 @@ module Courier
 
   Check = Courier::Models::Check
 
+  CreateJourneyRequest = Courier::Models::CreateJourneyRequest
+
   DefaultPreferences = Courier::Models::DefaultPreferences
 
   DeviceType = Courier::Models::DeviceType
@@ -155,16 +157,90 @@ module Courier
 
   Journey = Courier::Models::Journey
 
+  JourneyAINode = Courier::Models::JourneyAINode
+
+  JourneyAPIInvokeTriggerNode = Courier::Models::JourneyAPIInvokeTriggerNode
+
+  JourneyArchiveParams = Courier::Models::JourneyArchiveParams
+
+  JourneyConditionAtom =
+    T.let(
+      Courier::Models::JourneyConditionAtom,
+      Courier::Internal::Type::Converter
+    )
+
+  JourneyConditionGroup = Courier::Models::JourneyConditionGroup
+
+  JourneyConditionNestedGroup = Courier::Models::JourneyConditionNestedGroup
+
+  JourneyConditionsField = Courier::Models::JourneyConditionsField
+
+  JourneyCreateParams = Courier::Models::JourneyCreateParams
+
+  JourneyDelayDurationNode = Courier::Models::JourneyDelayDurationNode
+
+  JourneyDelayUntilNode = Courier::Models::JourneyDelayUntilNode
+
+  JourneyExitNode = Courier::Models::JourneyExitNode
+
+  JourneyFetchGetDeleteNode = Courier::Models::JourneyFetchGetDeleteNode
+
+  JourneyFetchPostPutNode = Courier::Models::JourneyFetchPostPutNode
+
   JourneyInvokeParams = Courier::Models::JourneyInvokeParams
 
   JourneyListParams = Courier::Models::JourneyListParams
 
+  JourneyListVersionsParams = Courier::Models::JourneyListVersionsParams
+
+  JourneyMergeStrategy = Courier::Models::JourneyMergeStrategy
+
+  JourneyNode = Courier::Models::JourneyNode
+
+  JourneyPublishParams = Courier::Models::JourneyPublishParams
+
+  JourneyPublishRequest = Courier::Models::JourneyPublishRequest
+
+  JourneyReplaceParams = Courier::Models::JourneyReplaceParams
+
+  JourneyResponse = Courier::Models::JourneyResponse
+
+  JourneyRetrieveParams = Courier::Models::JourneyRetrieveParams
+
+  Journeys = Courier::Models::Journeys
+
+  JourneySegmentTriggerNode = Courier::Models::JourneySegmentTriggerNode
+
+  JourneySendNode = Courier::Models::JourneySendNode
+
   JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
 
   JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
 
   JourneysListResponse = Courier::Models::JourneysListResponse
 
+  JourneyState = Courier::Models::JourneyState
+
+  JourneyTemplateCreateRequest = Courier::Models::JourneyTemplateCreateRequest
+
+  JourneyTemplateGetResponse = Courier::Models::JourneyTemplateGetResponse
+
+  JourneyTemplateListResponse = Courier::Models::JourneyTemplateListResponse
+
+  JourneyTemplatePublishRequest = Courier::Models::JourneyTemplatePublishRequest
+
+  JourneyTemplateReplaceRequest = Courier::Models::JourneyTemplateReplaceRequest
+
+  JourneyTemplateSummary = Courier::Models::JourneyTemplateSummary
+
+  JourneyThrottleDynamicNode = Courier::Models::JourneyThrottleDynamicNode
+
+  JourneyThrottleStaticNode = Courier::Models::JourneyThrottleStaticNode
+
+  JourneyVersionItem = Courier::Models::JourneyVersionItem
+
+  JourneyVersionsListResponse = Courier::Models::JourneyVersionsListResponse
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter

data/rbi/courier/resources/brands.rbi

@@ -3,23 +3,18 @@
 module Courier
   module Resources
     class Brands
-      # Create a new brand
+      # Create a new brand. Requires `name` and `settings` (with at least
+      # `colors.primary` and `colors.secondary`).
       sig do
         params(
           name: String,
+          settings: Courier::BrandSettings::OrHash,
           id: T.nilable(String),
-          settings: T.nilable(Courier::BrandSettings::OrHash),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Brand)
       end
-      def create(
-        name:,
-        id: nil,
-        settings: nil,
-        snippets: nil,
-        request_options: {}
-      )
+      def create(name:, settings:, id: nil, snippets: nil, request_options: {})
       end
 
       # Fetch a specific brand by brand ID.

data/rbi/courier/resources/journeys/templates.rbi

@@ -0,0 +1,160 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Journeys
+      class Templates
+        # Create a notification template scoped to this journey. Defaults to `DRAFT`
+        # state; pass `state: "PUBLISHED"` to publish on create.
+        sig do
+          params(
+            template_id: String,
+            channel: String,
+            notification:
+              Courier::JourneyTemplateCreateRequest::Notification::OrHash,
+            provider_key: String,
+            state: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::JourneyTemplateGetResponse)
+        end
+        def create(
+          # Journey id
+          template_id,
+          channel:,
+          notification:,
+          provider_key: nil,
+          state: nil,
+          request_options: {}
+        )
+        end
+
+        # Fetch a journey-scoped notification template by id. Pass `?version=draft`
+        # (default `published`) to retrieve the working draft, or `?version=vN` for a
+        # historical version.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::JourneyTemplateGetResponse)
+        end
+        def retrieve(
+          # Notification template id
+          notification_id,
+          # Journey id
+          template_id:,
+          request_options: {}
+        )
+        end
+
+        # List notification templates scoped to this journey. Journey-scoped notification
+        # templates can only be referenced from `send` nodes within the same journey.
+        sig do
+          params(
+            template_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::JourneyTemplateListResponse)
+        end
+        def list(
+          # Journey id
+          template_id,
+          # Pagination cursor from a prior response.
+          cursor: nil,
+          # Page size. Minimum 1, maximum 100.
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        # Archive the journey-scoped notification template. Archived templates cannot be
+        # sent.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def archive(
+          # Notification template id
+          notification_id,
+          # Journey id
+          template_id:,
+          request_options: {}
+        )
+        end
+
+        # List published versions of the journey-scoped notification template, ordered
+        # most recent first.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::NotificationTemplateVersionListResponse)
+        end
+        def list_versions(
+          # Notification template id
+          notification_id,
+          # Journey id
+          template_id:,
+          request_options: {}
+        )
+        end
+
+        # Publish the current draft of the journey-scoped notification template as a new
+        # version. Optionally roll back to a prior version by passing
+        # `{ "version": "vN" }`.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            version: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def publish(
+          # Path param: Notification template id
+          notification_id,
+          # Path param: Journey id
+          template_id:,
+          # Body param
+          version: nil,
+          request_options: {}
+        )
+        end
+
+        # Replace the journey-scoped notification template draft.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            notification:
+              Courier::JourneyTemplateReplaceRequest::Notification::OrHash,
+            state: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::JourneyTemplateGetResponse)
+        end
+        def replace(
+          # Path param: Notification template id
+          notification_id,
+          # Path param: Journey id
+          template_id:,
+          # Body param
+          notification:,
+          # Body param
+          state: 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/journeys.rbi

@@ -3,6 +3,69 @@
 module Courier
   module Resources
     class Journeys
+      sig { returns(Courier::Resources::Journeys::Templates) }
+      attr_reader :templates
+
+      # Create a journey. Defaults to `DRAFT` state; pass `state: "PUBLISHED"` to
+      # publish on create. Send nodes are not allowed on `POST`. The standard flow is:
+      # create the journey shell here, add notification templates with
+      # `POST /journeys/{templateId}/templates`, then wire them into the journey with
+      # `PUT /journeys/{templateId}`. Call `POST /journeys/{templateId}/publish` to
+      # publish a draft after the fact.
+      sig do
+        params(
+          name: String,
+          nodes:
+            T::Array[
+              T.any(
+                Courier::JourneyAPIInvokeTriggerNode::OrHash,
+                Courier::JourneySegmentTriggerNode::OrHash,
+                Courier::JourneySendNode::OrHash,
+                Courier::JourneyDelayDurationNode::OrHash,
+                Courier::JourneyDelayUntilNode::OrHash,
+                Courier::JourneyFetchGetDeleteNode::OrHash,
+                Courier::JourneyFetchPostPutNode::OrHash,
+                Courier::JourneyAINode::OrHash,
+                Courier::JourneyThrottleStaticNode::OrHash,
+                Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
+                Courier::JourneyExitNode::OrHash,
+                Courier::JourneyNode::JourneyBranchNode::OrHash
+              )
+            ],
+          enabled: T::Boolean,
+          state: Courier::JourneyState::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneyResponse)
+      end
+      def create(
+        name:,
+        nodes:,
+        enabled: nil,
+        # Lifecycle state of a journey.
+        state: nil,
+        request_options: {}
+      )
+      end
+
+      # Fetch a journey by id. Pass `?version=draft` (default `published`) to retrieve
+      # the working draft, or `?version=vN` to retrieve a historical version.
+      sig do
+        params(
+          template_id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneyResponse)
+      end
+      def retrieve(
+        # Journey id
+        template_id,
+        # Version selector: `draft`, `published` (default), or `vN`.
+        version: nil,
+        request_options: {}
+      )
+      end
+
       # Get the list of journeys.
       sig do
         params(
@@ -22,7 +85,23 @@ module Courier
       )
       end
 
-      # Invoke a journey run from a journey template.
+      # Archive a journey. Archived journeys cannot be invoked. Existing journey runs
+      # continue to completion.
+      sig do
+        params(
+          template_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def archive(
+        # Journey id
+        template_id,
+        request_options: {}
+      )
+      end
+
+      # Invoke a journey by id or alias to start a new run. The response includes a
+      # `runId` identifying the run.
       sig do
         params(
           template_id: String,
@@ -33,8 +112,8 @@ module Courier
         ).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.
+        # A unique identifier representing the journey to be invoked. Accepts a Journey ID
+        # or Journey 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
@@ -55,6 +134,82 @@ module Courier
       )
       end
 
+      # List published versions of a journey, ordered most recent first.
+      sig do
+        params(
+          template_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneyVersionsListResponse)
+      end
+      def list_versions(
+        # Journey id
+        template_id,
+        request_options: {}
+      )
+      end
+
+      # Publish the current draft as a new version. Body is optional; pass
+      # `{ "version": "vN" }` to roll back to a prior version instead. Returns 404 if
+      # the journey has no draft to publish.
+      sig do
+        params(
+          template_id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneyResponse)
+      end
+      def publish(
+        # Journey id
+        template_id,
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      # Replace the journey draft. Updates the working draft only; call
+      # `POST /journeys/{templateId}/publish` to make it live, or pass
+      # `state: "PUBLISHED"` in this request to publish immediately. Send-node
+      # `template` ids must already exist and be scoped to this journey, and node ids
+      # must not be claimed by another journey.
+      sig do
+        params(
+          template_id: String,
+          name: String,
+          nodes:
+            T::Array[
+              T.any(
+                Courier::JourneyAPIInvokeTriggerNode::OrHash,
+                Courier::JourneySegmentTriggerNode::OrHash,
+                Courier::JourneySendNode::OrHash,
+                Courier::JourneyDelayDurationNode::OrHash,
+                Courier::JourneyDelayUntilNode::OrHash,
+                Courier::JourneyFetchGetDeleteNode::OrHash,
+                Courier::JourneyFetchPostPutNode::OrHash,
+                Courier::JourneyAINode::OrHash,
+                Courier::JourneyThrottleStaticNode::OrHash,
+                Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
+                Courier::JourneyExitNode::OrHash,
+                Courier::JourneyNode::JourneyBranchNode::OrHash
+              )
+            ],
+          enabled: T::Boolean,
+          state: Courier::JourneyState::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::JourneyResponse)
+      end
+      def replace(
+        # Journey id
+        template_id,
+        name:,
+        nodes:,
+        enabled: nil,
+        # Lifecycle state of a journey.
+        state: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Courier::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/courier/resources/tenants/templates.rbi

@@ -44,6 +44,28 @@ module Courier
         )
         end
 
+        # Deletes the tenant's notification template with the given `template_id`.
+        #
+        # Returns **204 No Content** with an empty body on success.
+        #
+        # Returns **404** if there is no template with this ID for the tenant, including a
+        # second `DELETE` after a successful removal.
+        sig do
+          params(
+            template_id: String,
+            tenant_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Id of the template to remove from the tenant.
+          template_id,
+          # Id of the tenant that owns the template.
+          tenant_id:,
+          request_options: {}
+        )
+        end
+
         # Publishes a specific version of a notification template for a tenant.
         #
         # The template must already exist in the tenant's notification map. If no version

data/sig/courier/models/brand_create_params.rbs

@@ -3,8 +3,8 @@ module Courier
     type brand_create_params =
       {
         name: String,
+        settings: Courier::BrandSettings,
         id: String?,
-        settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?
       }
       & Courier::Internal::Type::request_parameters
@@ -15,24 +15,24 @@ module Courier
 
       attr_accessor name: String
 
-      attr_accessor id: String?
+      attr_accessor settings: Courier::BrandSettings
 
-      attr_accessor settings: Courier::BrandSettings?
+      attr_accessor id: String?
 
       attr_accessor snippets: Courier::BrandSnippets?
 
       def initialize: (
         name: String,
+        settings: Courier::BrandSettings,
         ?id: String?,
-        ?settings: Courier::BrandSettings?,
         ?snippets: Courier::BrandSnippets?,
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
         name: String,
+        settings: Courier::BrandSettings,
         id: String?,
-        settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?,
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/create_journey_request.rbs

@@ -0,0 +1,41 @@
+module Courier
+  module Models
+    type create_journey_request =
+      {
+        name: String,
+        nodes: ::Array[Courier::Models::journey_node],
+        enabled: bool,
+        state: Courier::Models::journey_state
+      }
+
+    class CreateJourneyRequest < Courier::Internal::Type::BaseModel
+      attr_accessor name: String
+
+      attr_accessor nodes: ::Array[Courier::Models::journey_node]
+
+      attr_reader enabled: bool?
+
+      def enabled=: (bool) -> bool
+
+      attr_reader state: Courier::Models::journey_state?
+
+      def state=: (
+        Courier::Models::journey_state
+      ) -> Courier::Models::journey_state
+
+      def initialize: (
+        name: String,
+        nodes: ::Array[Courier::Models::journey_node],
+        ?enabled: bool,
+        ?state: Courier::Models::journey_state
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        nodes: ::Array[Courier::Models::journey_node],
+        enabled: bool,
+        state: Courier::Models::journey_state
+      }
+    end
+  end
+end

data/sig/courier/models/journey_ai_node.rbs

@@ -0,0 +1,72 @@
+module Courier
+  module Models
+    type journey_ai_node =
+      {
+        output_schema: ::Hash[Symbol, top],
+        type: Courier::Models::JourneyAINode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field,
+        model: String,
+        user_prompt: String,
+        web_search: bool
+      }
+
+    class JourneyAINode < Courier::Internal::Type::BaseModel
+      attr_accessor output_schema: ::Hash[Symbol, top]
+
+      attr_accessor type: Courier::Models::JourneyAINode::type_
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader conditions: Courier::Models::journey_conditions_field?
+
+      def conditions=: (
+        Courier::Models::journey_conditions_field
+      ) -> Courier::Models::journey_conditions_field
+
+      attr_reader model: String?
+
+      def model=: (String) -> String
+
+      attr_reader user_prompt: String?
+
+      def user_prompt=: (String) -> String
+
+      attr_reader web_search: bool?
+
+      def web_search=: (bool) -> bool
+
+      def initialize: (
+        output_schema: ::Hash[Symbol, top],
+        type: Courier::Models::JourneyAINode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field,
+        ?model: String,
+        ?user_prompt: String,
+        ?web_search: bool
+      ) -> void
+
+      def to_hash: -> {
+        output_schema: ::Hash[Symbol, top],
+        type: Courier::Models::JourneyAINode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field,
+        model: String,
+        user_prompt: String,
+        web_search: bool
+      }
+
+      type type_ = :ai
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        AI: :ai
+
+        def self?.values: -> ::Array[Courier::Models::JourneyAINode::type_]
+      end
+    end
+  end
+end