ark-email 0.5.1

data/lib/ark_email/models/email_retry_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#retry_
+    class EmailRetryResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::EmailRetryResponse::Data]
+      required :data, -> { ArkEmail::Models::EmailRetryResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::EmailRetryResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::EmailRetryResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(message:)
+        #   @param message [String]
+      end
+    end
+  end
+end

data/lib/ark_email/models/email_send_batch_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#send_batch
+    class EmailSendBatchParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute emails
+      #
+      #   @return [Array<ArkEmail::Models::EmailSendBatchParams::Email>]
+      required :emails, -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::EmailSendBatchParams::Email] }
+
+      # @!attribute from
+      #   Sender email for all messages
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(emails:, from:, idempotency_key: nil, request_options: {})
+      #   @param emails [Array<ArkEmail::Models::EmailSendBatchParams::Email>]
+      #
+      #   @param from [String] Sender email for all messages
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+
+      class Email < ArkEmail::Internal::Type::BaseModel
+        # @!attribute subject
+        #
+        #   @return [String]
+        required :subject, String
+
+        # @!attribute to
+        #
+        #   @return [Array<String>]
+        required :to, ArkEmail::Internal::Type::ArrayOf[String]
+
+        # @!attribute html
+        #
+        #   @return [String, nil]
+        optional :html, String
+
+        # @!attribute tag
+        #
+        #   @return [String, nil]
+        optional :tag, String
+
+        # @!attribute text
+        #
+        #   @return [String, nil]
+        optional :text, String
+
+        # @!method initialize(subject:, to:, html: nil, tag: nil, text: nil)
+        #   @param subject [String]
+        #   @param to [Array<String>]
+        #   @param html [String]
+        #   @param tag [String]
+        #   @param text [String]
+      end
+    end
+  end
+end

data/lib/ark_email/models/email_send_batch_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#send_batch
+    class EmailSendBatchResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::EmailSendBatchResponse::Data]
+      required :data, -> { ArkEmail::Models::EmailSendBatchResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::EmailSendBatchResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::EmailSendBatchResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute accepted
+        #   Successfully accepted emails
+        #
+        #   @return [Integer]
+        required :accepted, Integer
+
+        # @!attribute failed
+        #   Failed emails
+        #
+        #   @return [Integer]
+        required :failed, Integer
+
+        # @!attribute messages
+        #   Map of recipient email to message info
+        #
+        #   @return [Hash{Symbol=>ArkEmail::Models::EmailSendBatchResponse::Data::Message}]
+        required :messages,
+                 -> { ArkEmail::Internal::Type::HashOf[ArkEmail::Models::EmailSendBatchResponse::Data::Message] }
+
+        # @!attribute total
+        #   Total emails in the batch
+        #
+        #   @return [Integer]
+        required :total, Integer
+
+        # @!method initialize(accepted:, failed:, messages:, total:)
+        #   @param accepted [Integer] Successfully accepted emails
+        #
+        #   @param failed [Integer] Failed emails
+        #
+        #   @param messages [Hash{Symbol=>ArkEmail::Models::EmailSendBatchResponse::Data::Message}] Map of recipient email to message info
+        #
+        #   @param total [Integer] Total emails in the batch
+
+        class Message < ArkEmail::Internal::Type::BaseModel
+          # @!attribute id
+          #   Message ID
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute token
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!method initialize(id:, token:)
+          #   @param id [String] Message ID
+          #
+          #   @param token [String]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/email_send_params.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#send_
+    class EmailSendParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute from
+      #   Sender email address. Must be from a verified domain.
+      #
+      #   **Supported formats:**
+      #
+      #   - Email only: `hello@yourdomain.com`
+      #   - With display name: `Acme <hello@yourdomain.com>`
+      #   - With quoted name: `"Acme Support" <support@yourdomain.com>`
+      #
+      #   The domain portion must match a verified sending domain in your account.
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute subject
+      #   Email subject line
+      #
+      #   @return [String]
+      required :subject, String
+
+      # @!attribute to
+      #   Recipient email addresses (max 50)
+      #
+      #   @return [Array<String>]
+      required :to, ArkEmail::Internal::Type::ArrayOf[String]
+
+      # @!attribute attachments
+      #   File attachments
+      #
+      #   @return [Array<ArkEmail::Models::EmailSendParams::Attachment>, nil]
+      optional :attachments, -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::EmailSendParams::Attachment] }
+
+      # @!attribute bcc
+      #   BCC recipients
+      #
+      #   @return [Array<String>, nil]
+      optional :bcc, ArkEmail::Internal::Type::ArrayOf[String]
+
+      # @!attribute cc
+      #   CC recipients
+      #
+      #   @return [Array<String>, nil]
+      optional :cc, ArkEmail::Internal::Type::ArrayOf[String]
+
+      # @!attribute headers
+      #   Custom email headers
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :headers, ArkEmail::Internal::Type::HashOf[String]
+
+      # @!attribute html
+      #   HTML body content. Maximum 5MB (5,242,880 characters). Combined with
+      #   attachments, the total message must not exceed 14MB.
+      #
+      #   @return [String, nil]
+      optional :html, String
+
+      # @!attribute reply_to
+      #   Reply-to address
+      #
+      #   @return [String, nil]
+      optional :reply_to, String, api_name: :replyTo
+
+      # @!attribute tag
+      #   Tag for categorization and filtering
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!attribute text
+      #   Plain text body (auto-generated from HTML if not provided). Maximum 5MB
+      #   (5,242,880 characters).
+      #
+      #   @return [String, nil]
+      optional :text, String
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(from:, subject:, to:, attachments: nil, bcc: nil, cc: nil, headers: nil, html: nil, reply_to: nil, tag: nil, text: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ArkEmail::Models::EmailSendParams} for more details.
+      #
+      #   @param from [String] Sender email address. Must be from a verified domain.
+      #
+      #   @param subject [String] Email subject line
+      #
+      #   @param to [Array<String>] Recipient email addresses (max 50)
+      #
+      #   @param attachments [Array<ArkEmail::Models::EmailSendParams::Attachment>] File attachments
+      #
+      #   @param bcc [Array<String>] BCC recipients
+      #
+      #   @param cc [Array<String>] CC recipients
+      #
+      #   @param headers [Hash{Symbol=>String}] Custom email headers
+      #
+      #   @param html [String] HTML body content.
+      #
+      #   @param reply_to [String] Reply-to address
+      #
+      #   @param tag [String] Tag for categorization and filtering
+      #
+      #   @param text [String] Plain text body (auto-generated from HTML if not provided).
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+
+      class Attachment < ArkEmail::Internal::Type::BaseModel
+        # @!attribute content
+        #   Base64-encoded file content
+        #
+        #   @return [String]
+        required :content, String
+
+        # @!attribute content_type
+        #   MIME type
+        #
+        #   @return [String]
+        required :content_type, String, api_name: :contentType
+
+        # @!attribute filename
+        #   Attachment filename
+        #
+        #   @return [String]
+        required :filename, String
+
+        # @!method initialize(content:, content_type:, filename:)
+        #   @param content [String] Base64-encoded file content
+        #
+        #   @param content_type [String] MIME type
+        #
+        #   @param filename [String] Attachment filename
+      end
+    end
+  end
+end

