ark-email 0.5.1

data/lib/ark_email/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Internal
+    extend ArkEmail::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{ArkEmail::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, ArkEmail::FilePart) }
+    end
+  end
+end

data/lib/ark_email/models/api_meta.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    class APIMeta < ArkEmail::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique request identifier for debugging and support
+      #
+      #   @return [String]
+      required :request_id, String, api_name: :requestId
+
+      # @!method initialize(request_id:)
+      #   @param request_id [String] Unique request identifier for debugging and support
+    end
+  end
+end

data/lib/ark_email/models/dns_record.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    class DNSRecord < ArkEmail::Internal::Type::BaseModel
+      # @!attribute name
+      #   DNS record name (hostname)
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   DNS record type
+      #
+      #   @return [Symbol, ArkEmail::Models::DNSRecord::Type]
+      required :type, enum: -> { ArkEmail::DNSRecord::Type }
+
+      # @!attribute value
+      #   DNS record value
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!attribute status
+      #   DNS verification status:
+      #
+      #   - `OK` - Record is correctly configured
+      #   - `Missing` - Record not found in DNS
+      #   - `Invalid` - Record exists but has wrong value
+      #   - `null` - Not yet checked
+      #
+      #   @return [Symbol, ArkEmail::Models::DNSRecord::Status, nil]
+      optional :status, enum: -> { ArkEmail::DNSRecord::Status }, nil?: true
+
+      # @!method initialize(name:, type:, value:, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ArkEmail::Models::DNSRecord} for more details.
+      #
+      #   @param name [String] DNS record name (hostname)
+      #
+      #   @param type [Symbol, ArkEmail::Models::DNSRecord::Type] DNS record type
+      #
+      #   @param value [String] DNS record value
+      #
+      #   @param status [Symbol, ArkEmail::Models::DNSRecord::Status, nil] DNS verification status:
+
+      # DNS record type
+      #
+      # @see ArkEmail::Models::DNSRecord#type
+      module Type
+        extend ArkEmail::Internal::Type::Enum
+
+        TXT = :TXT
+        CNAME = :CNAME
+        MX = :MX
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # DNS verification status:
+      #
+      # - `OK` - Record is correctly configured
+      # - `Missing` - Record not found in DNS
+      # - `Invalid` - Record exists but has wrong value
+      # - `null` - Not yet checked
+      #
+      # @see ArkEmail::Models::DNSRecord#status
+      module Status
+        extend ArkEmail::Internal::Type::Enum
+
+        OK = :OK
+        MISSING = :Missing
+        INVALID = :Invalid
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/ark_email/models/domain_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#create
+    class DomainCreateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   Domain name (e.g., "mail.example.com")
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:, request_options: {})
+      #   @param name [String] Domain name (e.g., "mail.example.com")
+      #
+      #   @param request_options [ArkEmail::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/ark_email/models/domain_create_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#create
+    class DomainCreateResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::DomainCreateResponse::Data]
+      required :data, -> { ArkEmail::Models::DomainCreateResponse::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::DomainCreateResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::DomainCreateResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Domain ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute dns_records
+        #
+        #   @return [ArkEmail::Models::DomainCreateResponse::Data::DNSRecords]
+        required :dns_records,
+                 -> { ArkEmail::Models::DomainCreateResponse::Data::DNSRecords },
+                 api_name: :dnsRecords
+
+        # @!attribute name
+        #   Domain name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!attribute verified
+        #   Whether DNS is verified
+        #
+        #   @return [Boolean]
+        required :verified, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute verified_at
+        #   When the domain was verified (null if not verified)
+        #
+        #   @return [Time, nil]
+        optional :verified_at, Time, api_name: :verifiedAt, nil?: true
+
+        # @!method initialize(id:, created_at:, dns_records:, name:, uuid:, verified:, verified_at: nil)
+        #   @param id [String] Domain ID
+        #
+        #   @param created_at [Time]
+        #
+        #   @param dns_records [ArkEmail::Models::DomainCreateResponse::Data::DNSRecords]
+        #
+        #   @param name [String] Domain name
+        #
+        #   @param uuid [String]
+        #
+        #   @param verified [Boolean] Whether DNS is verified
+        #
+        #   @param verified_at [Time, nil] When the domain was verified (null if not verified)
+
+        # @see ArkEmail::Models::DomainCreateResponse::Data#dns_records
+        class DNSRecords < ArkEmail::Internal::Type::BaseModel
+          # @!attribute dkim
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :dkim, -> { ArkEmail::DNSRecord }
+
+          # @!attribute return_path
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :return_path, -> { ArkEmail::DNSRecord }, api_name: :returnPath
+
+          # @!attribute spf
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :spf, -> { ArkEmail::DNSRecord }
+
+          # @!method initialize(dkim:, return_path:, spf:)
+          #   @param dkim [ArkEmail::Models::DNSRecord]
+          #   @param return_path [ArkEmail::Models::DNSRecord]
+          #   @param spf [ArkEmail::Models::DNSRecord]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/domain_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#delete
+    class DomainDeleteParams < 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/domain_delete_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#delete
+    class DomainDeleteResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::DomainDeleteResponse::Data]
+      required :data, -> { ArkEmail::Models::DomainDeleteResponse::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::DomainDeleteResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::DomainDeleteResponse#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/domain_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#list
+    class DomainListParams < 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/domain_list_response.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#list
+    class DomainListResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::DomainListResponse::Data]
+      required :data, -> { ArkEmail::Models::DomainListResponse::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::DomainListResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::DomainListResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute domains
+        #
+        #   @return [Array<ArkEmail::Models::DomainListResponse::Data::Domain>]
+        required :domains,
+                 -> { ArkEmail::Internal::Type::ArrayOf[ArkEmail::Models::DomainListResponse::Data::Domain] }
+
+        # @!method initialize(domains:)
+        #   @param domains [Array<ArkEmail::Models::DomainListResponse::Data::Domain>]
+
+        class Domain < ArkEmail::Internal::Type::BaseModel
+          # @!attribute id
+          #   Domain ID
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute dns_ok
+          #
+          #   @return [Boolean]
+          required :dns_ok, ArkEmail::Internal::Type::Boolean, api_name: :dnsOk
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute verified
+          #
+          #   @return [Boolean]
+          required :verified, ArkEmail::Internal::Type::Boolean
+
+          # @!method initialize(id:, dns_ok:, name:, verified:)
+          #   @param id [String] Domain ID
+          #
+          #   @param dns_ok [Boolean]
+          #
+          #   @param name [String]
+          #
+          #   @param verified [Boolean]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/domain_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#retrieve
+    class DomainRetrieveParams < 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/domain_retrieve_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#retrieve
+    class DomainRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::DomainRetrieveResponse::Data]
+      required :data, -> { ArkEmail::Models::DomainRetrieveResponse::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::DomainRetrieveResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::DomainRetrieveResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Domain ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute dns_records
+        #
+        #   @return [ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords]
+        required :dns_records,
+                 -> { ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords },
+                 api_name: :dnsRecords
+
+        # @!attribute name
+        #   Domain name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!attribute verified
+        #   Whether DNS is verified
+        #
+        #   @return [Boolean]
+        required :verified, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute verified_at
+        #   When the domain was verified (null if not verified)
+        #
+        #   @return [Time, nil]
+        optional :verified_at, Time, api_name: :verifiedAt, nil?: true
+
+        # @!method initialize(id:, created_at:, dns_records:, name:, uuid:, verified:, verified_at: nil)
+        #   @param id [String] Domain ID
+        #
+        #   @param created_at [Time]
+        #
+        #   @param dns_records [ArkEmail::Models::DomainRetrieveResponse::Data::DNSRecords]
+        #
+        #   @param name [String] Domain name
+        #
+        #   @param uuid [String]
+        #
+        #   @param verified [Boolean] Whether DNS is verified
+        #
+        #   @param verified_at [Time, nil] When the domain was verified (null if not verified)
+
+        # @see ArkEmail::Models::DomainRetrieveResponse::Data#dns_records
+        class DNSRecords < ArkEmail::Internal::Type::BaseModel
+          # @!attribute dkim
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :dkim, -> { ArkEmail::DNSRecord }
+
+          # @!attribute return_path
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :return_path, -> { ArkEmail::DNSRecord }, api_name: :returnPath
+
+          # @!attribute spf
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :spf, -> { ArkEmail::DNSRecord }
+
+          # @!method initialize(dkim:, return_path:, spf:)
+          #   @param dkim [ArkEmail::Models::DNSRecord]
+          #   @param return_path [ArkEmail::Models::DNSRecord]
+          #   @param spf [ArkEmail::Models::DNSRecord]
+        end
+      end
+    end
+  end
+end

data/lib/ark_email/models/domain_verify_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#verify
+    class DomainVerifyParams < 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/domain_verify_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  module Models
+    # @see ArkEmail::Resources::Domains#verify
+    class DomainVerifyResponse < ArkEmail::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [ArkEmail::Models::DomainVerifyResponse::Data]
+      required :data, -> { ArkEmail::Models::DomainVerifyResponse::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::DomainVerifyResponse::Data]
+      #   @param meta [ArkEmail::Models::APIMeta]
+      #   @param success [Boolean, true]
+
+      # @see ArkEmail::Models::DomainVerifyResponse#data
+      class Data < ArkEmail::Internal::Type::BaseModel
+        # @!attribute id
+        #   Domain ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute dns_records
+        #
+        #   @return [ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords]
+        required :dns_records,
+                 -> { ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords },
+                 api_name: :dnsRecords
+
+        # @!attribute name
+        #   Domain name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!attribute verified
+        #   Whether DNS is verified
+        #
+        #   @return [Boolean]
+        required :verified, ArkEmail::Internal::Type::Boolean
+
+        # @!attribute verified_at
+        #   When the domain was verified (null if not verified)
+        #
+        #   @return [Time, nil]
+        optional :verified_at, Time, api_name: :verifiedAt, nil?: true
+
+        # @!method initialize(id:, created_at:, dns_records:, name:, uuid:, verified:, verified_at: nil)
+        #   @param id [String] Domain ID
+        #
+        #   @param created_at [Time]
+        #
+        #   @param dns_records [ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords]
+        #
+        #   @param name [String] Domain name
+        #
+        #   @param uuid [String]
+        #
+        #   @param verified [Boolean] Whether DNS is verified
+        #
+        #   @param verified_at [Time, nil] When the domain was verified (null if not verified)
+
+        # @see ArkEmail::Models::DomainVerifyResponse::Data#dns_records
+        class DNSRecords < ArkEmail::Internal::Type::BaseModel
+          # @!attribute dkim
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :dkim, -> { ArkEmail::DNSRecord }
+
+          # @!attribute return_path
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :return_path, -> { ArkEmail::DNSRecord }, api_name: :returnPath
+
+          # @!attribute spf
+          #
+          #   @return [ArkEmail::Models::DNSRecord]
+          required :spf, -> { ArkEmail::DNSRecord }
+
+          # @!method initialize(dkim:, return_path:, spf:)
+          #   @param dkim [ArkEmail::Models::DNSRecord]
+          #   @param return_path [ArkEmail::Models::DNSRecord]
+          #   @param spf [ArkEmail::Models::DNSRecord]
+        end
+      end
+    end
+  end
+end