ark-email 0.13.0 → 0.14.0

data/sig/ark_email/models/log_entry.rbs

@@ -0,0 +1,209 @@
+module ArkEmail
+  module Models
+    type log_entry =
+      {
+        context: ArkEmail::LogEntry::Context,
+        credential: ArkEmail::LogEntry::Credential,
+        duration_ms: Integer,
+        endpoint: String,
+        method_: ArkEmail::Models::LogEntry::method_,
+        path: String,
+        rate_limit: ArkEmail::LogEntry::RateLimit,
+        request_id: String,
+        status_code: Integer,
+        timestamp: Time,
+        email: ArkEmail::LogEntry::Email?,
+        error: ArkEmail::LogEntry::Error?,
+        sdk: ArkEmail::LogEntry::SDK?
+      }
+
+    class LogEntry < ArkEmail::Internal::Type::BaseModel
+      attr_accessor context: ArkEmail::LogEntry::Context
+
+      attr_accessor credential: ArkEmail::LogEntry::Credential
+
+      attr_accessor duration_ms: Integer
+
+      attr_accessor endpoint: String
+
+      attr_accessor method_: ArkEmail::Models::LogEntry::method_
+
+      attr_accessor path: String
+
+      attr_accessor rate_limit: ArkEmail::LogEntry::RateLimit
+
+      attr_accessor request_id: String
+
+      attr_accessor status_code: Integer
+
+      attr_accessor timestamp: Time
+
+      attr_accessor email: ArkEmail::LogEntry::Email?
+
+      attr_accessor error: ArkEmail::LogEntry::Error?
+
+      attr_accessor sdk: ArkEmail::LogEntry::SDK?
+
+      def initialize: (
+        context: ArkEmail::LogEntry::Context,
+        credential: ArkEmail::LogEntry::Credential,
+        duration_ms: Integer,
+        endpoint: String,
+        method_: ArkEmail::Models::LogEntry::method_,
+        path: String,
+        rate_limit: ArkEmail::LogEntry::RateLimit,
+        request_id: String,
+        status_code: Integer,
+        timestamp: Time,
+        ?email: ArkEmail::LogEntry::Email?,
+        ?error: ArkEmail::LogEntry::Error?,
+        ?sdk: ArkEmail::LogEntry::SDK?
+      ) -> void
+
+      def to_hash: -> {
+        context: ArkEmail::LogEntry::Context,
+        credential: ArkEmail::LogEntry::Credential,
+        duration_ms: Integer,
+        endpoint: String,
+        method_: ArkEmail::Models::LogEntry::method_,
+        path: String,
+        rate_limit: ArkEmail::LogEntry::RateLimit,
+        request_id: String,
+        status_code: Integer,
+        timestamp: Time,
+        email: ArkEmail::LogEntry::Email?,
+        error: ArkEmail::LogEntry::Error?,
+        sdk: ArkEmail::LogEntry::SDK?
+      }
+
+      type context =
+        {
+          idempotency_key: String?,
+          ip_address: String?,
+          query_params: ::Hash[Symbol, top]?,
+          user_agent: String?
+        }
+
+      class Context < ArkEmail::Internal::Type::BaseModel
+        attr_accessor idempotency_key: String?
+
+        attr_accessor ip_address: String?
+
+        attr_accessor query_params: ::Hash[Symbol, top]?
+
+        attr_accessor user_agent: String?
+
+        def initialize: (
+          ?idempotency_key: String?,
+          ?ip_address: String?,
+          ?query_params: ::Hash[Symbol, top]?,
+          ?user_agent: String?
+        ) -> void
+
+        def to_hash: -> {
+          idempotency_key: String?,
+          ip_address: String?,
+          query_params: ::Hash[Symbol, top]?,
+          user_agent: String?
+        }
+      end
+
+      type credential = { id: String, key_prefix: String? }
+
+      class Credential < ArkEmail::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor key_prefix: String?
+
+        def initialize: (id: String, ?key_prefix: String?) -> void
+
+        def to_hash: -> { id: String, key_prefix: String? }
+      end
+
+      type method_ = :GET | :POST | :PUT | :PATCH | :DELETE
+
+      module Method
+        extend ArkEmail::Internal::Type::Enum
+
+        GET: :GET
+        POST: :POST
+        PUT: :PUT
+        PATCH: :PATCH
+        DELETE: :DELETE
+
+        def self?.values: -> ::Array[ArkEmail::Models::LogEntry::method_]
+      end
+
+      type rate_limit =
+        { limit: Integer?, limited: bool, remaining: Integer?, reset: Integer? }
+
+      class RateLimit < ArkEmail::Internal::Type::BaseModel
+        attr_accessor limit: Integer?
+
+        attr_reader limited: bool?
+
+        def limited=: (bool) -> bool
+
+        attr_accessor remaining: Integer?
+
+        attr_accessor reset: Integer?
+
+        def initialize: (
+          ?limit: Integer?,
+          ?limited: bool,
+          ?remaining: Integer?,
+          ?reset: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          limit: Integer?,
+          limited: bool,
+          remaining: Integer?,
+          reset: Integer?
+        }
+      end
+
+      type email = { id: String, recipient_count: Integer? }
+
+      class Email < ArkEmail::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor recipient_count: Integer?
+
+        def initialize: (?id: String, ?recipient_count: Integer?) -> void
+
+        def to_hash: -> { id: String, recipient_count: Integer? }
+      end
+
+      type error = { code: String, message: String? }
+
+      class Error < ArkEmail::Internal::Type::BaseModel
+        attr_reader code: String?
+
+        def code=: (String) -> String
+
+        attr_accessor message: String?
+
+        def initialize: (?code: String, ?message: String?) -> void
+
+        def to_hash: -> { code: String, message: String? }
+      end
+
+      type sdk = { name: String, version: String? }
+
+      class SDK < ArkEmail::Internal::Type::BaseModel
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_accessor version: String?
+
+        def initialize: (?name: String, ?version: String?) -> void
+
+        def to_hash: -> { name: String, version: String? }
+      end
+    end
+  end
+end

