ark-email 0.13.0 → 0.15.0

data/lib/ark_email/models/log_entry.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Logs#list
+    class LogEntry < ArkEmail::Internal::Type::BaseModel
+      # @!attribute context
+      #   Request context information
+      #
+      #   @return [ArkEmail::Models::LogEntry::Context]
+      required :context, -> { ArkEmail::LogEntry::Context }
+
+      # @!attribute credential
+      #   API credential information
+      #
+      #   @return [ArkEmail::Models::LogEntry::Credential]
+      required :credential, -> { ArkEmail::LogEntry::Credential }
+
+      # @!attribute duration_ms
+      #   Request duration in milliseconds
+      #
+      #   @return [Integer]
+      required :duration_ms, Integer, api_name: :durationMs
+
+      # @!attribute endpoint
+      #   Semantic endpoint name
+      #
+      #   @return [String]
+      required :endpoint, String
+
+      # @!attribute method_
+      #   HTTP method
+      #
+      #   @return [Symbol, ArkEmail::Models::LogEntry::Method]
+      required :method_, enum: -> { ArkEmail::LogEntry::Method }, api_name: :method
+
+      # @!attribute path
+      #   Request path
+      #
+      #   @return [String]
+      required :path, String
+
+      # @!attribute rate_limit
+      #   Rate limit state at time of request
+      #
+      #   @return [ArkEmail::Models::LogEntry::RateLimit]
+      required :rate_limit, -> { ArkEmail::LogEntry::RateLimit }, api_name: :rateLimit
+
+      # @!attribute request_id
+      #   Unique request identifier
+      #
+      #   @return [String]
+      required :request_id, String, api_name: :requestId
+
+      # @!attribute status_code
+      #   HTTP response status code
+      #
+      #   @return [Integer]
+      required :status_code, Integer, api_name: :statusCode
+
+      # @!attribute timestamp
+      #   When the request was made (ISO 8601)
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute email
+      #   Email-specific data (for email endpoints)
+      #
+      #   @return [ArkEmail::Models::LogEntry::Email, nil]
+      optional :email, -> { ArkEmail::LogEntry::Email }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if request succeeded)
+      #
+      #   @return [ArkEmail::Models::LogEntry::Error, nil]
+      optional :error, -> { ArkEmail::LogEntry::Error }, nil?: true
+
+      # @!attribute sdk
+      #   SDK information (null if not using an SDK)
+      #
+      #   @return [ArkEmail::Models::LogEntry::SDK, nil]
+      optional :sdk, -> { ArkEmail::LogEntry::SDK }, nil?: true
+
+      # @!method initialize(context:, credential:, duration_ms:, endpoint:, method_:, path:, rate_limit:, request_id:, status_code:, timestamp:, email: nil, error: nil, sdk: nil)
+      #   API request log entry (list view)
+      #
+      #   @param context [ArkEmail::Models::LogEntry::Context] Request context information
+      #
+      #   @param credential [ArkEmail::Models::LogEntry::Credential] API credential information
+      #
+      #   @param duration_ms [Integer] Request duration in milliseconds
+      #
+      #   @param endpoint [String] Semantic endpoint name
+      #
+      #   @param method_ [Symbol, ArkEmail::Models::LogEntry::Method] HTTP method
+      #
+      #   @param path [String] Request path
+      #
+      #   @param rate_limit [ArkEmail::Models::LogEntry::RateLimit] Rate limit state at time of request
+      #
+      #   @param request_id [String] Unique request identifier
+      #
+      #   @param status_code [Integer] HTTP response status code
+      #
+      #   @param timestamp [Time] When the request was made (ISO 8601)
+      #
+      #   @param email [ArkEmail::Models::LogEntry::Email, nil] Email-specific data (for email endpoints)
+      #
+      #   @param error [ArkEmail::Models::LogEntry::Error, nil] Error details (null if request succeeded)
+      #
+      #   @param sdk [ArkEmail::Models::LogEntry::SDK, nil] SDK information (null if not using an SDK)
+
+      # @see ArkEmail::Models::LogEntry#context
+      class Context < ArkEmail::Internal::Type::BaseModel
+        # @!attribute idempotency_key
+        #   Idempotency key if provided
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String, api_name: :idempotencyKey, nil?: true
+
+        # @!attribute ip_address
+        #   Client IP address
+        #
+        #   @return [String, nil]
+        optional :ip_address, String, api_name: :ipAddress, nil?: true
+
+        # @!attribute query_params
+        #   Query parameters
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :query_params,
+                 ArkEmail::Internal::Type::HashOf[ArkEmail::Internal::Type::Unknown],
+                 api_name: :queryParams,
+                 nil?: true
+
+        # @!attribute user_agent
+        #   User-Agent header
+        #
+        #   @return [String, nil]
+        optional :user_agent, String, api_name: :userAgent, nil?: true
+
+        # @!method initialize(idempotency_key: nil, ip_address: nil, query_params: nil, user_agent: nil)
+        #   Request context information
+        #
+        #   @param idempotency_key [String, nil] Idempotency key if provided
+        #
+        #   @param ip_address [String, nil] Client IP address
+        #
+        #   @param query_params [Hash{Symbol=>Object}, nil] Query parameters
+        #
+        #   @param user_agent [String, nil] User-Agent header
+      end
+
+      # @see ArkEmail::Models::LogEntry#credential
+      class Credential < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Credential ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute key_prefix
+        #   API key prefix (first 8 characters)
+        #
+        #   @return [String, nil]
+        optional :key_prefix, String, api_name: :keyPrefix, nil?: true
+
+        # @!method initialize(id:, key_prefix: nil)
+        #   API credential information
+        #
+        #   @param id [String] Credential ID
+        #
+        #   @param key_prefix [String, nil] API key prefix (first 8 characters)
+      end
+
+      # HTTP method
+      #
+      # @see ArkEmail::Models::LogEntry#method_
+      module Method
+        extend ArkEmail::Internal::Type::Enum
+
+        GET = :GET
+        POST = :POST
+        PUT = :PUT
+        PATCH = :PATCH
+        DELETE = :DELETE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ArkEmail::Models::LogEntry#rate_limit
+      class RateLimit < ArkEmail::Internal::Type::BaseModel
+        # @!attribute limit
+        #   Rate limit ceiling
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer, nil?: true
+
+        # @!attribute limited
+        #   Whether the request was rate limited
+        #
+        #   @return [Boolean, nil]
+        optional :limited, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute remaining
+        #   Remaining requests in window
+        #
+        #   @return [Integer, nil]
+        optional :remaining, Integer, nil?: true
+
+        # @!attribute reset
+        #   Unix timestamp when limit resets
+        #
+        #   @return [Integer, nil]
+        optional :reset, Integer, nil?: true
+
+        # @!method initialize(limit: nil, limited: nil, remaining: nil, reset: nil)
+        #   Rate limit state at time of request
+        #
+        #   @param limit [Integer, nil] Rate limit ceiling
+        #
+        #   @param limited [Boolean] Whether the request was rate limited
+        #
+        #   @param remaining [Integer, nil] Remaining requests in window
+        #
+        #   @param reset [Integer, nil] Unix timestamp when limit resets
+      end
+
+      # @see ArkEmail::Models::LogEntry#email
+      class Email < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Email message ID
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute recipient_count
+        #   Number of recipients
+        #
+        #   @return [Integer, nil]
+        optional :recipient_count, Integer, api_name: :recipientCount, nil?: true
+
+        # @!method initialize(id: nil, recipient_count: nil)
+        #   Email-specific data (for email endpoints)
+        #
+        #   @param id [String] Email message ID
+        #
+        #   @param recipient_count [Integer, nil] Number of recipients
+      end
+
+      # @see ArkEmail::Models::LogEntry#error
+      class Error < ArkEmail::Internal::Type::BaseModel
+        # @!attribute code
+        #   Error code
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute message
+        #   Error message
+        #
+        #   @return [String, nil]
+        optional :message, String, nil?: true
+
+        # @!method initialize(code: nil, message: nil)
+        #   Error details (null if request succeeded)
+        #
+        #   @param code [String] Error code
+        #
+        #   @param message [String, nil] Error message
+      end
+
+      # @see ArkEmail::Models::LogEntry#sdk
+      class SDK < ArkEmail::Internal::Type::BaseModel
+        # @!attribute name
+        #   SDK name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute version
+        #   SDK version
+        #
+        #   @return [String, nil]
+        optional :version, String, nil?: true
+
+        # @!method initialize(name: nil, version: nil)
+        #   SDK information (null if not using an SDK)
+        #
+        #   @param name [String] SDK name
+        #
+        #   @param version [String, nil] SDK version
+      end
+    end
+  end
+end

