ark-email 0.13.0 → 0.14.0

data/rbi/ark_email/models/email_retrieve_response.rbi

@@ -112,6 +112,44 @@ module ArkEmail
         sig { returns(String) }
         attr_accessor :to
 
+        # Opens and clicks tracking data (included if expand=activity)
+        sig do
+          returns(
+            T.nilable(ArkEmail::Models::EmailRetrieveResponse::Data::Activity)
+          )
+        end
+        attr_reader :activity
+
+        sig do
+          params(
+            activity:
+              ArkEmail::Models::EmailRetrieveResponse::Data::Activity::OrHash
+          ).void
+        end
+        attr_writer :activity
+
+        # File attachments (included if expand=attachments)
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ArkEmail::Models::EmailRetrieveResponse::Data::Attachment
+              ]
+            )
+          )
+        end
+        attr_reader :attachments
+
+        sig do
+          params(
+            attachments:
+              T::Array[
+                ArkEmail::Models::EmailRetrieveResponse::Data::Attachment::OrHash
+              ]
+          ).void
+        end
+        attr_writer :attachments
+
         # Delivery attempt history (included if expand=deliveries)
         sig do
           returns(
@@ -160,6 +198,14 @@ module ArkEmail
         sig { params(plain_body: String).void }
         attr_writer :plain_body
 
+        # Complete raw MIME message, base64 encoded (included if expand=raw). Decode this
+        # to get the original RFC 2822 formatted email.
+        sig { returns(T.nilable(String)) }
+        attr_reader :raw_message
+
+        sig { params(raw_message: String).void }
+        attr_writer :raw_message
+
         # Whether the message was flagged as spam
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :spam
@@ -194,6 +240,12 @@ module ArkEmail
             timestamp: Float,
             timestamp_iso: Time,
             to: String,
+            activity:
+              ArkEmail::Models::EmailRetrieveResponse::Data::Activity::OrHash,
+            attachments:
+              T::Array[
+                ArkEmail::Models::EmailRetrieveResponse::Data::Attachment::OrHash
+              ],
             deliveries:
               T::Array[
                 ArkEmail::Models::EmailRetrieveResponse::Data::Delivery::OrHash
@@ -202,6 +254,7 @@ module ArkEmail
             html_body: String,
             message_id: String,
             plain_body: String,
+            raw_message: String,
             spam: T::Boolean,
             spam_score: Float,
             tag: String
@@ -235,6 +288,10 @@ module ArkEmail
           timestamp_iso:,
           # Recipient address
           to:,
+          # Opens and clicks tracking data (included if expand=activity)
+          activity: nil,
+          # File attachments (included if expand=attachments)
+          attachments: nil,
           # Delivery attempt history (included if expand=deliveries)
           deliveries: nil,
           # Email headers (included if expand=headers)
@@ -245,6 +302,9 @@ module ArkEmail
           message_id: nil,
           # Plain text body (included if expand=content)
           plain_body: nil,
+          # Complete raw MIME message, base64 encoded (included if expand=raw). Decode this
+          # to get the original RFC 2822 formatted email.
+          raw_message: nil,
           # Whether the message was flagged as spam
           spam: nil,
           # Spam score (if applicable)
@@ -268,6 +328,11 @@ module ArkEmail
               timestamp: Float,
               timestamp_iso: Time,
               to: String,
+              activity: ArkEmail::Models::EmailRetrieveResponse::Data::Activity,
+              attachments:
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Attachment
+                ],
               deliveries:
                 T::Array[
                   ArkEmail::Models::EmailRetrieveResponse::Data::Delivery
@@ -276,6 +341,7 @@ module ArkEmail
               html_body: String,
               message_id: String,
               plain_body: String,
+              raw_message: String,
               spam: T::Boolean,
               spam_score: Float,
               tag: String
@@ -382,6 +448,319 @@ module ArkEmail
           end
         end
 
+        class Activity < ArkEmail::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ArkEmail::Models::EmailRetrieveResponse::Data::Activity,
+                ArkEmail::Internal::AnyHash
+              )
+            end
+
+          # List of link click events
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click
+                ]
+              )
+            )
+          end
+          attr_reader :clicks
+
+          sig do
+            params(
+              clicks:
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click::OrHash
+                ]
+            ).void
+          end
+          attr_writer :clicks
+
+          # List of email open events
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open
+                ]
+              )
+            )
+          end
+          attr_reader :opens
+
+          sig do
+            params(
+              opens:
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open::OrHash
+                ]
+            ).void
+          end
+          attr_writer :opens
+
+          # Opens and clicks tracking data (included if expand=activity)
+          sig do
+            params(
+              clicks:
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click::OrHash
+                ],
+              opens:
+                T::Array[
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # List of link click events
+            clicks: nil,
+            # List of email open events
+            opens: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                clicks:
+                  T::Array[
+                    ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click
+                  ],
+                opens:
+                  T::Array[
+                    ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Click < ArkEmail::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click,
+                  ArkEmail::Internal::AnyHash
+                )
+              end
+
+            # IP address of the clicker
+            sig { returns(T.nilable(String)) }
+            attr_reader :ip_address
+
+            sig { params(ip_address: String).void }
+            attr_writer :ip_address
+
+            # Unix timestamp of the click event
+            sig { returns(T.nilable(Float)) }
+            attr_reader :timestamp
+
+            sig { params(timestamp: Float).void }
+            attr_writer :timestamp
+
+            # ISO 8601 timestamp of the click event
+            sig { returns(T.nilable(Time)) }
+            attr_reader :timestamp_iso
+
+            sig { params(timestamp_iso: Time).void }
+            attr_writer :timestamp_iso
+
+            # URL that was clicked
+            sig { returns(T.nilable(String)) }
+            attr_reader :url
+
+            sig { params(url: String).void }
+            attr_writer :url
+
+            # User agent of the email client
+            sig { returns(T.nilable(String)) }
+            attr_reader :user_agent
+
+            sig { params(user_agent: String).void }
+            attr_writer :user_agent
+
+            sig do
+              params(
+                ip_address: String,
+                timestamp: Float,
+                timestamp_iso: Time,
+                url: String,
+                user_agent: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # IP address of the clicker
+              ip_address: nil,
+              # Unix timestamp of the click event
+              timestamp: nil,
+              # ISO 8601 timestamp of the click event
+              timestamp_iso: nil,
+              # URL that was clicked
+              url: nil,
+              # User agent of the email client
+              user_agent: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  ip_address: String,
+                  timestamp: Float,
+                  timestamp_iso: Time,
+                  url: String,
+                  user_agent: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class Open < ArkEmail::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open,
+                  ArkEmail::Internal::AnyHash
+                )
+              end
+
+            # IP address of the opener
+            sig { returns(T.nilable(String)) }
+            attr_reader :ip_address
+
+            sig { params(ip_address: String).void }
+            attr_writer :ip_address
+
+            # Unix timestamp of the open event
+            sig { returns(T.nilable(Float)) }
+            attr_reader :timestamp
+
+            sig { params(timestamp: Float).void }
+            attr_writer :timestamp
+
+            # ISO 8601 timestamp of the open event
+            sig { returns(T.nilable(Time)) }
+            attr_reader :timestamp_iso
+
+            sig { params(timestamp_iso: Time).void }
+            attr_writer :timestamp_iso
+
+            # User agent of the email client
+            sig { returns(T.nilable(String)) }
+            attr_reader :user_agent
+
+            sig { params(user_agent: String).void }
+            attr_writer :user_agent
+
+            sig do
+              params(
+                ip_address: String,
+                timestamp: Float,
+                timestamp_iso: Time,
+                user_agent: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # IP address of the opener
+              ip_address: nil,
+              # Unix timestamp of the open event
+              timestamp: nil,
+              # ISO 8601 timestamp of the open event
+              timestamp_iso: nil,
+              # User agent of the email client
+              user_agent: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  ip_address: String,
+                  timestamp: Float,
+                  timestamp_iso: Time,
+                  user_agent: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
+        class Attachment < ArkEmail::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ArkEmail::Models::EmailRetrieveResponse::Data::Attachment,
+                ArkEmail::Internal::AnyHash
+              )
+            end
+
+          # MIME type of the attachment
+          sig { returns(String) }
+          attr_accessor :content_type
+
+          # Base64 encoded attachment content. Decode this to get the raw file bytes.
+          sig { returns(String) }
+          attr_accessor :data
+
+          # Original filename of the attachment
+          sig { returns(String) }
+          attr_accessor :filename
+
+          # SHA256 hash of the attachment content for verification
+          sig { returns(String) }
+          attr_accessor :hash_
+
+          # Size of the attachment in bytes
+          sig { returns(Integer) }
+          attr_accessor :size
+
+          # An email attachment retrieved from a sent message
+          sig do
+            params(
+              content_type: String,
+              data: String,
+              filename: String,
+              hash_: String,
+              size: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # MIME type of the attachment
+            content_type:,
+            # Base64 encoded attachment content. Decode this to get the raw file bytes.
+            data:,
+            # Original filename of the attachment
+            filename:,
+            # SHA256 hash of the attachment content for verification
+            hash_:,
+            # Size of the attachment in bytes
+            size:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                content_type: String,
+                data: String,
+                filename: String,
+                hash_: String,
+                size: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
         class Delivery < ArkEmail::Internal::Type::BaseModel
           OrHash =
             T.type_alias do