ark-email 0.5.1

data/sig/ark_email/models/webhook_update_params.rbs

@@ -0,0 +1,56 @@
+module ArkEmail
+  module Models
+    type webhook_update_params =
+      {
+        all_events: bool,
+        enabled: bool,
+        events: ::Array[String],
+        name: String,
+        url: String
+      }
+      & ArkEmail::Internal::Type::request_parameters
+
+    class WebhookUpdateParams < ArkEmail::Internal::Type::BaseModel
+      extend ArkEmail::Internal::Type::RequestParameters::Converter
+      include ArkEmail::Internal::Type::RequestParameters
+
+      attr_reader all_events: bool?
+
+      def all_events=: (bool) -> bool
+
+      attr_reader enabled: bool?
+
+      def enabled=: (bool) -> bool
+
+      attr_reader events: ::Array[String]?
+
+      def events=: (::Array[String]) -> ::Array[String]
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_reader url: String?
+
+      def url=: (String) -> String
+
+      def initialize: (
+        ?all_events: bool,
+        ?enabled: bool,
+        ?events: ::Array[String],
+        ?name: String,
+        ?url: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        all_events: bool,
+        enabled: bool,
+        events: ::Array[String],
+        name: String,
+        url: String,
+        request_options: ArkEmail::RequestOptions
+      }
+    end
+  end
+end

data/sig/ark_email/models/webhook_update_response.rbs

@@ -0,0 +1,107 @@
+module ArkEmail
+  module Models
+    type webhook_update_response =
+      {
+        data: ArkEmail::Models::WebhookUpdateResponse::Data,
+        meta: ArkEmail::APIMeta,
+        success: true
+      }
+
+    class WebhookUpdateResponse < ArkEmail::Internal::Type::BaseModel
+      attr_accessor data: ArkEmail::Models::WebhookUpdateResponse::Data
+
+      attr_accessor meta: ArkEmail::APIMeta
+
+      attr_accessor success: true
+
+      def initialize: (
+        data: ArkEmail::Models::WebhookUpdateResponse::Data,
+        meta: ArkEmail::APIMeta,
+        ?success: true
+      ) -> void
+
+      def to_hash: -> {
+        data: ArkEmail::Models::WebhookUpdateResponse::Data,
+        meta: ArkEmail::APIMeta,
+        success: true
+      }
+
+      type data =
+        {
+          id: String,
+          all_events: bool,
+          created_at: Time,
+          enabled: bool,
+          events: ::Array[ArkEmail::Models::WebhookUpdateResponse::Data::event],
+          name: String,
+          url: String,
+          uuid: String
+        }
+
+      class Data < ArkEmail::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor all_events: bool
+
+        attr_accessor created_at: Time
+
+        attr_accessor enabled: bool
+
+        attr_accessor events: ::Array[ArkEmail::Models::WebhookUpdateResponse::Data::event]
+
+        attr_accessor name: String
+
+        attr_accessor url: String
+
+        attr_accessor uuid: String
+
+        def initialize: (
+          id: String,
+          all_events: bool,
+          created_at: Time,
+          enabled: bool,
+          events: ::Array[ArkEmail::Models::WebhookUpdateResponse::Data::event],
+          name: String,
+          url: String,
+          uuid: String
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          all_events: bool,
+          created_at: Time,
+          enabled: bool,
+          events: ::Array[ArkEmail::Models::WebhookUpdateResponse::Data::event],
+          name: String,
+          url: String,
+          uuid: String
+        }
+
+        type event =
+          :MessageSent
+          | :MessageDelayed
+          | :MessageDeliveryFailed
+          | :MessageHeld
+          | :MessageBounced
+          | :MessageLinkClicked
+          | :MessageLoaded
+          | :DomainDNSError
+
+        module Event
+          extend ArkEmail::Internal::Type::Enum
+
+          MESSAGE_SENT: :MessageSent
+          MESSAGE_DELAYED: :MessageDelayed
+          MESSAGE_DELIVERY_FAILED: :MessageDeliveryFailed
+          MESSAGE_HELD: :MessageHeld
+          MESSAGE_BOUNCED: :MessageBounced
+          MESSAGE_LINK_CLICKED: :MessageLinkClicked
+          MESSAGE_LOADED: :MessageLoaded
+          DOMAIN_DNS_ERROR: :DomainDNSError
+
+          def self?.values: -> ::Array[ArkEmail::Models::WebhookUpdateResponse::Data::event]
+        end
+      end
+    end
+  end
+end