data/lib/ark_email/models/log_entry_detail.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    class LogEntryDetail < ArkEmail::Models::LogEntry
+      # @!attribute request
+      #   Request body information
+      #
+      #   @return [ArkEmail::Models::LogEntryDetail::Request, nil]
+      optional :request, -> { ArkEmail::LogEntryDetail::Request }
+
+      # @!attribute response
+      #   Response body information
+      #
+      #   @return [ArkEmail::Models::LogEntryDetail::Response, nil]
+      optional :response, -> { ArkEmail::LogEntryDetail::Response }
+
+      # @!method initialize(request: nil, response: nil)
+      #   Full API request log entry with bodies
+      #
+      #   @param request [ArkEmail::Models::LogEntryDetail::Request] Request body information
+      #
+      #   @param response [ArkEmail::Models::LogEntryDetail::Response] Response body information
+
+      class Request < ArkEmail::Internal::Type::BaseModel
+        # @!attribute body
+        #   Decrypted request body (JSON or string). Bodies over 25KB are truncated.
+        #
+        #   @return [Hash{Symbol=>Object}, String, nil]
+        optional :body, union: -> { ArkEmail::LogEntryDetail::Request::Body }, nil?: true
+
+        # @!attribute body_size
+        #   Original request body size in bytes
+        #
+        #   @return [Integer, nil]
+        optional :body_size, Integer, api_name: :bodySize, nil?: true
+
+        # @!method initialize(body: nil, body_size: nil)
+        #   Request body information
+        #
+        #   @param body [Hash{Symbol=>Object}, String, nil] Decrypted request body (JSON or string). Bodies over 25KB are truncated.
+        #
+        #   @param body_size [Integer, nil] Original request body size in bytes
+
+        # Decrypted request body (JSON or string). Bodies over 25KB are truncated.
+        #
+        # @see ArkEmail::Models::LogEntryDetail::Request#body
+        module Body
+          extend ArkEmail::Internal::Type::Union
+
+          variant -> { ArkEmail::Models::LogEntryDetail::Request::Body::UnionMember0Map }
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Hash{Symbol=>Object}, String)]
+
+          # @type [ArkEmail::Internal::Type::Converter]
+          UnionMember0Map = ArkEmail::Internal::Type::HashOf[ArkEmail::Internal::Type::Unknown]
+        end
+      end
+
+      class Response < ArkEmail::Internal::Type::BaseModel
+        # @!attribute body
+        #   Decrypted response body (JSON or string). Bodies over 25KB are truncated.
+        #
+        #   @return [Hash{Symbol=>Object}, String, nil]
+        optional :body, union: -> { ArkEmail::LogEntryDetail::Response::Body }, nil?: true
+
+        # @!attribute body_size
+        #   Response body size in bytes
+        #
+        #   @return [Integer, nil]
+        optional :body_size, Integer, api_name: :bodySize, nil?: true
+
+        # @!method initialize(body: nil, body_size: nil)
+        #   Response body information
+        #
+        #   @param body [Hash{Symbol=>Object}, String, nil] Decrypted response body (JSON or string). Bodies over 25KB are truncated.
+        #
+        #   @param body_size [Integer, nil] Response body size in bytes
+
+        # Decrypted response body (JSON or string). Bodies over 25KB are truncated.
+        #
+        # @see ArkEmail::Models::LogEntryDetail::Response#body
+        module Body
+          extend ArkEmail::Internal::Type::Union
+
+          variant -> { ArkEmail::Models::LogEntryDetail::Response::Body::UnionMember0Map }
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Hash{Symbol=>Object}, String)]
+
+          # @type [ArkEmail::Internal::Type::Converter]
+          UnionMember0Map = ArkEmail::Internal::Type::HashOf[ArkEmail::Internal::Type::Unknown]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/log_list_params.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Logs#list
+    class LogListParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute credential_id
+      #   Filter by API credential ID
+      #
+      #   @return [String, nil]
+      optional :credential_id, String
+
+      # @!attribute end_date
+      #   Filter logs before this date (ISO 8601 format)
+      #
+      #   @return [Time, nil]
+      optional :end_date, Time
+
+      # @!attribute endpoint
+      #   Filter by endpoint name
+      #
+      #   @return [String, nil]
+      optional :endpoint, String
+
+      # @!attribute page
+      #   Page number
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute per_page
+      #   Results per page (max 100)
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!attribute request_id
+      #   Filter by request ID (partial match)
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute start_date
+      #   Filter logs after this date (ISO 8601 format)
+      #
+      #   @return [Time, nil]
+      optional :start_date, Time
+
+      # @!attribute status
+      #   Filter by status category:
+      #
+      #   - `success` - Status codes < 400
+      #   - `error` - Status codes >= 400
+      #
+      #   @return [Symbol, ArkEmail::Models::LogListParams::Status, nil]
+      optional :status, enum: -> { ArkEmail::LogListParams::Status }
+
+      # @!attribute status_code
+      #   Filter by exact HTTP status code (100-599)
+      #
+      #   @return [Integer, nil]
+      optional :status_code, Integer
+
+      # @!method initialize(credential_id: nil, end_date: nil, endpoint: nil, page: nil, per_page: nil, request_id: nil, start_date: nil, status: nil, status_code: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ArkEmail::Models::LogListParams} for more details.
+      #
+      #   @param credential_id [String] Filter by API credential ID
+      #
+      #   @param end_date [Time] Filter logs before this date (ISO 8601 format)
+      #
+      #   @param endpoint [String] Filter by endpoint name
+      #
+      #   @param page [Integer] Page number
+      #
+      #   @param per_page [Integer] Results per page (max 100)
+      #
+      #   @param request_id [String] Filter by request ID (partial match)
+      #
+      #   @param start_date [Time] Filter logs after this date (ISO 8601 format)
+      #
+      #   @param status [Symbol, ArkEmail::Models::LogListParams::Status] Filter by status category:
+      #
+      #   @param status_code [Integer] Filter by exact HTTP status code (100-599)
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by status category:
+      #
+      # - `success` - Status codes < 400
+      # - `error` - Status codes >= 400
+      module Status
+        extend ArkEmail::Internal::Type::Enum
+
+        SUCCESS = :success
+        ERROR = :error
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/ark_email/models/log_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Logs#retrieve
+    class LogRetrieveParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/log_retrieve_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Logs#retrieve
+    class LogRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #   Full API request log entry with bodies
+      #
+      #   @return [ArkEmail::Models::LogEntryDetail]
+      required :data, -> { ArkEmail::LogEntryDetail }
+
+      # @!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)
+      #   Detailed API request log with request/response bodies
+      #
+      #   @param data [ArkEmail::Models::LogEntryDetail] Full API request log entry with bodies
+      #
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #
+      #   @param success [Boolean, true]
+    end
+  end
+end

