trycourier 4.10.1 → 4.11.0

data/rbi/courier/resources/notifications/checks.rbi

@@ -4,6 +4,7 @@ module Courier
   module Resources
     class Notifications
       class Checks
+        # Replace the checks for a notification template submission.
         sig do
           params(
             submission_id: String,
@@ -13,9 +14,9 @@ module Courier
           ).returns(Courier::Models::Notifications::CheckUpdateResponse)
         end
         def update(
-          # Path param
+          # Path param: Submission ID.
           submission_id,
-          # Path param
+          # Path param: Notification template ID.
           id:,
           # Body param
           checks:,
@@ -23,6 +24,7 @@ module Courier
         )
         end
 
+        # Retrieve the checks for a notification template submission.
         sig do
           params(
             submission_id: String,
@@ -30,9 +32,16 @@ module Courier
             request_options: Courier::RequestOptions::OrHash
           ).returns(Courier::Models::Notifications::CheckListResponse)
         end
-        def list(submission_id, id:, request_options: {})
+        def list(
+          # Submission ID.
+          submission_id,
+          # Notification template ID.
+          id:,
+          request_options: {}
+        )
         end
 
+        # Cancel a notification template submission.
         sig do
           params(
             submission_id: String,
@@ -40,7 +49,13 @@ module Courier
             request_options: Courier::RequestOptions::OrHash
           ).void
         end
-        def delete(submission_id, id:, request_options: {})
+        def delete(
+          # Submission ID.
+          submission_id,
+          # Notification template ID.
+          id:,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/courier/resources/notifications.rbi

@@ -13,11 +13,11 @@ module Courier
           notification: Courier::NotificationTemplatePayload::OrHash,
           state: Courier::NotificationTemplateCreateRequest::State::OrSymbol,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::NotificationTemplateGetResponse)
+        ).returns(Courier::NotificationTemplateResponse)
       end
       def create(
-        # Full document shape used in POST and PUT request bodies, and returned inside the
-        # GET response envelope.
+        # Core template fields used in POST and PUT request bodies (nested under a
+        # `notification` key) and returned at the top level in responses.
         notification:,
         # Template state after creation. Case-insensitive input, normalized to uppercase
         # in the response. Defaults to "DRAFT".
@@ -33,7 +33,7 @@ module Courier
           id: String,
           version: String,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::NotificationTemplateGetResponse)
+        ).returns(Courier::NotificationTemplateResponse)
       end
       def retrieve(
         # Template ID (nt\_ prefix).
@@ -211,13 +211,13 @@ module Courier
           notification: Courier::NotificationTemplatePayload::OrHash,
           state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::NotificationTemplateGetResponse)
+        ).returns(Courier::NotificationTemplateResponse)
       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.
+        # Core template fields used in POST and PUT request bodies (nested under a
+        # `notification` key) and returned at the top level in responses.
         notification:,
         # Template state after update. Case-insensitive input, normalized to uppercase in
         # the response. Defaults to "DRAFT".

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/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

data/sig/courier/models/journey_api_invoke_trigger_node.rbs