data/sig/ark_email/models.rbs

@@ -0,0 +1,65 @@
+module ArkEmail
+  class APIMeta = ArkEmail::Models::APIMeta
+
+  class DNSRecord = ArkEmail::Models::DNSRecord
+
+  class DomainCreateParams = ArkEmail::Models::DomainCreateParams
+
+  class DomainDeleteParams = ArkEmail::Models::DomainDeleteParams
+
+  class DomainListParams = ArkEmail::Models::DomainListParams
+
+  class DomainRetrieveParams = ArkEmail::Models::DomainRetrieveParams
+
+  class DomainVerifyParams = ArkEmail::Models::DomainVerifyParams
+
+  class EmailListParams = ArkEmail::Models::EmailListParams
+
+  class EmailRetrieveDeliveriesParams = ArkEmail::Models::EmailRetrieveDeliveriesParams
+
+  class EmailRetrieveParams = ArkEmail::Models::EmailRetrieveParams
+
+  class EmailRetryParams = ArkEmail::Models::EmailRetryParams
+
+  class EmailSendBatchParams = ArkEmail::Models::EmailSendBatchParams
+
+  class EmailSendParams = ArkEmail::Models::EmailSendParams
+
+  class EmailSendRawParams = ArkEmail::Models::EmailSendRawParams
+
+  class SuppressionBulkCreateParams = ArkEmail::Models::SuppressionBulkCreateParams
+
+  class SuppressionCreateParams = ArkEmail::Models::SuppressionCreateParams
+
+  class SuppressionDeleteParams = ArkEmail::Models::SuppressionDeleteParams
+
+  class SuppressionListParams = ArkEmail::Models::SuppressionListParams
+
+  class SuppressionRetrieveParams = ArkEmail::Models::SuppressionRetrieveParams
+
+  class TrackDomain = ArkEmail::Models::TrackDomain
+
+  class TrackingCreateParams = ArkEmail::Models::TrackingCreateParams
+
+  class TrackingDeleteParams = ArkEmail::Models::TrackingDeleteParams
+
+  class TrackingListParams = ArkEmail::Models::TrackingListParams
+
+  class TrackingRetrieveParams = ArkEmail::Models::TrackingRetrieveParams
+
+  class TrackingUpdateParams = ArkEmail::Models::TrackingUpdateParams
+
+  class TrackingVerifyParams = ArkEmail::Models::TrackingVerifyParams
+
+  class WebhookCreateParams = ArkEmail::Models::WebhookCreateParams
+
+  class WebhookDeleteParams = ArkEmail::Models::WebhookDeleteParams
+
+  class WebhookListParams = ArkEmail::Models::WebhookListParams
+
+  class WebhookRetrieveParams = ArkEmail::Models::WebhookRetrieveParams
+
+  class WebhookTestParams = ArkEmail::Models::WebhookTestParams
+
+  class WebhookUpdateParams = ArkEmail::Models::WebhookUpdateParams
+end

data/sig/ark_email/request_options.rbs