data/sig/ark_email/models/log_entry_detail.rbs

@@ -0,0 +1,97 @@
+module ArkEmail
+  module Models
+    type log_entry_detail =
+      {
+        request: ArkEmail::LogEntryDetail::Request,
+        response: ArkEmail::LogEntryDetail::Response
+      }
+
+    class LogEntryDetail < ArkEmail::Models::LogEntry
+      def request: -> ArkEmail::LogEntryDetail::Request?
+
+      def request=: (
+        ArkEmail::LogEntryDetail::Request _
+      ) -> ArkEmail::LogEntryDetail::Request
+
+      def response: -> ArkEmail::LogEntryDetail::Response?
+
+      def response=: (
+        ArkEmail::LogEntryDetail::Response _
+      ) -> ArkEmail::LogEntryDetail::Response
+
+      def initialize: (
+        ?request: ArkEmail::LogEntryDetail::Request,
+        ?response: ArkEmail::LogEntryDetail::Response
+      ) -> void
+
+      def to_hash: -> {
+        request: ArkEmail::LogEntryDetail::Request,
+        response: ArkEmail::LogEntryDetail::Response
+      }
+
+      type request =
+        {
+          body: ArkEmail::Models::LogEntryDetail::Request::body?,
+          body_size: Integer?
+        }
+
+      class Request < ArkEmail::Internal::Type::BaseModel
+        attr_accessor body: ArkEmail::Models::LogEntryDetail::Request::body?
+
+        attr_accessor body_size: Integer?
+
+        def initialize: (
+          ?body: ArkEmail::Models::LogEntryDetail::Request::body?,
+          ?body_size: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          body: ArkEmail::Models::LogEntryDetail::Request::body?,
+          body_size: Integer?
+        }
+
+        type body = ::Hash[Symbol, top] | String
+
+        module Body
+          extend ArkEmail::Internal::Type::Union
+
+          def self?.variants: -> ::Array[ArkEmail::Models::LogEntryDetail::Request::body]
+
+          UnionMember0Map: ArkEmail::Internal::Type::Converter
+        end
+      end
+
+      type response =
+        {
+          body: ArkEmail::Models::LogEntryDetail::Response::body?,
+          body_size: Integer?
+        }
+
+      class Response < ArkEmail::Internal::Type::BaseModel
+        attr_accessor body: ArkEmail::Models::LogEntryDetail::Response::body?
+
+        attr_accessor body_size: Integer?
+
+        def initialize: (
+          ?body: ArkEmail::Models::LogEntryDetail::Response::body?,
+          ?body_size: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          body: ArkEmail::Models::LogEntryDetail::Response::body?,
+          body_size: Integer?
+        }
+
+        type body = ::Hash[Symbol, top] | String
+
+        module Body
+          extend ArkEmail::Internal::Type::Union
+
+          def self?.variants: -> ::Array[ArkEmail::Models::LogEntryDetail::Response::body]
+
+          UnionMember0Map: ArkEmail::Internal::Type::Converter
+        end
+      end
+    end
+  end
+end

