trycourier 4.8.0 → 4.10.0

data/rbi/courier/models/notification_template_get_response.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateGetResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateGetResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Epoch milliseconds when the template was created.
+      sig { returns(Integer) }
+      attr_accessor :created
+
+      # User ID of the creator.
+      sig { returns(String) }
+      attr_accessor :creator
+
+      # Full document shape used in POST and PUT request bodies, and returned inside the
+      # GET response envelope.
+      sig { returns(Courier::NotificationTemplateGetResponse::Notification) }
+      attr_reader :notification
+
+      sig do
+        params(
+          notification:
+            Courier::NotificationTemplateGetResponse::Notification::OrHash
+        ).void
+      end
+      attr_writer :notification
+
+      # The template state. Always uppercase.
+      sig do
+        returns(Courier::NotificationTemplateGetResponse::State::TaggedSymbol)
+      end
+      attr_accessor :state
+
+      # Epoch milliseconds of last update.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :updated
+
+      sig { params(updated: Integer).void }
+      attr_writer :updated
+
+      # User ID of the last updater.
+      sig { returns(T.nilable(String)) }
+      attr_reader :updater
+
+      sig { params(updater: String).void }
+      attr_writer :updater
+
+      # Envelope response for GET /notifications/{id}. The notification object mirrors
+      # the POST/PUT input shape. Nullable fields return null when unset.
+      sig do
+        params(
+          created: Integer,
+          creator: String,
+          notification:
+            Courier::NotificationTemplateGetResponse::Notification::OrHash,
+          state: Courier::NotificationTemplateGetResponse::State::OrSymbol,
+          updated: Integer,
+          updater: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Epoch milliseconds when the template was created.
+        created:,
+        # User ID of the creator.
+        creator:,
+        # Full document shape used in POST and PUT request bodies, and returned inside the
+        # GET response envelope.
+        notification:,
+        # The template state. Always uppercase.
+        state:,
+        # Epoch milliseconds of last update.
+        updated: nil,
+        # User ID of the last updater.
+        updater: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created: Integer,
+            creator: String,
+            notification:
+              Courier::NotificationTemplateGetResponse::Notification,
+            state:
+              Courier::NotificationTemplateGetResponse::State::TaggedSymbol,
+            updated: Integer,
+            updater: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Notification < Courier::Models::NotificationTemplatePayload
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationTemplateGetResponse::Notification,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # The template ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Full document shape used in POST and PUT request bodies, and returned inside the
+        # GET response envelope.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The template ID.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      # The template state. Always uppercase.
+      module State
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationTemplateGetResponse::State)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            Courier::NotificationTemplateGetResponse::State::TaggedSymbol
+          )
+        PUBLISHED =
+          T.let(
+            :PUBLISHED,
+            Courier::NotificationTemplateGetResponse::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationTemplateGetResponse::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_mutation_response.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateMutationResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateMutationResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(Courier::NotificationTemplateMutationResponse::Notification)
+      end
+      attr_reader :notification
+
+      sig do
+        params(
+          notification:
+            Courier::NotificationTemplateMutationResponse::Notification::OrHash
+        ).void
+      end
+      attr_writer :notification
+
+      # The template state after the operation. Always uppercase.
+      sig do
+        returns(
+          Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
+        )
+      end
+      attr_accessor :state
+
+      # Response returned by POST and PUT operations.
+      sig do
+        params(
+          notification:
+            Courier::NotificationTemplateMutationResponse::Notification::OrHash,
+          state: Courier::NotificationTemplateMutationResponse::State::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        notification:,
+        # The template state after the operation. Always uppercase.
+        state:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            notification:
+              Courier::NotificationTemplateMutationResponse::Notification,
+            state:
+              Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Notification < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationTemplateMutationResponse::Notification,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # The ID of the created or updated template.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the created or updated template.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      # The template state after the operation. Always uppercase.
+      module State
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationTemplateMutationResponse::State)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
+          )
+        PUBLISHED =
+          T.let(
+            :PUBLISHED,
+            Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_payload.rbi

@@ -0,0 +1,183 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplatePayload < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplatePayload,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Brand reference, or null for no brand.
+      sig { returns(T.nilable(Courier::NotificationTemplatePayload::Brand)) }
+      attr_reader :brand
+
+      sig do
+        params(
+          brand: T.nilable(Courier::NotificationTemplatePayload::Brand::OrHash)
+        ).void
+      end
+      attr_writer :brand
+
+      # Elemental content definition.
+      sig { returns(Courier::ElementalContent) }
+      attr_reader :content
+
+      sig { params(content: Courier::ElementalContent::OrHash).void }
+      attr_writer :content
+
+      # Display name for the template.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Routing strategy reference, or null for none.
+      sig { returns(T.nilable(Courier::NotificationTemplatePayload::Routing)) }
+      attr_reader :routing
+
+      sig do
+        params(
+          routing:
+            T.nilable(Courier::NotificationTemplatePayload::Routing::OrHash)
+        ).void
+      end
+      attr_writer :routing
+
+      # Subscription topic reference, or null for none.
+      sig do
+        returns(T.nilable(Courier::NotificationTemplatePayload::Subscription))
+      end
+      attr_reader :subscription
+
+      sig do
+        params(
+          subscription:
+            T.nilable(
+              Courier::NotificationTemplatePayload::Subscription::OrHash
+            )
+        ).void
+      end
+      attr_writer :subscription
+
+      # Tags for categorization. Send empty array for none.
+      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.
+      sig do
+        params(
+          brand: T.nilable(Courier::NotificationTemplatePayload::Brand::OrHash),
+          content: Courier::ElementalContent::OrHash,
+          name: String,
+          routing:
+            T.nilable(Courier::NotificationTemplatePayload::Routing::OrHash),
+          subscription:
+            T.nilable(
+              Courier::NotificationTemplatePayload::Subscription::OrHash
+            ),
+          tags: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Brand reference, or null for no brand.
+        brand:,
+        # Elemental content definition.
+        content:,
+        # Display name for the template.
+        name:,
+        # Routing strategy reference, or null for none.
+        routing:,
+        # Subscription topic reference, or null for none.
+        subscription:,
+        # Tags for categorization. Send empty array for none.
+        tags:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand: T.nilable(Courier::NotificationTemplatePayload::Brand),
+            content: Courier::ElementalContent,
+            name: String,
+            routing: T.nilable(Courier::NotificationTemplatePayload::Routing),
+            subscription:
+              T.nilable(Courier::NotificationTemplatePayload::Subscription),
+            tags: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Brand < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationTemplatePayload::Brand,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Brand reference, or null for no brand.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(id:)
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class Routing < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationTemplatePayload::Routing,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :strategy_id
+
+        # Routing strategy reference, or null for none.
+        sig { params(strategy_id: String).returns(T.attached_class) }
+        def self.new(strategy_id:)
+        end
+
+        sig { override.returns({ strategy_id: String }) }
+        def to_hash
+        end
+      end
+
+      class Subscription < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationTemplatePayload::Subscription,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :topic_id
+
+        # Subscription topic reference, or null for none.
+        sig { params(topic_id: String).returns(T.attached_class) }
+        def self.new(topic_id:)
+        end
+
+        sig { override.returns({ topic_id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_publish_request.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplatePublishRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplatePublishRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Historical version to publish (e.g. "v001"). Omit to publish the current draft.
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      # Optional request body for publishing a notification template. Omit or send an
+      # empty object to publish the current draft.
+      sig { params(version: String).returns(T.attached_class) }
+      def self.new(
+        # Historical version to publish (e.g. "v001"). Omit to publish the current draft.
+        version: nil
+      )
+      end
+
+      sig { override.returns({ version: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_state.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Template state. Defaults to `DRAFT`.
+    module NotificationTemplateState
+      extend Courier::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Courier::NotificationTemplateState) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DRAFT = T.let(:DRAFT, Courier::NotificationTemplateState::TaggedSymbol)
+      PUBLISHED =
+        T.let(:PUBLISHED, Courier::NotificationTemplateState::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Courier::NotificationTemplateState::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_summary.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateSummary < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateSummary,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Epoch milliseconds when the template was created.
+      sig { returns(Integer) }
+      attr_accessor :created
+
+      # User ID of the creator.
+      sig { returns(String) }
+      attr_accessor :creator
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(Courier::NotificationTemplateSummary::State::TaggedSymbol) }
+      attr_accessor :state
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :tags
+
+      # Epoch milliseconds of last update.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :updated
+
+      sig { params(updated: Integer).void }
+      attr_writer :updated
+
+      # User ID of the last updater.
+      sig { returns(T.nilable(String)) }
+      attr_reader :updater
+
+      sig { params(updater: String).void }
+      attr_writer :updater
+
+      # V2 (CDS) template summary returned in list responses.
+      sig do
+        params(
+          id: String,
+          created: Integer,
+          creator: String,
+          name: String,
+          state: Courier::NotificationTemplateSummary::State::OrSymbol,
+          tags: T::Array[String],
+          updated: Integer,
+          updater: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Epoch milliseconds when the template was created.
+        created:,
+        # User ID of the creator.
+        creator:,
+        name:,
+        state:,
+        tags:,
+        # Epoch milliseconds of last update.
+        updated: nil,
+        # User ID of the last updater.
+        updater: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created: Integer,
+            creator: String,
+            name: String,
+            state: Courier::NotificationTemplateSummary::State::TaggedSymbol,
+            tags: T::Array[String],
+            updated: Integer,
+            updater: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module State
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationTemplateSummary::State)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            Courier::NotificationTemplateSummary::State::TaggedSymbol
+          )
+        PUBLISHED =
+          T.let(
+            :PUBLISHED,
+            Courier::NotificationTemplateSummary::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::NotificationTemplateSummary::State::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end