@@ -0,0 +1,34 @@
+module ArkEmail
+  type request_opts =
+    ArkEmail::RequestOptions | ArkEmail::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < ArkEmail::Internal::Type::BaseModel
+    def self.validate!: (ArkEmail::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?ArkEmail::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/ark_email/resources/domains.rbs

@@ -0,0 +1,31 @@
+module ArkEmail
+  module Resources
+    class Domains
+      def create: (
+        name: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::DomainCreateResponse
+
+      def retrieve: (
+        String domain_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::DomainRetrieveResponse
+
+      def list: (
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::DomainListResponse
+
+      def delete: (
+        String domain_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::DomainDeleteResponse
+
+      def verify: (
+        String domain_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::DomainVerifyResponse
+
+      def initialize: (client: ArkEmail::Client) -> void
+    end
+  end
+end

data/sig/ark_email/resources/emails.rbs

@@ -0,0 +1,65 @@
+module ArkEmail
+  module Resources
+    class Emails
+      def retrieve: (
+        String email_id,
+        ?expand: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::EmailRetrieveResponse
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?from: String,
+        ?page: Integer,
+        ?per_page: Integer,
+        ?status: ArkEmail::Models::EmailListParams::status,
+        ?tag: String,
+        ?to: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Internal::PageNumberPagination[ArkEmail::Models::EmailListResponse]
+
+      def retrieve_deliveries: (
+        String email_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::EmailRetrieveDeliveriesResponse
+
+      def retry_: (
+        String email_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::EmailRetryResponse
+
+      def send_: (
+        from: String,
+        subject: String,
+        to: ::Array[String],
+        ?attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
+        ?bcc: ::Array[String],
+        ?cc: ::Array[String],
+        ?headers: ::Hash[Symbol, String],
+        ?html: String,
+        ?reply_to: String,
+        ?tag: String,
+        ?text: String,
+        ?idempotency_key: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::EmailSendResponse
+
+      def send_batch: (
+        emails: ::Array[ArkEmail::EmailSendBatchParams::Email],
+        from: String,
+        ?idempotency_key: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::EmailSendBatchResponse
+
+      def send_raw: (
+        data: String,
+        mail_from: String,
+        rcpt_to: ::Array[String],
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::EmailSendRawResponse
+
+      def initialize: (client: ArkEmail::Client) -> void
+    end
+  end
+end

data/sig/ark_email/resources/suppressions.rbs

@@ -0,0 +1,34 @@
+module ArkEmail
+  module Resources
+    class Suppressions
+      def create: (
+        address: String,
+        ?reason: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::SuppressionCreateResponse
+
+      def retrieve: (
+        String email,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::SuppressionRetrieveResponse
+
+      def list: (
+        ?page: Integer,
+        ?per_page: Integer,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Internal::PageNumberPagination[ArkEmail::Models::SuppressionListResponse]
+
+      def delete: (
+        String email,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::SuppressionDeleteResponse
+
+      def bulk_create: (
+        suppressions: ::Array[ArkEmail::SuppressionBulkCreateParams::Suppression],
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::SuppressionBulkCreateResponse
+
+      def initialize: (client: ArkEmail::Client) -> void
+    end
+  end
+end

data/sig/ark_email/resources/tracking.rbs

@@ -0,0 +1,44 @@
+module ArkEmail
+  module Resources
+    class Tracking
+      def create: (
+        domain_id: String,
+        name: String,
+        ?ssl_enabled: bool,
+        ?track_clicks: bool,
+        ?track_opens: bool,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::TrackingCreateResponse
+
+      def retrieve: (
+        String tracking_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::TrackingRetrieveResponse
+
+      def update: (
+        String tracking_id,
+        ?excluded_click_domains: String,
+        ?ssl_enabled: bool,
+        ?track_clicks: bool,
+        ?track_opens: bool,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::TrackingUpdateResponse
+
+      def list: (
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::TrackingListResponse
+
+      def delete: (
+        String tracking_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::TrackingDeleteResponse
+
+      def verify: (
+        String tracking_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::TrackingVerifyResponse
+
+      def initialize: (client: ArkEmail::Client) -> void
+    end
+  end
+end

data/sig/ark_email/resources/webhooks.rbs

@@ -0,0 +1,46 @@
+module ArkEmail
+  module Resources
+    class Webhooks
+      def create: (
+        events: ::Array[ArkEmail::Models::WebhookCreateParams::event],
+        name: String,
+        url: String,
+        ?all_events: bool,
+        ?enabled: bool,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::WebhookCreateResponse
+
+      def retrieve: (
+        String webhook_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::WebhookRetrieveResponse
+
+      def update: (
+        String webhook_id,
+        ?all_events: bool,
+        ?enabled: bool,
+        ?events: ::Array[String],
+        ?name: String,
+        ?url: String,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::WebhookUpdateResponse
+
+      def list: (
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::WebhookListResponse
+
+      def delete: (
+        String webhook_id,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::WebhookDeleteResponse
+
+      def test_: (
+        String webhook_id,
+        event: ArkEmail::Models::WebhookTestParams::event,
+        ?request_options: ArkEmail::request_opts
+      ) -> ArkEmail::Models::WebhookTestResponse
+
+      def initialize: (client: ArkEmail::Client) -> void
+    end
+  end
+end

data/sig/ark_email/version.rbs

@@ -0,0 +1,3 @@
+module ArkEmail
+  VERSION: String
+end