data/lib/ark_email/models/email_send_raw_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#send_raw
+    class EmailSendRawParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute data
+      #   Base64-encoded RFC 2822 message
+      #
+      #   @return [String]
+      required :data, String
+
+      # @!attribute mail_from
+      #   Envelope sender address
+      #
+      #   @return [String]
+      required :mail_from, String, api_name: :mailFrom
+
+      # @!attribute rcpt_to
+      #   Envelope recipient addresses
+      #
+      #   @return [Array<String>]
+      required :rcpt_to, ArkEmail::Internal::Type::ArrayOf[String], api_name: :rcptTo
+
+      # @!method initialize(data:, mail_from:, rcpt_to:, request_options: {})
+      #   @param data [String] Base64-encoded RFC 2822 message
+      #
+      #   @param mail_from [String] Envelope sender address
+      #
+      #   @param rcpt_to [Array<String>] Envelope recipient addresses
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/email_send_raw_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#send_raw
+    class EmailSendRawResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::EmailSendRawResponse::Data]
+      required :data, -> { ArkEmail::Models::EmailSendRawResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::EmailSendRawResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::EmailSendRawResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique message ID (format: msg*{id}*{token})
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   Current delivery status
+        #
+        #   @return [Symbol, ArkEmail::Models::EmailSendRawResponse::Data::Status]
+        required :status, enum: -> { ArkEmail::Models::EmailSendRawResponse::Data::Status }
+
+        # @!attribute to
+        #   List of recipient addresses
+        #
+        #   @return [Array<String>]
+        required :to, ArkEmail::Internal::Type::ArrayOf[String]
+
+        # @!attribute message_id
+        #   SMTP Message-ID header value
+        #
+        #   @return [String, nil]
+        optional :message_id, String, api_name: :messageId
+
+        # @!method initialize(id:, status:, to:, message_id: nil)
+        #   @param id [String] Unique message ID (format: msg*{id}*{token})
+        #
+        #   @param status [Symbol, ArkEmail::Models::EmailSendRawResponse::Data::Status] Current delivery status
+        #
+        #   @param to [Array<String>] List of recipient addresses
+        #
+        #   @param message_id [String] SMTP Message-ID header value
+
+        # Current delivery status
+        #
+        # @see ArkEmail::Models::EmailSendRawResponse::Data#status
+        module Status
+          extend ArkEmail::Internal::Type::Enum
+
+          PENDING = :pending
+          SENT = :sent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/email_send_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Emails#send_
+    class EmailSendResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::EmailSendResponse::Data]
+      required :data, -> { ArkEmail::Models::EmailSendResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::EmailSendResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::EmailSendResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique message ID (format: msg*{id}*{token})
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   Current delivery status
+        #
+        #   @return [Symbol, ArkEmail::Models::EmailSendResponse::Data::Status]
+        required :status, enum: -> { ArkEmail::Models::EmailSendResponse::Data::Status }
+
+        # @!attribute to
+        #   List of recipient addresses
+        #
+        #   @return [Array<String>]
+        required :to, ArkEmail::Internal::Type::ArrayOf[String]
+
+        # @!attribute message_id
+        #   SMTP Message-ID header value
+        #
+        #   @return [String, nil]
+        optional :message_id, String, api_name: :messageId
+
+        # @!method initialize(id:, status:, to:, message_id: nil)
+        #   @param id [String] Unique message ID (format: msg*{id}*{token})
+        #
+        #   @param status [Symbol, ArkEmail::Models::EmailSendResponse::Data::Status] Current delivery status
+        #
+        #   @param to [Array<String>] List of recipient addresses
+        #
+        #   @param message_id [String] SMTP Message-ID header value
+
+        # Current delivery status
+        #
+        # @see ArkEmail::Models::EmailSendResponse::Data#status
+        module Status
+          extend ArkEmail::Internal::Type::Enum
+
+          PENDING = :pending
+          SENT = :sent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/suppression_bulk_create_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#bulk_create
+    class SuppressionBulkCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute suppressions
+      #
+      #   @return [Array<ArkEmail::Models::SuppressionBulkCreateParams::Suppression>]
+      required :suppressions,
+               -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::SuppressionBulkCreateParams::Suppression] }
+
+      # @!method initialize(suppressions:, request_options: {})
+      #   @param suppressions [Array<ArkEmail::Models::SuppressionBulkCreateParams::Suppression>]
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+
+      class Suppression < ArkEmail::Internal::Type::BaseModel
+        # @!attribute address
+        #
+        #   @return [String]
+        required :address, String
+
+        # @!attribute reason
+        #
+        #   @return [String, nil]
+        optional :reason, String
+
+        # @!method initialize(address:, reason: nil)
+        #   @param address [String]
+        #   @param reason [String]
+      end
+    end
+  end
+end

