trycourier 4.10.2 → 4.12.0

data/rbi/courier/models/brand_create_params.rbi

@@ -14,15 +14,15 @@ module Courier
       sig { returns(String) }
       attr_accessor :name
 
-      sig { returns(T.nilable(String)) }
-      attr_accessor :id
-
-      sig { returns(T.nilable(Courier::BrandSettings)) }
+      sig { returns(Courier::BrandSettings) }
       attr_reader :settings
 
-      sig { params(settings: T.nilable(Courier::BrandSettings::OrHash)).void }
+      sig { params(settings: Courier::BrandSettings::OrHash).void }
       attr_writer :settings
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :id
+
       sig { returns(T.nilable(Courier::BrandSnippets)) }
       attr_reader :snippets
 
@@ -32,16 +32,16 @@ module Courier
       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(T.attached_class)
       end
       def self.new(
         name:,
+        settings:,
         id: nil,
-        settings: nil,
         snippets: nil,
         request_options: {}
       )
@@ -51,8 +51,8 @@ module Courier
         override.returns(
           {
             name: String,
+            settings: Courier::BrandSettings,
             id: T.nilable(String),
-            settings: T.nilable(Courier::BrandSettings),
             snippets: T.nilable(Courier::BrandSnippets),
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/create_journey_request.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Courier
+  module Models
+    class CreateJourneyRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::CreateJourneyRequest, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        returns(
+          T::Array[
+            T.any(
+              Courier::JourneyAPIInvokeTriggerNode,
+              Courier::JourneySegmentTriggerNode,
+              Courier::JourneySendNode,
+              Courier::JourneyDelayDurationNode,
+              Courier::JourneyDelayUntilNode,
+              Courier::JourneyFetchGetDeleteNode,
+              Courier::JourneyFetchPostPutNode,
+              Courier::JourneyAINode,
+              Courier::JourneyThrottleStaticNode,
+              Courier::JourneyThrottleDynamicNode,
+              Courier::JourneyNode::JourneyBatchNode,
+              Courier::JourneyExitNode,
+              Courier::JourneyNode::JourneyBranchNode
+            )
+          ]
+        )
+      end
+      attr_accessor :nodes
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enabled
+
+      sig { params(enabled: T::Boolean).void }
+      attr_writer :enabled
+
+      # Lifecycle state of a journey.
+      sig { returns(T.nilable(Courier::JourneyState::OrSymbol)) }
+      attr_reader :state
+
+      sig { params(state: Courier::JourneyState::OrSymbol).void }
+      attr_writer :state
+
+      # Request body for creating a journey.
+      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
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        name:,
+        nodes:,
+        enabled: nil,
+        # Lifecycle state of a journey.
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            nodes:
+              T::Array[
+                T.any(
+                  Courier::JourneyAPIInvokeTriggerNode,
+                  Courier::JourneySegmentTriggerNode,
+                  Courier::JourneySendNode,
+                  Courier::JourneyDelayDurationNode,
+                  Courier::JourneyDelayUntilNode,
+                  Courier::JourneyFetchGetDeleteNode,
+                  Courier::JourneyFetchPostPutNode,
+                  Courier::JourneyAINode,
+                  Courier::JourneyThrottleStaticNode,
+                  Courier::JourneyThrottleDynamicNode,
+                  Courier::JourneyNode::JourneyBatchNode,
+                  Courier::JourneyExitNode,
+                  Courier::JourneyNode::JourneyBranchNode
+                )
+              ],
+            enabled: T::Boolean,
+            state: Courier::JourneyState::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_ai_node.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyAINode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyAINode, Courier::Internal::AnyHash)
+        end
+
+      # A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :output_schema
+
+      sig { returns(Courier::JourneyAINode::Type::OrSymbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+      # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+      # express "no conditions".
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup,
+              Courier::JourneyConditionNestedGroup
+            )
+          )
+        )
+      end
+      attr_reader :conditions
+
+      sig do
+        params(
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            )
+        ).void
+      end
+      attr_writer :conditions
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :model
+
+      sig { params(model: String).void }
+      attr_writer :model
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_prompt
+
+      sig { params(user_prompt: String).void }
+      attr_writer :user_prompt
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :web_search
+
+      sig { params(web_search: T::Boolean).void }
+      attr_writer :web_search
+
+      # Invoke an AI step with `user_prompt` and optional `web_search`. Returns a
+      # structured response conforming to `output_schema`.
+      sig do
+        params(
+          output_schema: T::Hash[Symbol, T.anything],
+          type: Courier::JourneyAINode::Type::OrSymbol,
+          id: String,
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            ),
+          model: String,
+          user_prompt: String,
+          web_search: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+        output_schema:,
+        type:,
+        id: nil,
+        # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+        # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+        # express "no conditions".
+        conditions: nil,
+        model: nil,
+        user_prompt: nil,
+        web_search: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            output_schema: T::Hash[Symbol, T.anything],
+            type: Courier::JourneyAINode::Type::OrSymbol,
+            id: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              ),
+            model: String,
+            user_prompt: String,
+            web_search: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::JourneyAINode::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AI = T.let(:ai, Courier::JourneyAINode::Type::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Courier::JourneyAINode::Type::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_api_invoke_trigger_node.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyAPIInvokeTriggerNode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneyAPIInvokeTriggerNode,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(Courier::JourneyAPIInvokeTriggerNode::TriggerType::OrSymbol)
+      end
+      attr_accessor :trigger_type
+
+      sig { returns(Courier::JourneyAPIInvokeTriggerNode::Type::OrSymbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+      # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+      # express "no conditions".
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup,
+              Courier::JourneyConditionNestedGroup
+            )
+          )
+        )
+      end
+      attr_reader :conditions
+
+      sig do
+        params(
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            )
+        ).void
+      end
+      attr_writer :conditions
+
+      # A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :schema
+
+      sig { params(schema: T::Hash[Symbol, T.anything]).void }
+      attr_writer :schema
+
+      # Trigger fired when the journey is invoked via the API. The optional `schema`
+      # field is a JSON Schema that validates the invocation payload.
+      sig do
+        params(
+          trigger_type:
+            Courier::JourneyAPIInvokeTriggerNode::TriggerType::OrSymbol,
+          type: Courier::JourneyAPIInvokeTriggerNode::Type::OrSymbol,
+          id: String,
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            ),
+          schema: T::Hash[Symbol, T.anything]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        trigger_type:,
+        type:,
+        id: nil,
+        # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+        # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+        # express "no conditions".
+        conditions: nil,
+        # A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+        schema: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            trigger_type:
+              Courier::JourneyAPIInvokeTriggerNode::TriggerType::OrSymbol,
+            type: Courier::JourneyAPIInvokeTriggerNode::Type::OrSymbol,
+            id: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              ),
+            schema: T::Hash[Symbol, T.anything]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyAPIInvokeTriggerNode::TriggerType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        API_INVOKE =
+          T.let(
+            :"api-invoke",
+            Courier::JourneyAPIInvokeTriggerNode::TriggerType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::JourneyAPIInvokeTriggerNode::TriggerType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyAPIInvokeTriggerNode::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRIGGER =
+          T.let(
+            :trigger,
+            Courier::JourneyAPIInvokeTriggerNode::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyAPIInvokeTriggerNode::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_archive_params.rbi

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

data/rbi/courier/models/journey_condition_atom.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    JourneyConditionAtom =
+      T.let(
+        Courier::Internal::Type::ArrayOf[String],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/journey_condition_group.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyConditionGroup < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyConditionGroup, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(T::Array[T::Array[String]])) }
+      attr_reader :and_
+
+      sig { params(and_: T::Array[T::Array[String]]).void }
+      attr_writer :and_
+
+      sig { returns(T.nilable(T::Array[T::Array[String]])) }
+      attr_reader :or_
+
+      sig { params(or_: T::Array[T::Array[String]]).void }
+      attr_writer :or_
+
+      # A leaf condition group. Exactly one of `AND` or `OR` must be present at runtime;
+      # each is a list of `JourneyConditionAtom` tuples.
+      sig do
+        params(
+          and_: T::Array[T::Array[String]],
+          or_: T::Array[T::Array[String]]
+        ).returns(T.attached_class)
+      end
+      def self.new(and_: nil, or_: nil)
+      end
+
+      sig do
+        override.returns(
+          { and_: T::Array[T::Array[String]], or_: T::Array[T::Array[String]] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_condition_nested_group.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyConditionNestedGroup < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneyConditionNestedGroup,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(T::Array[Courier::JourneyConditionGroup])) }
+      attr_reader :and_
+
+      sig do
+        params(and_: T::Array[Courier::JourneyConditionGroup::OrHash]).void
+      end
+      attr_writer :and_
+
+      sig { returns(T.nilable(T::Array[Courier::JourneyConditionGroup])) }
+      attr_reader :or_
+
+      sig { params(or_: T::Array[Courier::JourneyConditionGroup::OrHash]).void }
+      attr_writer :or_
+
+      # A nested condition group. Exactly one of `AND` or `OR` must be present at
+      # runtime; each is a list of `JourneyConditionGroup` items.
+      sig do
+        params(
+          and_: T::Array[Courier::JourneyConditionGroup::OrHash],
+          or_: T::Array[Courier::JourneyConditionGroup::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(and_: nil, or_: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            and_: T::Array[Courier::JourneyConditionGroup],
+            or_: T::Array[Courier::JourneyConditionGroup]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_conditions_field.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+    # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+    # express "no conditions".
+    module JourneyConditionsField
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            T::Array[String],
+            Courier::JourneyConditionGroup,
+            Courier::JourneyConditionNestedGroup
+          )
+        end
+
+      sig do
+        override.returns(T::Array[Courier::JourneyConditionsField::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_create_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyCreateParams < Courier::Models::CreateJourneyRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyCreateParams, 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