trycourier 4.8.0 → 4.10.0

data/rbi/courier/models/notification_list_versions_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationListVersionsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationListVersionsParams,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Opaque pagination cursor from a previous response. Omit for the first page.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Maximum number of versions to return per page. Default 10, max 10.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of versions to return per page. Default 10, max 10.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_locale_put_request.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationLocalePutRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationLocalePutRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Elements with locale-specific content overrides.
+      sig { returns(T::Array[Courier::NotificationLocalePutRequest::Element]) }
+      attr_accessor :elements
+
+      # Template state. Defaults to `DRAFT`.
+      sig { returns(T.nilable(Courier::NotificationTemplateState::OrSymbol)) }
+      attr_reader :state
+
+      sig { params(state: Courier::NotificationTemplateState::OrSymbol).void }
+      attr_writer :state
+
+      # Request body for setting locale-specific content overrides. Each element
+      # override must include the target element ID.
+      sig do
+        params(
+          elements:
+            T::Array[Courier::NotificationLocalePutRequest::Element::OrHash],
+          state: Courier::NotificationTemplateState::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Elements with locale-specific content overrides.
+        elements:,
+        # Template state. Defaults to `DRAFT`.
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            elements: T::Array[Courier::NotificationLocalePutRequest::Element],
+            state: Courier::NotificationTemplateState::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Element < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationLocalePutRequest::Element,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # Target element ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # Target element ID.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_publish_params.rbi

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

data/rbi/courier/models/notification_put_content_params.rbi

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

data/rbi/courier/models/notification_put_element_params.rbi

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

data/rbi/courier/models/notification_put_locale_params.rbi

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

data/rbi/courier/models/notification_replace_params.rbi

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

data/rbi/courier/models/notification_retrieve_content_params.rbi

@@ -17,18 +17,37 @@ module Courier
       sig { returns(String) }
       attr_accessor :id
 
+      # Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+      # `published`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
       sig do
         params(
           id: String,
+          version: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        id:,
+        # Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+        # `published`.
+        version: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Courier::RequestOptions }
+          {
+            id: String,
+            version: String,
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/notification_retrieve_content_response.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Elemental content response for V2 templates. Contains versioned elements with
+    # content checksums.
+    module NotificationRetrieveContentResponse
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::NotificationContentGetResponse,
+            Courier::NotificationGetContent
+          )
+        end
+
+      sig do
+        override.returns(
+          T::Array[
+            Courier::Models::NotificationRetrieveContentResponse::Variants
+          ]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_retrieve_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::NotificationRetrieveParams, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Version to retrieve. One of "draft", "published", or a version string like
+      # "v001". Defaults to "published".
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      sig do
+        params(
+          id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Version to retrieve. One of "draft", "published", or a version string like
+        # "v001". Defaults to "published".
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            version: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_create_request.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateCreateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateCreateRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Full document shape used in POST and PUT request bodies, and returned inside the
+      # GET response envelope.
+      sig { returns(Courier::NotificationTemplatePayload) }
+      attr_reader :notification
+
+      sig do
+        params(notification: Courier::NotificationTemplatePayload::OrHash).void
+      end
+      attr_writer :notification
+
+      # Template state after creation. Case-insensitive input, normalized to uppercase
+      # in the response. Defaults to "DRAFT".
+      sig do
+        returns(
+          T.nilable(Courier::NotificationTemplateCreateRequest::State::OrSymbol)
+        )
+      end
+      attr_reader :state
+
+      sig do
+        params(
+          state: Courier::NotificationTemplateCreateRequest::State::OrSymbol
+        ).void
+      end
+      attr_writer :state
+
+      # Request body for creating a notification template.
+      sig do
+        params(
+          notification: Courier::NotificationTemplatePayload::OrHash,
+          state: Courier::NotificationTemplateCreateRequest::State::OrSymbol
+        ).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.
+        notification:,
+        # Template state after creation. Case-insensitive input, normalized to uppercase
+        # in the response. Defaults to "DRAFT".
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            notification: Courier::NotificationTemplatePayload,
+            state: Courier::NotificationTemplateCreateRequest::State::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Template state after creation. Case-insensitive input, normalized to uppercase
+      # in the response. Defaults to "DRAFT".
+      module State
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationTemplateCreateRequest::State)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            Courier::NotificationTemplateCreateRequest::State::TaggedSymbol
+          )
+        PUBLISHED =
+          T.let(
+            :PUBLISHED,
+            Courier::NotificationTemplateCreateRequest::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationTemplateCreateRequest::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end