ark-email 0.14.0 → 0.16.0

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

data/sig/ark_email/models/webhook_retrieve_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::WebhookRetrieveResponse::Data::event]
         end

data/sig/ark_email/models/webhook_test_params.rbs

@@ -29,8 +29,6 @@ module ArkEmail
         | :MessageLinkClicked
         | :MessageLoaded
         | :DomainDNSError
-        | :SendLimitApproaching
-        | :SendLimitExceeded
 
       module Event
         extend ArkEmail::Internal::Type::Enum
@@ -43,8 +41,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::WebhookTestParams::event]
       end

data/sig/ark_email/models/webhook_update_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::WebhookUpdateResponse::Data::event]
         end

data/sig/ark_email/models.rbs

@@ -59,6 +59,8 @@ module ArkEmail
 
   class TrackingVerifyParams = ArkEmail::Models::TrackingVerifyParams
 
+  class UsageRetrieveParams = ArkEmail::Models::UsageRetrieveParams
+
   class WebhookCreateParams = ArkEmail::Models::WebhookCreateParams
 
   class WebhookDeleteParams = ArkEmail::Models::WebhookDeleteParams

data/sig/ark_email/resources/emails.rbs

@@ -2,7 +2,7 @@ module ArkEmail
   module Resources
     class Emails
       def retrieve: (
-        String email_id,
+        String id,
         ?expand: String,
         ?request_options: ArkEmail::request_opts
       ) -> ArkEmail::Models::EmailRetrieveResponse
@@ -20,12 +20,12 @@ module ArkEmail
       ) -> ArkEmail::Internal::PageNumberPagination[ArkEmail::Models::EmailListResponse]
 
       def retrieve_deliveries: (
-        String email_id,
+        String id,
         ?request_options: ArkEmail::request_opts
       ) -> ArkEmail::Models::EmailRetrieveDeliveriesResponse
 
       def retry_: (
-        String email_id,
+        String id,
         ?request_options: ArkEmail::request_opts
       ) -> ArkEmail::Models::EmailRetryResponse
 

data/sig/ark_email/resources/usage.rbs

@@ -0,0 +1,11 @@
+module ArkEmail
+  module Resources
+    class Usage
+      def retrieve: (
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::UsageRetrieveResponse
+
+      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.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Ark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-25 00:00:00.000000000 Z
+date: 2026-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -124,6 +124,8 @@ files:
 - lib/ark_email/models/tracking_update_response.rb
 - lib/ark_email/models/tracking_verify_params.rb
 - lib/ark_email/models/tracking_verify_response.rb
+- lib/ark_email/models/usage_retrieve_params.rb
+- lib/ark_email/models/usage_retrieve_response.rb
 - lib/ark_email/models/webhook_create_params.rb
 - lib/ark_email/models/webhook_create_response.rb
 - lib/ark_email/models/webhook_delete_params.rb
@@ -148,6 +150,7 @@ files:
 - lib/ark_email/resources/logs.rb
 - lib/ark_email/resources/suppressions.rb
 - lib/ark_email/resources/tracking.rb
+- lib/ark_email/resources/usage.rb
 - lib/ark_email/resources/webhooks.rb
 - lib/ark_email/version.rb
 - manifest.yaml
@@ -225,6 +228,8 @@ files:
 - rbi/ark_email/models/tracking_update_response.rbi
 - rbi/ark_email/models/tracking_verify_params.rbi
 - rbi/ark_email/models/tracking_verify_response.rbi
+- rbi/ark_email/models/usage_retrieve_params.rbi
+- rbi/ark_email/models/usage_retrieve_response.rbi
 - rbi/ark_email/models/webhook_create_params.rbi
 - rbi/ark_email/models/webhook_create_response.rbi
 - rbi/ark_email/models/webhook_delete_params.rbi
@@ -249,6 +254,7 @@ files:
 - rbi/ark_email/resources/logs.rbi
 - rbi/ark_email/resources/suppressions.rbi
 - rbi/ark_email/resources/tracking.rbi
+- rbi/ark_email/resources/usage.rbi
 - rbi/ark_email/resources/webhooks.rbi
 - rbi/ark_email/version.rbi
 - sig/ark_email/client.rbs
@@ -325,6 +331,8 @@ files:
 - sig/ark_email/models/tracking_update_response.rbs
 - sig/ark_email/models/tracking_verify_params.rbs
 - sig/ark_email/models/tracking_verify_response.rbs
+- sig/ark_email/models/usage_retrieve_params.rbs
+- sig/ark_email/models/usage_retrieve_response.rbs
 - sig/ark_email/models/webhook_create_params.rbs
 - sig/ark_email/models/webhook_create_response.rbs
 - sig/ark_email/models/webhook_delete_params.rbs
@@ -349,6 +357,7 @@ files:
 - sig/ark_email/resources/logs.rbs
 - sig/ark_email/resources/suppressions.rbs
 - sig/ark_email/resources/tracking.rbs
+- sig/ark_email/resources/usage.rbs
 - sig/ark_email/resources/webhooks.rbs
 - sig/ark_email/version.rbs
 homepage: https://gemdocs.org/gems/ark-email