trycourier 4.7.1 → 4.9.0

data/rbi/courier/models/bulk_run_job_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::BulkRunJobParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :job_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          job_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(job_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { job_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/channel.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Channel < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Channel, Courier::Internal::AnyHash) }
+
+      # Brand id used for rendering.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
+      # JS conditional with access to data/profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :if_
+
+      sig { returns(T.nilable(Courier::ChannelMetadata)) }
+      attr_reader :metadata
+
+      sig { params(metadata: T.nilable(Courier::ChannelMetadata::OrHash)).void }
+      attr_writer :metadata
+
+      # Channel specific overrides.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      # Providers enabled for this channel.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :providers
+
+      # Defaults to `single`.
+      sig { returns(T.nilable(Courier::Channel::RoutingMethod::OrSymbol)) }
+      attr_accessor :routing_method
+
+      sig { returns(T.nilable(Courier::Timeouts)) }
+      attr_reader :timeouts
+
+      sig { params(timeouts: T.nilable(Courier::Timeouts::OrHash)).void }
+      attr_writer :timeouts
+
+      sig do
+        params(
+          brand_id: T.nilable(String),
+          if_: T.nilable(String),
+          metadata: T.nilable(Courier::ChannelMetadata::OrHash),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          providers: T.nilable(T::Array[String]),
+          routing_method: T.nilable(Courier::Channel::RoutingMethod::OrSymbol),
+          timeouts: T.nilable(Courier::Timeouts::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Brand id used for rendering.
+        brand_id: nil,
+        # JS conditional with access to data/profile.
+        if_: nil,
+        metadata: nil,
+        # Channel specific overrides.
+        override: nil,
+        # Providers enabled for this channel.
+        providers: nil,
+        # Defaults to `single`.
+        routing_method: nil,
+        timeouts: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_id: T.nilable(String),
+            if_: T.nilable(String),
+            metadata: T.nilable(Courier::ChannelMetadata),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            providers: T.nilable(T::Array[String]),
+            routing_method:
+              T.nilable(Courier::Channel::RoutingMethod::OrSymbol),
+            timeouts: T.nilable(Courier::Timeouts)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Defaults to `single`.
+      module RoutingMethod
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Channel::RoutingMethod) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALL = T.let(:all, Courier::Channel::RoutingMethod::TaggedSymbol)
+        SINGLE = T.let(:single, Courier::Channel::RoutingMethod::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::Channel::RoutingMethod::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/channel_metadata.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ChannelMetadata < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ChannelMetadata, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Courier::Utm)) }
+      attr_reader :utm
+
+      sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
+      attr_writer :utm
+
+      sig do
+        params(utm: T.nilable(Courier::Utm::OrHash)).returns(T.attached_class)
+      end
+      def self.new(utm: nil)
+      end
+
+      sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_content.rbi

@@ -18,7 +18,8 @@ module Courier
               Courier::ElementalImageNodeWithType,
               Courier::ElementalActionNodeWithType,
               Courier::ElementalDividerNodeWithType,
-              Courier::ElementalQuoteNodeWithType
+              Courier::ElementalQuoteNodeWithType,
+              Courier::ElementalHTMLNodeWithType
             )
           ]
         )
@@ -29,9 +30,6 @@ module Courier
       sig { returns(String) }
       attr_accessor :version
 
-      sig { returns(T.nilable(String)) }
-      attr_accessor :brand
-
       sig do
         params(
           elements:
@@ -43,18 +41,17 @@ module Courier
                 Courier::ElementalImageNodeWithType::OrHash,
                 Courier::ElementalActionNodeWithType::OrHash,
                 Courier::ElementalDividerNodeWithType::OrHash,
-                Courier::ElementalQuoteNodeWithType::OrHash
+                Courier::ElementalQuoteNodeWithType::OrHash,
+                Courier::ElementalHTMLNodeWithType::OrHash
               )
             ],
-          version: String,
-          brand: T.nilable(String)
+          version: String
         ).returns(T.attached_class)
       end
       def self.new(
         elements:,
         # For example, "2022-01-01"
-        version:,
-        brand: nil
+        version:
       )
       end
 
@@ -70,11 +67,11 @@ module Courier
                   Courier::ElementalImageNodeWithType,
                   Courier::ElementalActionNodeWithType,
                   Courier::ElementalDividerNodeWithType,
-                  Courier::ElementalQuoteNodeWithType
+                  Courier::ElementalQuoteNodeWithType,
+                  Courier::ElementalHTMLNodeWithType
                 )
               ],
-            version: String,
-            brand: T.nilable(String)
+            version: String
           }
         )
       end

