trycourier 4.10.1 → 4.11.0

data/rbi/courier/models/journey_throttle_static_node.rbi

@@ -0,0 +1,158 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyThrottleStaticNode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyThrottleStaticNode, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :max_allowed
+
+      sig { returns(String) }
+      attr_accessor :period
+
+      sig { returns(Courier::JourneyThrottleStaticNode::Scope::OrSymbol) }
+      attr_accessor :scope
+
+      sig { returns(Courier::JourneyThrottleStaticNode::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
+
+      # Throttle the journey by a static `scope` (`user` or `global`), allowing at most
+      # `max_allowed` invocations per `period`.
+      sig do
+        params(
+          max_allowed: Integer,
+          period: String,
+          scope: Courier::JourneyThrottleStaticNode::Scope::OrSymbol,
+          type: Courier::JourneyThrottleStaticNode::Type::OrSymbol,
+          id: String,
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            )
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        max_allowed:,
+        period:,
+        scope:,
+        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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            max_allowed: Integer,
+            period: String,
+            scope: Courier::JourneyThrottleStaticNode::Scope::OrSymbol,
+            type: Courier::JourneyThrottleStaticNode::Type::OrSymbol,
+            id: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              )
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyThrottleStaticNode::Scope)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        USER =
+          T.let(:user, Courier::JourneyThrottleStaticNode::Scope::TaggedSymbol)
+        GLOBAL =
+          T.let(
+            :global,
+            Courier::JourneyThrottleStaticNode::Scope::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyThrottleStaticNode::Scope::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyThrottleStaticNode::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        THROTTLE =
+          T.let(
+            :throttle,
+            Courier::JourneyThrottleStaticNode::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyThrottleStaticNode::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_version_item.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyVersionItem < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyVersionItem, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :created
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :creator
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :published
+
+      sig { returns(String) }
+      attr_accessor :version
+
+      # A published version of a journey.
+      sig do
+        params(
+          created: T.nilable(Integer),
+          creator: T.nilable(String),
+          name: String,
+          published: T.nilable(Integer),
+          version: String
+        ).returns(T.attached_class)
+      end
+      def self.new(created:, creator:, name:, published:, version:)
+      end
+
+      sig do
+        override.returns(
+          {
+            created: T.nilable(Integer),
+            creator: T.nilable(String),
+            name: String,
+            published: T.nilable(Integer),
+            version: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_versions_list_response.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyVersionsListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneyVersionsListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::JourneyVersionItem]) }
+      attr_accessor :results
+
+      # Paged list of published journey versions, most recent first.
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          results: T::Array[Courier::JourneyVersionItem::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, results:)
+      end
+
+      sig do
+        override.returns(
+          {
+            paging: Courier::Paging,
+            results: T::Array[Courier::JourneyVersionItem]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys/template_archive_params.rbi

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

data/rbi/courier/models/journeys/template_create_params.rbi

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

data/rbi/courier/models/journeys/template_list_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Journeys
+      class TemplateListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Journeys::TemplateListParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :template_id
+
+        # Pagination cursor from a prior response.
+        sig { returns(T.nilable(String)) }
+        attr_reader :cursor
+
+        sig { params(cursor: String).void }
+        attr_writer :cursor
+
+        # Page size. Minimum 1, maximum 100.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        sig do
+          params(
+            template_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          template_id:,
+          # Pagination cursor from a prior response.
+          cursor: nil,
+          # Page size. Minimum 1, maximum 100.
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              template_id: String,
+              cursor: String,
+              limit: Integer,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journeys/template_list_versions_params.rbi

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

data/rbi/courier/models/journeys/template_publish_params.rbi

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

data/rbi/courier/models/journeys/template_replace_params.rbi

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

data/rbi/courier/models/journeys/template_retrieve_params.rbi

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

data/rbi/courier/models/notification_list_response.rbi

@@ -89,9 +89,6 @@ module Courier
           sig { returns(T::Array[String]) }
           attr_accessor :event_ids
 
-          sig { returns(String) }
-          attr_accessor :note
-
           sig { returns(Courier::MessageRouting) }
           attr_reader :routing
 
@@ -104,6 +101,12 @@ module Courier
           sig { returns(Integer) }
           attr_accessor :updated_at
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :note
+
+          sig { params(note: String).void }
+          attr_writer :note
+
           sig do
             returns(
               T.nilable(
@@ -131,10 +134,10 @@ module Courier
               id: String,
               created_at: Integer,
               event_ids: T::Array[String],
-              note: String,
               routing: Courier::MessageRouting::OrHash,
               topic_id: String,
               updated_at: Integer,
+              note: String,
               tags:
                 T.nilable(
                   Courier::Models::NotificationListResponse::Result::Notification::Tags::OrHash
@@ -147,10 +150,10 @@ module Courier
             created_at:,
             # Array of event IDs associated with this notification
             event_ids:,
-            note:,
             routing:,
             topic_id:,
             updated_at:,
+            note: nil,
             tags: nil,
             title: nil
           )
@@ -162,10 +165,10 @@ module Courier
                 id: String,
                 created_at: Integer,
                 event_ids: T::Array[String],
-                note: String,
                 routing: Courier::MessageRouting,
                 topic_id: String,
                 updated_at: Integer,
+                note: String,
                 tags:
                   T.nilable(
                     Courier::Models::NotificationListResponse::Result::Notification::Tags

data/rbi/courier/models/notification_template_create_request.rbi

@@ -11,8 +11,8 @@ module Courier
           )
         end
 
-      # 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.
       sig { returns(Courier::NotificationTemplatePayload) }
       attr_reader :notification
 
@@ -45,8 +45,8 @@ module Courier
         ).returns(T.attached_class)
       end
       def self.new(
-        # 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".

data/rbi/courier/models/notification_template_payload.rbi

@@ -65,8 +65,8 @@ module Courier
       sig { returns(T::Array[String]) }
       attr_accessor :tags
 
-      # 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.
       sig do
         params(
           brand: T.nilable(Courier::NotificationTemplatePayload::Brand::OrHash),