@@ -0,0 +1,68 @@
+module Courier
+  module Models
+    type journey_api_invoke_trigger_node =
+      {
+        trigger_type: Courier::Models::JourneyAPIInvokeTriggerNode::trigger_type,
+        type: Courier::Models::JourneyAPIInvokeTriggerNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field,
+        schema: ::Hash[Symbol, top]
+      }
+
+    class JourneyAPIInvokeTriggerNode < Courier::Internal::Type::BaseModel
+      attr_accessor trigger_type: Courier::Models::JourneyAPIInvokeTriggerNode::trigger_type
+
+      attr_accessor type: Courier::Models::JourneyAPIInvokeTriggerNode::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 schema: ::Hash[Symbol, top]?
+
+      def schema=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      def initialize: (
+        trigger_type: Courier::Models::JourneyAPIInvokeTriggerNode::trigger_type,
+        type: Courier::Models::JourneyAPIInvokeTriggerNode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field,
+        ?schema: ::Hash[Symbol, top]
+      ) -> void
+
+      def to_hash: -> {
+        trigger_type: Courier::Models::JourneyAPIInvokeTriggerNode::trigger_type,
+        type: Courier::Models::JourneyAPIInvokeTriggerNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field,
+        schema: ::Hash[Symbol, top]
+      }
+
+      type trigger_type = :"api-invoke"
+
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        API_INVOKE: :"api-invoke"
+
+        def self?.values: -> ::Array[Courier::Models::JourneyAPIInvokeTriggerNode::trigger_type]
+      end
+
+      type type_ = :trigger
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TRIGGER: :trigger
+
+        def self?.values: -> ::Array[Courier::Models::JourneyAPIInvokeTriggerNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_archive_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type journey_archive_params =
+      { template_id: String } & Courier::Internal::Type::request_parameters
+
+    class JourneyArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor template_id: String
+
+      def initialize: (
+        template_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        template_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/journey_condition_atom.rbs

@@ -0,0 +1,7 @@
+module Courier
+  module Models
+    type journey_condition_atom = ::Array[String]
+
+    JourneyConditionAtom: Courier::Internal::Type::Converter
+  end
+end

data/sig/courier/models/journey_condition_group.rbs

@@ -0,0 +1,33 @@
+module Courier
+  module Models
+    type journey_condition_group =
+      {
+        and_: ::Array[Courier::Models::journey_condition_atom],
+        or_: ::Array[Courier::Models::journey_condition_atom]
+      }
+
+    class JourneyConditionGroup < Courier::Internal::Type::BaseModel
+      attr_reader and_: ::Array[Courier::Models::journey_condition_atom]?
+
+      def and_=: (
+        ::Array[Courier::Models::journey_condition_atom]
+      ) -> ::Array[Courier::Models::journey_condition_atom]
+
+      attr_reader or_: ::Array[Courier::Models::journey_condition_atom]?
+
+      def or_=: (
+        ::Array[Courier::Models::journey_condition_atom]
+      ) -> ::Array[Courier::Models::journey_condition_atom]
+
+      def initialize: (
+        ?and_: ::Array[Courier::Models::journey_condition_atom],
+        ?or_: ::Array[Courier::Models::journey_condition_atom]
+      ) -> void
+
+      def to_hash: -> {
+        and_: ::Array[Courier::Models::journey_condition_atom],
+        or_: ::Array[Courier::Models::journey_condition_atom]
+      }
+    end
+  end
+end

data/sig/courier/models/journey_condition_nested_group.rbs

@@ -0,0 +1,33 @@
+module Courier
+  module Models
+    type journey_condition_nested_group =
+      {
+        and_: ::Array[Courier::JourneyConditionGroup],
+        or_: ::Array[Courier::JourneyConditionGroup]
+      }
+
+    class JourneyConditionNestedGroup < Courier::Internal::Type::BaseModel
+      attr_reader and_: ::Array[Courier::JourneyConditionGroup]?
+
+      def and_=: (
+        ::Array[Courier::JourneyConditionGroup]
+      ) -> ::Array[Courier::JourneyConditionGroup]
+
+      attr_reader or_: ::Array[Courier::JourneyConditionGroup]?
+
+      def or_=: (
+        ::Array[Courier::JourneyConditionGroup]
+      ) -> ::Array[Courier::JourneyConditionGroup]
+
+      def initialize: (
+        ?and_: ::Array[Courier::JourneyConditionGroup],
+        ?or_: ::Array[Courier::JourneyConditionGroup]
+      ) -> void
+
+      def to_hash: -> {
+        and_: ::Array[Courier::JourneyConditionGroup],
+        or_: ::Array[Courier::JourneyConditionGroup]
+      }
+    end
+  end
+end

data/sig/courier/models/journey_conditions_field.rbs

@@ -0,0 +1,14 @@
+module Courier
+  module Models
+    type journey_conditions_field =
+      Courier::Models::journey_condition_atom
+      | Courier::JourneyConditionGroup
+      | Courier::JourneyConditionNestedGroup
+
+    module JourneyConditionsField
+      extend Courier::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Courier::Models::journey_conditions_field]
+    end
+  end
+end

data/sig/courier/models/journey_create_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type journey_create_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class JourneyCreateParams < Courier::Models::CreateJourneyRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/journey_delay_duration_node.rbs

@@ -0,0 +1,66 @@
+module Courier
+  module Models
+    type journey_delay_duration_node =
+      {
+        duration: String,
+        mode: Courier::Models::JourneyDelayDurationNode::mode,
+        type: Courier::Models::JourneyDelayDurationNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+    class JourneyDelayDurationNode < Courier::Internal::Type::BaseModel
+      attr_accessor duration: String
+
+      attr_accessor mode: Courier::Models::JourneyDelayDurationNode::mode
+
+      attr_accessor type: Courier::Models::JourneyDelayDurationNode::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
+
+      def initialize: (
+        duration: String,
+        mode: Courier::Models::JourneyDelayDurationNode::mode,
+        type: Courier::Models::JourneyDelayDurationNode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field
+      ) -> void
+
+      def to_hash: -> {
+        duration: String,
+        mode: Courier::Models::JourneyDelayDurationNode::mode,
+        type: Courier::Models::JourneyDelayDurationNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+      type mode = :duration
+
+      module Mode
+        extend Courier::Internal::Type::Enum
+
+        DURATION: :duration
+
+        def self?.values: -> ::Array[Courier::Models::JourneyDelayDurationNode::mode]
+      end
+
+      type type_ = :delay
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        DELAY: :delay
+
+        def self?.values: -> ::Array[Courier::Models::JourneyDelayDurationNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_delay_until_node.rbs

@@ -0,0 +1,66 @@
+module Courier
+  module Models
+    type journey_delay_until_node =
+      {
+        mode: Courier::Models::JourneyDelayUntilNode::mode,
+        type: Courier::Models::JourneyDelayUntilNode::type_,
+        until_: String,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+    class JourneyDelayUntilNode < Courier::Internal::Type::BaseModel
+      attr_accessor mode: Courier::Models::JourneyDelayUntilNode::mode
+
+      attr_accessor type: Courier::Models::JourneyDelayUntilNode::type_
+
+      attr_accessor until_: String
+
+      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
+
+      def initialize: (
+        mode: Courier::Models::JourneyDelayUntilNode::mode,
+        type: Courier::Models::JourneyDelayUntilNode::type_,
+        until_: String,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field
+      ) -> void
+
+      def to_hash: -> {
+        mode: Courier::Models::JourneyDelayUntilNode::mode,
+        type: Courier::Models::JourneyDelayUntilNode::type_,
+        until_: String,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+      type mode = :until
+
+      module Mode
+        extend Courier::Internal::Type::Enum
+
+        UNTIL: :until
+
+        def self?.values: -> ::Array[Courier::Models::JourneyDelayUntilNode::mode]
+      end
+
+      type type_ = :delay
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        DELAY: :delay
+
+        def self?.values: -> ::Array[Courier::Models::JourneyDelayUntilNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_exit_node.rbs

@@ -0,0 +1,34 @@
+module Courier
+  module Models
+    type journey_exit_node =
+      { type: Courier::Models::JourneyExitNode::type_, id: String }
+
+    class JourneyExitNode < Courier::Internal::Type::BaseModel
+      attr_accessor type: Courier::Models::JourneyExitNode::type_
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      def initialize: (
+        type: Courier::Models::JourneyExitNode::type_,
+        ?id: String
+      ) -> void
+
+      def to_hash: -> {
+        type: Courier::Models::JourneyExitNode::type_,
+        id: String
+      }
+
+      type type_ = :exit
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        EXIT: :exit
+
+        def self?.values: -> ::Array[Courier::Models::JourneyExitNode::type_]
+      end
+    end
+  end
+end