data/rbi/courier/models/elemental_html_node_with_type.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalHTMLNodeWithType < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalHTMLNodeWithType, Courier::Internal::AnyHash)
+        end
+
+      sig do
+        returns(T.nilable(Courier::ElementalHTMLNodeWithType::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(type: nil)
+      end
+
+      sig do
+        override.returns(
+          { type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol }
+        )
+      end
+      def to_hash
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::ElementalHTMLNodeWithType::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HTML =
+          T.let(:html, Courier::ElementalHTMLNodeWithType::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::ElementalHTMLNodeWithType::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_node.rbi

@@ -24,7 +24,8 @@ module Courier
             Courier::ElementalImageNodeWithType,
             Courier::ElementalActionNodeWithType,
             Courier::ElementalDividerNodeWithType,
-            Courier::ElementalQuoteNodeWithType
+            Courier::ElementalQuoteNodeWithType,
+            Courier::ElementalHTMLNodeWithType
           )
         end
 

data/rbi/courier/models/journey.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Journey < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Journey, Courier::Internal::AnyHash) }
+
+      # The unique identifier of the journey.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The name of the journey.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The version of the journey (published or draft).
+      sig { returns(Courier::Journey::Version::TaggedSymbol) }
+      attr_accessor :version
+
+      # ISO 8601 timestamp when the journey was created.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # ISO 8601 timestamp when the journey was last updated.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      # A journey template representing an automation workflow.
+      sig do
+        params(
+          id: String,
+          name: String,
+          version: Courier::Journey::Version::OrSymbol,
+          created_at: Time,
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier of the journey.
+        id:,
+        # The name of the journey.
+        name:,
+        # The version of the journey (published or draft).
+        version:,
+        # ISO 8601 timestamp when the journey was created.
+        created_at: nil,
+        # ISO 8601 timestamp when the journey was last updated.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            name: String,
+            version: Courier::Journey::Version::TaggedSymbol,
+            created_at: Time,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The version of the journey (published or draft).
+      module Version
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Courier::Journey::Version) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PUBLISHED = T.let(:published, Courier::Journey::Version::TaggedSymbol)
+        DRAFT = T.let(:draft, Courier::Journey::Version::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Courier::Journey::Version::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_invoke_params.rbi

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

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyListParams, Courier::Internal::AnyHash)
+        end
+
+      # A cursor token for pagination. Use the cursor from the previous response to
+      # fetch the next page of results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # The version of journeys to retrieve. Accepted values are published (for
+      # published journeys) or draft (for draft journeys). Defaults to published.
+      sig { returns(T.nilable(Courier::JourneyListParams::Version::OrSymbol)) }
+      attr_reader :version
+
+      sig do
+        params(version: Courier::JourneyListParams::Version::OrSymbol).void
+      end
+      attr_writer :version
+
+      sig do
+        params(
+          cursor: String,
+          version: Courier::JourneyListParams::Version::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            version: Courier::JourneyListParams::Version::OrSymbol,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The version of journeys to retrieve. Accepted values are published (for
+      # published journeys) or draft (for draft journeys). Defaults to published.
+      module Version
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::JourneyListParams::Version) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PUBLISHED =
+          T.let(:published, Courier::JourneyListParams::Version::TaggedSymbol)
+        DRAFT = T.let(:draft, Courier::JourneyListParams::Version::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyListParams::Version::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys_invoke_request.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneysInvokeRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneysInvokeRequest, Courier::Internal::AnyHash)
+        end
+
+      # 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.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :data
+
+      sig { params(data: T::Hash[Symbol, T.anything]).void }
+      attr_writer :data
+
+      # 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.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :profile
+
+      sig { params(profile: T::Hash[Symbol, T.anything]).void }
+      attr_writer :profile
+
+      # A unique identifier for the user. If not provided, the system will attempt to
+      # resolve the user identifier from profile or data objects.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_id
+
+      sig { params(user_id: String).void }
+      attr_writer :user_id
+
+      # Request body for invoking a journey. Requires either a user identifier or a
+      # profile with contact information. User identifiers can be provided via user_id
+      # field, or resolved from profile/data objects (user_id, userId, or anonymousId
+      # fields).
+      sig do
+        params(
+          data: T::Hash[Symbol, T.anything],
+          profile: T::Hash[Symbol, T.anything],
+          user_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Hash[Symbol, T.anything],
+            profile: T::Hash[Symbol, T.anything],
+            user_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys_invoke_response.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneysInvokeResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneysInvokeResponse, Courier::Internal::AnyHash)
+        end
+
+      # A unique identifier for the journey run that was created.
+      sig { returns(String) }
+      attr_accessor :run_id
+
+      sig { params(run_id: String).returns(T.attached_class) }
+      def self.new(
+        # A unique identifier for the journey run that was created.
+        run_id:
+      )
+      end
+
+      sig { override.returns({ run_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys_list_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneysListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneysListResponse, Courier::Internal::AnyHash)
+        end
+
+      # A cursor token for pagination. Present when there are more results available.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      sig { returns(T.nilable(T::Array[Courier::Journey])) }
+      attr_reader :templates
+
+      sig { params(templates: T::Array[Courier::Journey::OrHash]).void }
+      attr_writer :templates
+
+      sig do
+        params(
+          cursor: String,
+          templates: T::Array[Courier::Journey::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A cursor token for pagination. Present when there are more results available.
+        cursor: nil,
+        templates: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { cursor: String, templates: T::Array[Courier::Journey] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/list_delete_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::ListDeleteParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :list_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          list_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(list_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { list_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end