data/lib/ark_email/models/suppression_bulk_create_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#bulk_create
+    class SuppressionBulkCreateResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::SuppressionBulkCreateResponse::Data]
+      required :data, -> { ArkEmail::Models::SuppressionBulkCreateResponse::Data }
+
+      # @!attribute meta
+      #
+      #   @return [ArkEmail::Models::APIMeta]
+      required :meta, -> { ArkEmail::APIMeta }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(data:, meta:, success: true)
+      #   @param data [ArkEmail::Models::SuppressionBulkCreateResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::SuppressionBulkCreateResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute added
+        #   Newly suppressed addresses
+        #
+        #   @return [Integer]
+        required :added, Integer
+
+        # @!attribute failed
+        #   Invalid addresses skipped
+        #
+        #   @return [Integer]
+        required :failed, Integer
+
+        # @!attribute total_requested
+        #   Total addresses in request
+        #
+        #   @return [Integer]
+        required :total_requested, Integer, api_name: :totalRequested
+
+        # @!attribute updated
+        #   Already suppressed addresses (updated reason)
+        #
+        #   @return [Integer]
+        required :updated, Integer
+
+        # @!method initialize(added:, failed:, total_requested:, updated:)
+        #   @param added [Integer] Newly suppressed addresses
+        #
+        #   @param failed [Integer] Invalid addresses skipped
+        #
+        #   @param total_requested [Integer] Total addresses in request
+        #
+        #   @param updated [Integer] Already suppressed addresses (updated reason)
+      end
+    end
+  end
+end

data/lib/ark_email/models/suppression_create_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Suppressions#create
+    class SuppressionCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute address
+      #   Email address to suppress
+      #
+      #   @return [String]
+      required :address, String
+
+      # @!attribute reason
+      #   Reason for suppression
+      #
+      #   @return [String, nil]
+      optional :reason, String
+
+      # @!method initialize(address:, reason: nil, request_options: {})
+      #   @param address [String] Email address to suppress
+      #
+      #   @param reason [String] Reason for suppression
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end