trycourier 4.7.1 → 4.9.0

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

data/rbi/courier/models/notification_template_update_request.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateUpdateRequest,
+            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 update. Case-insensitive input, normalized to uppercase in
+      # the response. Defaults to "DRAFT".
+      sig do
+        returns(
+          T.nilable(Courier::NotificationTemplateUpdateRequest::State::OrSymbol)
+        )
+      end
+      attr_reader :state
+
+      sig do
+        params(
+          state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
+        ).void
+      end
+      attr_writer :state
+
+      # Request body for replacing a notification template. Same shape as create. All
+      # fields required (PUT = full replacement).
+      sig do
+        params(
+          notification: Courier::NotificationTemplatePayload::OrHash,
+          state: Courier::NotificationTemplateUpdateRequest::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 update. Case-insensitive input, normalized to uppercase in
+        # the response. Defaults to "DRAFT".
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            notification: Courier::NotificationTemplatePayload,
+            state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Template state after update. 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::NotificationTemplateUpdateRequest::State)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            Courier::NotificationTemplateUpdateRequest::State::TaggedSymbol
+          )
+        PUBLISHED =
+          T.let(
+            :PUBLISHED,
+            Courier::NotificationTemplateUpdateRequest::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationTemplateUpdateRequest::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_version_list_response.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateVersionListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateVersionListResponse,
+            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::VersionNode]) }
+      attr_accessor :versions
+
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          versions: T::Array[Courier::VersionNode::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, versions:)
+      end
+
+      sig do
+        override.returns(
+          { paging: Courier::Paging, versions: T::Array[Courier::VersionNode] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notifications/check_delete_params.rbi

@@ -18,18 +18,26 @@ module Courier
         sig { returns(String) }
         attr_accessor :id
 
+        sig { returns(String) }
+        attr_accessor :submission_id
+
         sig do
           params(
             id: String,
+            submission_id: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(id:, request_options: {})
+        def self.new(id:, submission_id:, request_options: {})
         end
 
         sig do
           override.returns(
-            { id: String, request_options: Courier::RequestOptions }
+            {
+              id: String,
+              submission_id: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/notifications/check_list_params.rbi

@@ -18,18 +18,26 @@ module Courier
         sig { returns(String) }
         attr_accessor :id
 
+        sig { returns(String) }
+        attr_accessor :submission_id
+
         sig do
           params(
             id: String,
+            submission_id: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(id:, request_options: {})
+        def self.new(id:, submission_id:, request_options: {})
         end
 
         sig do
           override.returns(
-            { id: String, request_options: Courier::RequestOptions }
+            {
+              id: String,
+              submission_id: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/notifications/check_update_params.rbi

@@ -18,23 +18,28 @@ module Courier
         sig { returns(String) }
         attr_accessor :id
 
+        sig { returns(String) }
+        attr_accessor :submission_id
+
         sig { returns(T::Array[Courier::BaseCheck]) }
         attr_accessor :checks
 
         sig do
           params(
             id: String,
+            submission_id: String,
             checks: T::Array[Courier::BaseCheck::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(id:, checks:, request_options: {})
+        def self.new(id:, submission_id:, checks:, request_options: {})
         end
 
         sig do
           override.returns(
             {
               id: String,
+              submission_id: String,
               checks: T::Array[Courier::BaseCheck],
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/notifications/draft_retrieve_content_params.rbi

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

data/rbi/courier/models/profile_create_params.rbi

@@ -11,21 +11,26 @@ module Courier
           T.any(Courier::ProfileCreateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :user_id
+
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :profile
 
       sig do
         params(
+          user_id: String,
           profile: T::Hash[Symbol, T.anything],
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(profile:, request_options: {})
+      def self.new(user_id:, profile:, request_options: {})
       end
 
       sig do
         override.returns(
           {
+            user_id: String,
             profile: T::Hash[Symbol, T.anything],
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/profile_delete_params.rbi

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

data/rbi/courier/models/profile_replace_params.rbi

@@ -11,21 +11,26 @@ module Courier
           T.any(Courier::ProfileReplaceParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :user_id
+
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :profile
 
       sig do
         params(
+          user_id: String,
           profile: T::Hash[Symbol, T.anything],
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(profile:, request_options: {})
+      def self.new(user_id:, profile:, request_options: {})
       end
 
       sig do
         override.returns(
           {
+            user_id: String,
             profile: T::Hash[Symbol, T.anything],
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/profile_retrieve_params.rbi

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

data/rbi/courier/models/profile_update_params.rbi

@@ -11,17 +11,22 @@ module Courier
           T.any(Courier::ProfileUpdateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :user_id
+
       # List of patch operations to apply to the profile.
       sig { returns(T::Array[Courier::ProfileUpdateParams::Patch]) }
       attr_accessor :patch
 
       sig do
         params(
+          user_id: String,
           patch: T::Array[Courier::ProfileUpdateParams::Patch::OrHash],
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        user_id:,
         # List of patch operations to apply to the profile.
         patch:,
         request_options: {}
@@ -31,6 +36,7 @@ module Courier
       sig do
         override.returns(
           {
+            user_id: String,
             patch: T::Array[Courier::ProfileUpdateParams::Patch],
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/profiles/list_delete_params.rbi

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

data/rbi/courier/models/profiles/list_retrieve_params.rbi

@@ -15,17 +15,22 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         # A unique identifier that allows for fetching the next set of message statuses.
         sig { returns(T.nilable(String)) }
         attr_accessor :cursor
 
         sig do
           params(
+            user_id: String,
             cursor: T.nilable(String),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          user_id:,
           # A unique identifier that allows for fetching the next set of message statuses.
           cursor: nil,
           request_options: {}
@@ -35,6 +40,7 @@ module Courier
         sig do
           override.returns(
             {
+              user_id: String,
               cursor: T.nilable(String),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/profiles/list_subscribe_params.rbi

@@ -15,21 +15,26 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig { returns(T::Array[Courier::SubscribeToListsRequestItem]) }
         attr_accessor :lists
 
         sig do
           params(
+            user_id: String,
             lists: T::Array[Courier::SubscribeToListsRequestItem::OrHash],
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(lists:, request_options: {})
+        def self.new(user_id:, lists:, request_options: {})
         end
 
         sig do
           override.returns(
             {
+              user_id: String,
               lists: T::Array[Courier::SubscribeToListsRequestItem],
               request_options: Courier::RequestOptions
             }