trycourier 4.7.0 → 4.8.0

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_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/notification_retrieve_content_params.rbi

@@ -14,15 +14,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/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
             }

data/rbi/courier/models/request_archive_params.rbi

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

data/rbi/courier/models/tenant_delete_params.rbi

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