ark-email 0.13.0 → 0.15.0

data/rbi/ark_email/resources/logs.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module ArkEmail
+  module Resources
+    class Logs
+      # Retrieve detailed information about a specific API request log, including the
+      # full request and response bodies.
+      #
+      # **Body decryption:** Request and response bodies are stored encrypted and
+      # automatically decrypted when retrieved. Bodies larger than 25KB are truncated at
+      # storage time with a `... [truncated]` marker.
+      #
+      # **Use cases:**
+      #
+      # - Debug a specific failed request
+      # - Review the exact payload sent/received
+      # - Share request details with support
+      #
+      # **Related endpoints:**
+      #
+      # - `GET /logs` - List logs with filters
+      sig do
+        params(
+          request_id: String,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Models::LogRetrieveResponse)
+      end
+      def retrieve(
+        # The request ID (format `req_*`)
+        request_id,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of API request logs for debugging and monitoring.
+      # Results are ordered by timestamp, newest first.
+      #
+      # **Use cases:**
+      #
+      # - Debug integration issues by reviewing recent requests
+      # - Monitor error rates and response times
+      # - Audit API usage patterns
+      #
+      # **Filters:**
+      #
+      # - `status` - Filter by success or error category
+      # - `statusCode` - Filter by exact HTTP status code
+      # - `endpoint` - Filter by endpoint name (e.g., `emails.send`)
+      # - `credentialId` - Filter by API key
+      # - `startDate`/`endDate` - Filter by date range
+      #
+      # **Note:** Request and response bodies are only included when retrieving a single
+      # log entry with `GET /logs/{requestId}`.
+      #
+      # **Related endpoints:**
+      #
+      # - `GET /logs/{requestId}` - Get full log details with request/response bodies
+      sig do
+        params(
+          credential_id: String,
+          end_date: Time,
+          endpoint: String,
+          page: Integer,
+          per_page: Integer,
+          request_id: String,
+          start_date: Time,
+          status: ArkEmail::LogListParams::Status::OrSymbol,
+          status_code: Integer,
+          request_options: ArkEmail::RequestOptions::OrHash
+        ).returns(ArkEmail::Internal::PageNumberPagination[ArkEmail::LogEntry])
+      end
+      def list(
+        # Filter by API credential ID
+        credential_id: nil,
+        # Filter logs before this date (ISO 8601 format)
+        end_date: nil,
+        # Filter by endpoint name
+        endpoint: nil,
+        # Page number
+        page: nil,
+        # Results per page (max 100)
+        per_page: nil,
+        # Filter by request ID (partial match)
+        request_id: nil,
+        # Filter logs after this date (ISO 8601 format)
+        start_date: nil,
+        # Filter by status category:
+        #
+        # - `success` - Status codes < 400
+        # - `error` - Status codes >= 400
+        status: nil,
+        # Filter by exact HTTP status code (100-599)
+        status_code: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ArkEmail::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/ark_email/resources/usage.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module ArkEmail
+  module Resources
+    class Usage
+      # Returns current usage and limit information for your account.
+      #
+      # This endpoint is designed for:
+      #
+      # - **AI agents/MCP servers:** Check constraints before planning batch operations
+      # - **Monitoring dashboards:** Display current usage status
+      # - **Rate limit awareness:** Know remaining capacity before making requests
+      #
+      # **Response includes:**
+      #
+      # - `rateLimit` - API request rate limit (requests per second)
+      # - `sendLimit` - Email sending limit (emails per hour)
+      # - `billing` - Credit balance and auto-recharge configuration
+      #
+      # **Notes:**
+      #
+      # - This request counts against your rate limit
+      # - `sendLimit` may be null if Postal is temporarily unavailable
+      # - `billing` is null if billing is not configured
+      # - Send limit resets at the top of each hour
+      sig do
+        params(request_options: ArkEmail::RequestOptions::OrHash).returns(
+          ArkEmail::Models::UsageRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: ArkEmail::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/ark_email/client.rbs

@@ -20,6 +20,10 @@ module ArkEmail
 
     attr_reader tracking: ArkEmail::Resources::Tracking
 
+    attr_reader logs: ArkEmail::Resources::Logs
+
+    attr_reader usage: ArkEmail::Resources::Usage
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/ark_email/models/dns_record.rbs

@@ -2,6 +2,7 @@ module ArkEmail
   module Models
     type dns_record =
       {
+        full_name: String,
         name: String,
         type: ArkEmail::Models::DNSRecord::type_,
         value: String,
@@ -9,6 +10,8 @@ module ArkEmail
       }
 
     class DNSRecord < ArkEmail::Internal::Type::BaseModel
+      attr_accessor full_name: String
+
       attr_accessor name: String
 
       attr_accessor type: ArkEmail::Models::DNSRecord::type_
@@ -18,6 +21,7 @@ module ArkEmail
       attr_accessor status: ArkEmail::Models::DNSRecord::status?
 
       def initialize: (
+        full_name: String,
         name: String,
         type: ArkEmail::Models::DNSRecord::type_,
         value: String,
@@ -25,6 +29,7 @@ module ArkEmail
       ) -> void
 
       def to_hash: -> {
+        full_name: String,
         name: String,
         type: ArkEmail::Models::DNSRecord::type_,
         value: String,

data/sig/ark_email/models/domain_create_response.rbs

@@ -28,9 +28,9 @@ module ArkEmail
 
       type data =
         {
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -38,11 +38,11 @@ module ArkEmail
         }
 
       class Data < ArkEmail::Internal::Type::BaseModel
-        attr_accessor id: String
+        attr_accessor id: Integer
 
         attr_accessor created_at: Time
 
-        attr_accessor dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords
+        attr_accessor dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords?
 
         attr_accessor name: String
 
@@ -53,9 +53,9 @@ module ArkEmail
         attr_accessor verified_at: Time?
 
         def initialize: (
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -63,9 +63,9 @@ module ArkEmail
         ) -> void
 
         def to_hash: -> {
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainCreateResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -74,28 +74,35 @@ module ArkEmail
 
         type dns_records =
           {
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            dkim: ArkEmail::DNSRecord?,
+            return_path: ArkEmail::DNSRecord?,
+            spf: ArkEmail::DNSRecord?,
+            zone: String
           }
 
         class DNSRecords < ArkEmail::Internal::Type::BaseModel
-          attr_accessor dkim: ArkEmail::DNSRecord
+          attr_accessor dkim: ArkEmail::DNSRecord?
 
-          attr_accessor return_path: ArkEmail::DNSRecord
+          attr_accessor return_path: ArkEmail::DNSRecord?
 
-          attr_accessor spf: ArkEmail::DNSRecord
+          attr_accessor spf: ArkEmail::DNSRecord?
+
+          attr_reader zone: String?
+
+          def zone=: (String) -> String
 
           def initialize: (
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            ?dkim: ArkEmail::DNSRecord?,
+            ?return_path: ArkEmail::DNSRecord?,
+            ?spf: ArkEmail::DNSRecord?,
+            ?zone: String
           ) -> void
 
           def to_hash: -> {
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            dkim: ArkEmail::DNSRecord?,
+            return_path: ArkEmail::DNSRecord?,
+            spf: ArkEmail::DNSRecord?,
+            zone: String
           }
         end
       end

data/sig/ark_email/models/domain_list_response.rbs

@@ -40,30 +40,18 @@ module ArkEmail
           domains: ::Array[ArkEmail::Models::DomainListResponse::Data::Domain]
         }
 
-        type domain = { id: String, dns_ok: bool, name: String, verified: bool }
+        type domain = { id: Integer, name: String, verified: bool }
 
         class Domain < ArkEmail::Internal::Type::BaseModel
-          attr_accessor id: String
-
-          attr_accessor dns_ok: bool
+          attr_accessor id: Integer
 
           attr_accessor name: String
 
           attr_accessor verified: bool
 
-          def initialize: (
-            id: String,
-            dns_ok: bool,
-            name: String,
-            verified: bool
-          ) -> void
+          def initialize: (id: Integer, name: String, verified: bool) -> void
 
-          def to_hash: -> {
-            id: String,
-            dns_ok: bool,
-            name: String,
-            verified: bool
-          }
+          def to_hash: -> { id: Integer, name: String, verified: bool }
         end
       end
     end

data/sig/ark_email/models/domain_retrieve_response.rbs

@@ -28,9 +28,9 @@ module ArkEmail
 
       type data =
         {
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -38,11 +38,11 @@ module ArkEmail
         }
 
       class Data < ArkEmail::Internal::Type::BaseModel
-        attr_accessor id: String
+        attr_accessor id: Integer
 
         attr_accessor created_at: Time
 
-        attr_accessor dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords
+        attr_accessor dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords?
 
         attr_accessor name: String
 
@@ -53,9 +53,9 @@ module ArkEmail
         attr_accessor verified_at: Time?
 
         def initialize: (
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -63,9 +63,9 @@ module ArkEmail
         ) -> void
 
         def to_hash: -> {
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -74,28 +74,35 @@ module ArkEmail
 
         type dns_records =
           {
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            dkim: ArkEmail::DNSRecord?,
+            return_path: ArkEmail::DNSRecord?,
+            spf: ArkEmail::DNSRecord?,
+            zone: String
           }
 
         class DNSRecords < ArkEmail::Internal::Type::BaseModel
-          attr_accessor dkim: ArkEmail::DNSRecord
+          attr_accessor dkim: ArkEmail::DNSRecord?
 
-          attr_accessor return_path: ArkEmail::DNSRecord
+          attr_accessor return_path: ArkEmail::DNSRecord?
 
-          attr_accessor spf: ArkEmail::DNSRecord
+          attr_accessor spf: ArkEmail::DNSRecord?
+
+          attr_reader zone: String?
+
+          def zone=: (String) -> String
 
           def initialize: (
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            ?dkim: ArkEmail::DNSRecord?,
+            ?return_path: ArkEmail::DNSRecord?,
+            ?spf: ArkEmail::DNSRecord?,
+            ?zone: String
           ) -> void
 
           def to_hash: -> {
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            dkim: ArkEmail::DNSRecord?,
+            return_path: ArkEmail::DNSRecord?,
+            spf: ArkEmail::DNSRecord?,
+            zone: String
           }
         end
       end

data/sig/ark_email/models/domain_verify_response.rbs

@@ -28,9 +28,9 @@ module ArkEmail
 
       type data =
         {
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -38,11 +38,11 @@ module ArkEmail
         }
 
       class Data < ArkEmail::Internal::Type::BaseModel
-        attr_accessor id: String
+        attr_accessor id: Integer
 
         attr_accessor created_at: Time
 
-        attr_accessor dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords
+        attr_accessor dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords?
 
         attr_accessor name: String
 
@@ -53,9 +53,9 @@ module ArkEmail
         attr_accessor verified_at: Time?
 
         def initialize: (
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -63,9 +63,9 @@ module ArkEmail
         ) -> void
 
         def to_hash: -> {
-          id: String,
+          id: Integer,
           created_at: Time,
-          dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords,
+          dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords?,
           name: String,
           uuid: String,
           verified: bool,
@@ -74,28 +74,35 @@ module ArkEmail
 
         type dns_records =
           {
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            dkim: ArkEmail::DNSRecord?,
+            return_path: ArkEmail::DNSRecord?,
+            spf: ArkEmail::DNSRecord?,
+            zone: String
           }
 
         class DNSRecords < ArkEmail::Internal::Type::BaseModel
-          attr_accessor dkim: ArkEmail::DNSRecord
+          attr_accessor dkim: ArkEmail::DNSRecord?
 
-          attr_accessor return_path: ArkEmail::DNSRecord
+          attr_accessor return_path: ArkEmail::DNSRecord?
 
-          attr_accessor spf: ArkEmail::DNSRecord
+          attr_accessor spf: ArkEmail::DNSRecord?
+
+          attr_reader zone: String?
+
+          def zone=: (String) -> String
 
           def initialize: (
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            ?dkim: ArkEmail::DNSRecord?,
+            ?return_path: ArkEmail::DNSRecord?,
+            ?spf: ArkEmail::DNSRecord?,
+            ?zone: String
           ) -> void
 
           def to_hash: -> {
-            dkim: ArkEmail::DNSRecord,
-            return_path: ArkEmail::DNSRecord,
-            spf: ArkEmail::DNSRecord
+            dkim: ArkEmail::DNSRecord?,
+            return_path: ArkEmail::DNSRecord?,
+            spf: ArkEmail::DNSRecord?,
+            zone: String
           }
         end
       end