data/sig/ark_email/models/log_list_params.rbs

@@ -0,0 +1,97 @@
+module ArkEmail
+  module Models
+    type log_list_params =
+      {
+        credential_id: String,
+        end_date: Time,
+        endpoint: String,
+        page: Integer,
+        per_page: Integer,
+        request_id: String,
+        start_date: Time,
+        status: ArkEmail::Models::LogListParams::status,
+        status_code: Integer
+      }
+      & ArkEmail::Internal::Type::request_parameters
+
+    class LogListParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      attr_reader credential_id: String?
+
+      def credential_id=: (String) -> String
+
+      attr_reader end_date: Time?
+
+      def end_date=: (Time) -> Time
+
+      attr_reader endpoint: String?
+
+      def endpoint=: (String) -> String
+
+      attr_reader page: Integer?
+
+      def page=: (Integer) -> Integer
+
+      attr_reader per_page: Integer?
+
+      def per_page=: (Integer) -> Integer
+
+      attr_reader request_id: String?
+
+      def request_id=: (String) -> String
+
+      attr_reader start_date: Time?
+
+      def start_date=: (Time) -> Time
+
+      attr_reader status: ArkEmail::Models::LogListParams::status?
+
+      def status=: (
+        ArkEmail::Models::LogListParams::status
+      ) -> ArkEmail::Models::LogListParams::status
+
+      attr_reader status_code: Integer?
+
+      def status_code=: (Integer) -> Integer
+
+      def initialize: (
+        ?credential_id: String,
+        ?end_date: Time,
+        ?endpoint: String,
+        ?page: Integer,
+        ?per_page: Integer,
+        ?request_id: String,
+        ?start_date: Time,
+        ?status: ArkEmail::Models::LogListParams::status,
+        ?status_code: Integer,
+        ?request_options: ArkEmail::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        credential_id: String,
+        end_date: Time,
+        endpoint: String,
+        page: Integer,
+        per_page: Integer,
+        request_id: String,
+        start_date: Time,
+        status: ArkEmail::Models::LogListParams::status,
+        status_code: Integer,
+        request_options: ArkEmail::RequestOptions
+      }
+
+      type status = :success | :error
+
+      module Status
+        extend ArkEmail::Internal::Type::Enum
+
+        SUCCESS: :success
+        ERROR: :error
+
+        def self?.values: -> ::Array[ArkEmail::Models::LogListParams::status]
+      end
+    end
+  end
+end

data/sig/ark_email/models/log_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module ArkEmail
+  module Models
+    type log_retrieve_params =
+      {  } & ArkEmail::Internal::Type::request_parameters
+
+    class LogRetrieveParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: ArkEmail::request_opts) -> void
+
+      def to_hash: -> { request_options: ArkEmail::RequestOptions }
+    end
+  end
+end

data/sig/ark_email/models/log_retrieve_response.rbs

@@ -0,0 +1,26 @@
+module ArkEmail
+  module Models
+    type log_retrieve_response =
+      { data: ArkEmail::LogEntryDetail, meta: ArkEmail::APIMeta, success: true }
+
+    class LogRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      attr_accessor data: ArkEmail::LogEntryDetail
+
+      attr_accessor meta: ArkEmail::APIMeta
+
+      attr_accessor success: true
+
+      def initialize: (
+        data: ArkEmail::LogEntryDetail,
+        meta: ArkEmail::APIMeta,
+        ?success: true
+      ) -> void
+
+      def to_hash: -> {
+        data: ArkEmail::LogEntryDetail,
+        meta: ArkEmail::APIMeta,
+        success: true
+      }
+    end
+  end
+end

data/sig/ark_email/models.rbs

@@ -27,6 +27,14 @@ module ArkEmail
 
   class EmailSendRawParams = ArkEmail::Models::EmailSendRawParams
 
+  class LogEntry = ArkEmail::Models::LogEntry
+
+  class LogEntryDetail = ArkEmail::Models::LogEntryDetail
+
+  class LogListParams = ArkEmail::Models::LogListParams
+
+  class LogRetrieveParams = ArkEmail::Models::LogRetrieveParams
+
   class SuppressionBulkCreateParams = ArkEmail::Models::SuppressionBulkCreateParams
 
   class SuppressionCreateParams = ArkEmail::Models::SuppressionCreateParams