data/lib/ark_email/models/track_domain.rb

@@ -16,7 +16,8 @@ module ArkEmail
       required :created_at, Time, api_name: :createdAt
 
       # @!attribute dns_ok
-      #   Whether DNS is correctly configured
+      #   Whether the tracking CNAME record is correctly configured. Must be true to use
+      #   tracking features.
       #
       #   @return [Boolean]
       required :dns_ok, ArkEmail::Internal::Type::Boolean, api_name: :dnsOk
@@ -94,11 +95,14 @@ module ArkEmail
       optional :updated_at, Time, api_name: :updatedAt, nil?: true
 
       # @!method initialize(id:, created_at:, dns_ok:, domain_id:, full_name:, name:, ssl_enabled:, track_clicks:, track_opens:, dns_checked_at: nil, dns_error: nil, dns_record: nil, dns_status: nil, excluded_click_domains: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ArkEmail::Models::TrackDomain} for more details.
+      #
       #   @param id [String] Track domain ID
       #
       #   @param created_at [Time] When the track domain was created
       #
-      #   @param dns_ok [Boolean] Whether DNS is correctly configured
+      #   @param dns_ok [Boolean] Whether the tracking CNAME record is correctly configured. Must be true to use t
       #
       #   @param domain_id [String] ID of the parent sending domain
       #

data/lib/ark_email/models/usage_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Usage#retrieve
+    class UsageRetrieveParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end