ark-email 0.14.0 → 0.15.0

data/sig/ark_email/client.rbs

@@ -22,6 +22,8 @@ module ArkEmail
 
     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

data/sig/ark_email/models/usage_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module ArkEmail
+  module Models
+    type usage_retrieve_params =
+      {  } & ArkEmail::Internal::Type::request_parameters
+
+    class UsageRetrieveParams < 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/usage_retrieve_response.rbs

@@ -0,0 +1,212 @@
+module ArkEmail
+  module Models
+    type usage_retrieve_response =
+      {
+        data: ArkEmail::Models::UsageRetrieveResponse::Data,
+        meta: ArkEmail::APIMeta,
+        success: true
+      }
+
+    class UsageRetrieveResponse < ArkEmail::Internal::Type::BaseModel
+      attr_accessor data: ArkEmail::Models::UsageRetrieveResponse::Data
+
+      attr_accessor meta: ArkEmail::APIMeta
+
+      attr_accessor success: true
+
+      def initialize: (
+        data: ArkEmail::Models::UsageRetrieveResponse::Data,
+        meta: ArkEmail::APIMeta,
+        ?success: true
+      ) -> void
+
+      def to_hash: -> {
+        data: ArkEmail::Models::UsageRetrieveResponse::Data,
+        meta: ArkEmail::APIMeta,
+        success: true
+      }
+
+      type data =
+        {
+          billing: ArkEmail::Models::UsageRetrieveResponse::Data::Billing?,
+          rate_limit: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit,
+          send_limit: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit?
+        }
+
+      class Data < ArkEmail::Internal::Type::BaseModel
+        attr_accessor billing: ArkEmail::Models::UsageRetrieveResponse::Data::Billing?
+
+        attr_accessor rate_limit: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit
+
+        attr_accessor send_limit: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit?
+
+        def initialize: (
+          billing: ArkEmail::Models::UsageRetrieveResponse::Data::Billing?,
+          rate_limit: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit,
+          send_limit: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit?
+        ) -> void
+
+        def to_hash: -> {
+          billing: ArkEmail::Models::UsageRetrieveResponse::Data::Billing?,
+          rate_limit: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit,
+          send_limit: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit?
+        }
+
+        type billing =
+          {
+            auto_recharge: ArkEmail::Models::UsageRetrieveResponse::Data::Billing::AutoRecharge,
+            credit_balance: String,
+            credit_balance_cents: Integer,
+            has_payment_method: bool
+          }
+
+        class Billing < ArkEmail::Internal::Type::BaseModel
+          attr_accessor auto_recharge: ArkEmail::Models::UsageRetrieveResponse::Data::Billing::AutoRecharge
+
+          attr_accessor credit_balance: String
+
+          attr_accessor credit_balance_cents: Integer
+
+          attr_accessor has_payment_method: bool
+
+          def initialize: (
+            auto_recharge: ArkEmail::Models::UsageRetrieveResponse::Data::Billing::AutoRecharge,
+            credit_balance: String,
+            credit_balance_cents: Integer,
+            has_payment_method: bool
+          ) -> void
+
+          def to_hash: -> {
+            auto_recharge: ArkEmail::Models::UsageRetrieveResponse::Data::Billing::AutoRecharge,
+            credit_balance: String,
+            credit_balance_cents: Integer,
+            has_payment_method: bool
+          }
+
+          type auto_recharge =
+            { amount: String, enabled: bool, threshold: String }
+
+          class AutoRecharge < ArkEmail::Internal::Type::BaseModel
+            attr_accessor amount: String
+
+            attr_accessor enabled: bool
+
+            attr_accessor threshold: String
+
+            def initialize: (
+              amount: String,
+              enabled: bool,
+              threshold: String
+            ) -> void
+
+            def to_hash: -> { amount: String, enabled: bool, threshold: String }
+          end
+        end
+
+        type rate_limit =
+          {
+            limit: Integer,
+            period: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit::period,
+            remaining: Integer,
+            reset: Integer
+          }
+
+        class RateLimit < ArkEmail::Internal::Type::BaseModel
+          attr_accessor limit: Integer
+
+          attr_accessor period: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit::period
+
+          attr_accessor remaining: Integer
+
+          attr_accessor reset: Integer
+
+          def initialize: (
+            limit: Integer,
+            period: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit::period,
+            remaining: Integer,
+            reset: Integer
+          ) -> void
+
+          def to_hash: -> {
+            limit: Integer,
+            period: ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit::period,
+            remaining: Integer,
+            reset: Integer
+          }
+
+          type period = :second
+
+          module Period
+            extend ArkEmail::Internal::Type::Enum
+
+            SECOND: :second
+
+            def self?.values: -> ::Array[ArkEmail::Models::UsageRetrieveResponse::Data::RateLimit::period]
+          end
+        end
+
+        type send_limit =
+          {
+            approaching: bool,
+            exceeded: bool,
+            limit: Integer?,
+            period: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit::period,
+            remaining: Integer?,
+            resets_at: Time,
+            usage_percent: Float?,
+            used: Integer
+          }
+
+        class SendLimit < ArkEmail::Internal::Type::BaseModel
+          attr_accessor approaching: bool
+
+          attr_accessor exceeded: bool
+
+          attr_accessor limit: Integer?
+
+          attr_accessor period: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit::period
+
+          attr_accessor remaining: Integer?
+
+          attr_accessor resets_at: Time
+
+          attr_accessor usage_percent: Float?
+
+          attr_accessor used: Integer
+
+          def initialize: (
+            approaching: bool,
+            exceeded: bool,
+            limit: Integer?,
+            period: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit::period,
+            remaining: Integer?,
+            resets_at: Time,
+            usage_percent: Float?,
+            used: Integer
+          ) -> void
+
+          def to_hash: -> {
+            approaching: bool,
+            exceeded: bool,
+            limit: Integer?,
+            period: ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit::period,
+            remaining: Integer?,
+            resets_at: Time,
+            usage_percent: Float?,
+            used: Integer
+          }
+
+          type period = :hour
+
+          module Period
+            extend ArkEmail::Internal::Type::Enum
+
+            HOUR: :hour
+
+            def self?.values: -> ::Array[ArkEmail::Models::UsageRetrieveResponse::Data::SendLimit::period]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/ark_email/models/webhook_create_params.rbs

