trycourier 4.7.1 → 4.9.0

data/rbi/courier/models/list_restore_params.rbi

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

data/rbi/courier/models/list_retrieve_params.rbi

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

data/rbi/courier/models/list_update_params.rbi

@@ -11,6 +11,9 @@ module Courier
           T.any(Courier::ListUpdateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :list_id
+
       sig { returns(String) }
       attr_accessor :name
 
@@ -26,17 +29,19 @@ module Courier
 
       sig do
         params(
+          list_id: String,
           name: String,
           preferences: T.nilable(Courier::RecipientPreferences::OrHash),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(name:, preferences: nil, request_options: {})
+      def self.new(list_id:, name:, preferences: nil, request_options: {})
       end
 
       sig do
         override.returns(
           {
+            list_id: String,
             name: String,
             preferences: T.nilable(Courier::RecipientPreferences),
             request_options: Courier::RequestOptions

data/rbi/courier/models/lists/subscription_add_params.rbi

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

data/rbi/courier/models/lists/subscription_list_params.rbi

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

data/rbi/courier/models/lists/subscription_subscribe_params.rbi

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

data/rbi/courier/models/lists/subscription_subscribe_user_params.rbi

@@ -18,6 +18,9 @@ module Courier
         sig { returns(String) }
         attr_accessor :list_id
 
+        sig { returns(String) }
+        attr_accessor :user_id
+
         sig { returns(T.nilable(Courier::RecipientPreferences)) }
         attr_reader :preferences
 
@@ -31,17 +34,19 @@ module Courier
         sig do
           params(
             list_id: String,
+            user_id: String,
             preferences: T.nilable(Courier::RecipientPreferences::OrHash),
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(list_id:, preferences: nil, request_options: {})
+        def self.new(list_id:, user_id:, preferences: nil, request_options: {})
         end
 
         sig do
           override.returns(
             {
               list_id: String,
+              user_id: String,
               preferences: T.nilable(Courier::RecipientPreferences),
               request_options: Courier::RequestOptions
             }

data/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi

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

data/rbi/courier/models/message_cancel_params.rbi

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

data/rbi/courier/models/message_channels.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    MessageChannels =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::Channel],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/message_content_params.rbi

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

data/rbi/courier/models/message_details.rbi

@@ -13,16 +13,6 @@ module Courier
       sig { returns(String) }
       attr_accessor :id
 
-      # A UTC timestamp at which the recipient clicked on a tracked link for the first
-      # time. Stored as a millisecond representation of the Unix epoch.
-      sig { returns(Integer) }
-      attr_accessor :clicked
-
-      # A UTC timestamp at which the Integration provider delivered the message. Stored
-      # as a millisecond representation of the Unix epoch.
-      sig { returns(Integer) }
-      attr_accessor :delivered
-
       # A UTC timestamp at which Courier received the message request. Stored as a
       # millisecond representation of the Unix epoch.
       sig { returns(Integer) }
@@ -36,58 +26,74 @@ module Courier
       sig { returns(String) }
       attr_accessor :notification
 
-      # A UTC timestamp at which the recipient opened a message for the first time.
-      # Stored as a millisecond representation of the Unix epoch.
-      sig { returns(Integer) }
-      attr_accessor :opened
-
       # A unique identifier associated with the recipient of the delivered message.
       sig { returns(String) }
       attr_accessor :recipient
 
-      # A UTC timestamp at which Courier passed the message to the Integration provider.
-      # Stored as a millisecond representation of the Unix epoch.
-      sig { returns(Integer) }
-      attr_accessor :sent
-
       # The current status of the message.
       sig { returns(Courier::MessageDetails::Status::TaggedSymbol) }
       attr_accessor :status
 
+      # A UTC timestamp at which the recipient clicked on a tracked link for the first
+      # time. Stored as a millisecond representation of the Unix epoch.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :clicked
+
+      sig { params(clicked: Integer).void }
+      attr_writer :clicked
+
+      # A UTC timestamp at which the Integration provider delivered the message. Stored
+      # as a millisecond representation of the Unix epoch.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :delivered
+
+      sig { params(delivered: Integer).void }
+      attr_writer :delivered
+
       # A message describing the error that occurred.
       sig { returns(T.nilable(String)) }
       attr_accessor :error
 
+      # A UTC timestamp at which the recipient opened a message for the first time.
+      # Stored as a millisecond representation of the Unix epoch.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :opened
+
+      sig { params(opened: Integer).void }
+      attr_writer :opened
+
       # The reason for the current status of the message.
       sig { returns(T.nilable(Courier::MessageDetails::Reason::TaggedSymbol)) }
       attr_accessor :reason
 
+      # A UTC timestamp at which Courier passed the message to the Integration provider.
+      # Stored as a millisecond representation of the Unix epoch.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :sent
+
+      sig { params(sent: Integer).void }
+      attr_writer :sent
+
       sig do
         params(
           id: String,
-          clicked: Integer,
-          delivered: Integer,
           enqueued: Integer,
           event: String,
           notification: String,
-          opened: Integer,
           recipient: String,
-          sent: Integer,
           status: Courier::MessageDetails::Status::OrSymbol,
+          clicked: Integer,
+          delivered: Integer,
           error: T.nilable(String),
-          reason: T.nilable(Courier::MessageDetails::Reason::OrSymbol)
+          opened: Integer,
+          reason: T.nilable(Courier::MessageDetails::Reason::OrSymbol),
+          sent: Integer
         ).returns(T.attached_class)
       end
       def self.new(
         # A unique identifier associated with the message you wish to retrieve (results
         # from a send).
         id:,
-        # A UTC timestamp at which the recipient clicked on a tracked link for the first
-        # time. Stored as a millisecond representation of the Unix epoch.
-        clicked:,
-        # A UTC timestamp at which the Integration provider delivered the message. Stored
-        # as a millisecond representation of the Unix epoch.
-        delivered:,
         # A UTC timestamp at which Courier received the message request. Stored as a
         # millisecond representation of the Unix epoch.
         enqueued:,
@@ -95,20 +101,26 @@ module Courier
         event:,
         # A unique identifier associated with the notification of the delivered message.
         notification:,
-        # A UTC timestamp at which the recipient opened a message for the first time.
-        # Stored as a millisecond representation of the Unix epoch.
-        opened:,
         # A unique identifier associated with the recipient of the delivered message.
         recipient:,
-        # A UTC timestamp at which Courier passed the message to the Integration provider.
-        # Stored as a millisecond representation of the Unix epoch.
-        sent:,
         # The current status of the message.
         status:,
+        # A UTC timestamp at which the recipient clicked on a tracked link for the first
+        # time. Stored as a millisecond representation of the Unix epoch.
+        clicked: nil,
+        # A UTC timestamp at which the Integration provider delivered the message. Stored
+        # as a millisecond representation of the Unix epoch.
+        delivered: nil,
         # A message describing the error that occurred.
         error: nil,
+        # A UTC timestamp at which the recipient opened a message for the first time.
+        # Stored as a millisecond representation of the Unix epoch.
+        opened: nil,
         # The reason for the current status of the message.
-        reason: nil
+        reason: nil,
+        # A UTC timestamp at which Courier passed the message to the Integration provider.
+        # Stored as a millisecond representation of the Unix epoch.
+        sent: nil
       )
       end
 
@@ -116,17 +128,17 @@ module Courier
         override.returns(
           {
             id: String,
-            clicked: Integer,
-            delivered: Integer,
             enqueued: Integer,
             event: String,
             notification: String,
-            opened: Integer,
             recipient: String,
-            sent: Integer,
             status: Courier::MessageDetails::Status::TaggedSymbol,
+            clicked: Integer,
+            delivered: Integer,
             error: T.nilable(String),
-            reason: T.nilable(Courier::MessageDetails::Reason::TaggedSymbol)
+            opened: Integer,
+            reason: T.nilable(Courier::MessageDetails::Reason::TaggedSymbol),
+            sent: Integer
           }
         )
       end

data/rbi/courier/models/message_history_params.rbi

@@ -11,17 +11,22 @@ module Courier
           T.any(Courier::MessageHistoryParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :message_id
+
       # A supported Message History type that will filter the events returned.
       sig { returns(T.nilable(String)) }
       attr_accessor :type
 
       sig do
         params(
+          message_id: String,
           type: T.nilable(String),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        message_id:,
         # A supported Message History type that will filter the events returned.
         type: nil,
         request_options: {}
@@ -30,7 +35,11 @@ module Courier
 
       sig do
         override.returns(
-          { type: T.nilable(String), request_options: Courier::RequestOptions }
+          {
+            message_id: String,
+            type: T.nilable(String),
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/message_providers.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    MessageProviders =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::MessageProvidersType],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/message_providers_type.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Courier
+  module Models
+    class MessageProvidersType < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::MessageProvidersType, Courier::Internal::AnyHash)
+        end
+
+      # JS conditional with access to data/profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :if_
+
+      sig { returns(T.nilable(Courier::Metadata)) }
+      attr_reader :metadata
+
+      sig { params(metadata: T.nilable(Courier::Metadata::OrHash)).void }
+      attr_writer :metadata
+
+      # Provider-specific overrides.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :timeouts
+
+      sig do
+        params(
+          if_: T.nilable(String),
+          metadata: T.nilable(Courier::Metadata::OrHash),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          timeouts: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # JS conditional with access to data/profile.
+        if_: nil,
+        metadata: nil,
+        # Provider-specific overrides.
+        override: nil,
+        timeouts: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            if_: T.nilable(String),
+            metadata: T.nilable(Courier::Metadata),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            timeouts: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/message_retrieve_params.rbi

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

data/rbi/courier/models/metadata.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Metadata < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Metadata, Courier::Internal::AnyHash) }
+
+      sig { returns(T.nilable(Courier::Utm)) }
+      attr_reader :utm
+
+      sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
+      attr_writer :utm
+
+      sig do
+        params(utm: T.nilable(Courier::Utm::OrHash)).returns(T.attached_class)
+      end
+      def self.new(utm: nil)
+      end
+
+      sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_archive_params.rbi

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