data/sig/ark_email/resources/logs.rbs

@@ -0,0 +1,25 @@
+module ArkEmail
+  module Resources
+    class Logs
+      def retrieve: (
+        String request_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::LogRetrieveResponse
+
+      def list: (
+        ?credential_id: String,
+        ?end_date: Time,
+        ?endpoint: String,
+        ?page: Integer,
+        ?per_page: Integer,
+        ?request_id: String,
+        ?start_date: Time,
+        ?status: ArkEmail::Models::LogListParams::status,
+        ?status_code: Integer,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Internal::PageNumberPagination[ArkEmail::LogEntry]
+
+      def initialize: (client: ArkEmail::Client) -> void
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ark-email
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Ark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-23 00:00:00.000000000 Z
+date: 2026-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -96,6 +96,11 @@ files:
 - lib/ark_email/models/email_send_raw_params.rb
 - lib/ark_email/models/email_send_raw_response.rb
 - lib/ark_email/models/email_send_response.rb
+- lib/ark_email/models/log_entry.rb
+- lib/ark_email/models/log_entry_detail.rb
+- lib/ark_email/models/log_list_params.rb
+- lib/ark_email/models/log_retrieve_params.rb
+- lib/ark_email/models/log_retrieve_response.rb
 - lib/ark_email/models/suppression_bulk_create_params.rb
 - lib/ark_email/models/suppression_bulk_create_response.rb
 - lib/ark_email/models/suppression_create_params.rb
@@ -140,6 +145,7 @@ files:
 - lib/ark_email/request_options.rb
 - lib/ark_email/resources/domains.rb
 - lib/ark_email/resources/emails.rb
+- lib/ark_email/resources/logs.rb
 - lib/ark_email/resources/suppressions.rb
 - lib/ark_email/resources/tracking.rb
 - lib/ark_email/resources/webhooks.rb
@@ -191,6 +197,11 @@ files:
 - rbi/ark_email/models/email_send_raw_params.rbi
 - rbi/ark_email/models/email_send_raw_response.rbi
 - rbi/ark_email/models/email_send_response.rbi
+- rbi/ark_email/models/log_entry.rbi
+- rbi/ark_email/models/log_entry_detail.rbi
+- rbi/ark_email/models/log_list_params.rbi
+- rbi/ark_email/models/log_retrieve_params.rbi
+- rbi/ark_email/models/log_retrieve_response.rbi
 - rbi/ark_email/models/suppression_bulk_create_params.rbi
 - rbi/ark_email/models/suppression_bulk_create_response.rbi
 - rbi/ark_email/models/suppression_create_params.rbi
@@ -235,6 +246,7 @@ files:
 - rbi/ark_email/request_options.rbi
 - rbi/ark_email/resources/domains.rbi
 - rbi/ark_email/resources/emails.rbi
+- rbi/ark_email/resources/logs.rbi
 - rbi/ark_email/resources/suppressions.rbi
 - rbi/ark_email/resources/tracking.rbi
 - rbi/ark_email/resources/webhooks.rbi
@@ -285,6 +297,11 @@ files:
 - sig/ark_email/models/email_send_raw_params.rbs
 - sig/ark_email/models/email_send_raw_response.rbs
 - sig/ark_email/models/email_send_response.rbs
+- sig/ark_email/models/log_entry.rbs
+- sig/ark_email/models/log_entry_detail.rbs
+- sig/ark_email/models/log_list_params.rbs
+- sig/ark_email/models/log_retrieve_params.rbs
+- sig/ark_email/models/log_retrieve_response.rbs
 - sig/ark_email/models/suppression_bulk_create_params.rbs
 - sig/ark_email/models/suppression_bulk_create_response.rbs
 - sig/ark_email/models/suppression_create_params.rbs
@@ -329,6 +346,7 @@ files:
 - sig/ark_email/request_options.rbs
 - sig/ark_email/resources/domains.rbs
 - sig/ark_email/resources/emails.rbs
+- sig/ark_email/resources/logs.rbs
 - sig/ark_email/resources/suppressions.rbs
 - sig/ark_email/resources/tracking.rbs
 - sig/ark_email/resources/webhooks.rbs