@@ -51,8 +51,6 @@ module ArkEmail
         | :MessageLinkClicked
         | :MessageLoaded
         | :DomainDNSError
-        | :SendLimitApproaching
-        | :SendLimitExceeded
 
       module Event
         extend ArkEmail::Internal::Type::Enum
@@ -65,8 +63,6 @@ module ArkEmail
         MESSAGE_LINK_CLICKED: :MessageLinkClicked
         MESSAGE_LOADED: :MessageLoaded
         DOMAIN_DNS_ERROR: :DomainDNSError
-        SEND_LIMIT_APPROACHING: :SendLimitApproaching
-        SEND_LIMIT_EXCEEDED: :SendLimitExceeded
 
         def self?.values: -> ::Array[ArkEmail::Models::WebhookCreateParams::event]
       end

data/sig/ark_email/models/webhook_create_response.rbs

@@ -86,8 +86,6 @@ module ArkEmail
           | :MessageLinkClicked
           | :MessageLoaded
           | :DomainDNSError
-          | :SendLimitApproaching
-          | :SendLimitExceeded
 
         module Event
           extend ArkEmail::Internal::Type::Enum
@@ -100,8 +98,6 @@ module ArkEmail
           MESSAGE_LINK_CLICKED: :MessageLinkClicked
           MESSAGE_LOADED: :MessageLoaded
           DOMAIN_DNS_ERROR: :DomainDNSError
-          SEND_LIMIT_APPROACHING: :SendLimitApproaching
-          SEND_LIMIT_EXCEEDED: :SendLimitExceeded
 
           def self?.values: -> ::Array[ArkEmail::Models::WebhookCreateResponse::Data::event]
         end

data/sig/ark_email/models/webhook_list_deliveries_params.rbs

@@ -70,8 +70,6 @@ module ArkEmail
         | :MessageLinkClicked
         | :MessageLoaded
         | :DomainDNSError
-        | :SendLimitApproaching
-        | :SendLimitExceeded
 
       module Event
         extend ArkEmail::Internal::Type::Enum
@@ -84,8 +82,6 @@ module ArkEmail
         MESSAGE_LINK_CLICKED: :MessageLinkClicked
         MESSAGE_LOADED: :MessageLoaded
         DOMAIN_DNS_ERROR: :DomainDNSError
-        SEND_LIMIT_APPROACHING: :SendLimitApproaching
-        SEND_LIMIT_EXCEEDED: :SendLimitExceeded
 
         def self?.values: -> ::Array[ArkEmail::Models::WebhookListDeliveriesParams::event]
       end

data/sig/ark_email/models/webhook_list_deliveries_response.rbs

@@ -106,8 +106,6 @@ module ArkEmail
           | :MessageLinkClicked
           | :MessageLoaded
           | :DomainDNSError
-          | :SendLimitApproaching
-          | :SendLimitExceeded
 
         module Event
           extend ArkEmail::Internal::Type::Enum
@@ -120,8 +118,6 @@ module ArkEmail
           MESSAGE_LINK_CLICKED: :MessageLinkClicked
           MESSAGE_LOADED: :MessageLoaded
           DOMAIN_DNS_ERROR: :DomainDNSError
-          SEND_LIMIT_APPROACHING: :SendLimitApproaching
-          SEND_LIMIT_EXCEEDED: :SendLimitExceeded
 
           def self?.values: -> ::Array[ArkEmail::Models::WebhookListDeliveriesResponse::Data::event]
         end

data/sig/ark_email/models/webhook_retrieve_delivery_response.rbs

@@ -106,8 +106,6 @@ module ArkEmail
           | :MessageLinkClicked
           | :MessageLoaded
           | :DomainDNSError
-          | :SendLimitApproaching
-          | :SendLimitExceeded
 
         module Event
           extend ArkEmail::Internal::Type::Enum
@@ -120,8 +118,6 @@ module ArkEmail
           MESSAGE_LINK_CLICKED: :MessageLinkClicked
           MESSAGE_LOADED: :MessageLoaded
           DOMAIN_DNS_ERROR: :DomainDNSError
-          SEND_LIMIT_APPROACHING: :SendLimitApproaching
-          SEND_LIMIT_EXCEEDED: :SendLimitExceeded
 
           def self?.values: -> ::Array[ArkEmail::Models::WebhookRetrieveDeliveryResponse::Data::event]
         end