ark-email 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3df5685574fc4f8e23b5ff3b411878f1d8e9439b0921b03da6917cbf8cfddcb
+  data.tar.gz: 22c92885355e07dbee603ade4f1861a99ef375ab8b2fcce20c88e931ce78ea43
+SHA512:
+  metadata.gz: 6a42a8eceb1d1107045b72d82f93f6f55123d11d7bab8bf6008577cca21d992b7883f6924d0d5bff9a58b7696484c8d053610868b9e4dfbfe5d56b0f666d4002
+  data.tar.gz: 5024e6b714c7033802eb482995c0165728d585e36be3e81e8481431261fc4d55f07b228f4582e51f51afa8fc6ed888e15ffb10f91bcdd263e3cf593bd36ee72a

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+## 0.5.1 (2026-01-13)
+
+Full Changelog: [v0.5.0...v0.5.1](https://github.com/ArkHQ-io/ark-ruby/compare/v0.5.0...v0.5.1)
+
+### Chores
+
+* update SDK settings ([b29ec46](https://github.com/ArkHQ-io/ark-ruby/commit/b29ec4697ee7e2dac11d0601ba7902b06433af31))
+
+## 0.5.0 (2026-01-13)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** manual updates ([a06c109](https://github.com/ArkHQ-io/ark-ruby/commit/a06c109a3f5dccb5ba5a5c3accedfb9f0adf8c68))
+
+## 0.4.0 (2026-01-13)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([a7e8384](https://github.com/ArkHQ-io/ark-ruby/commit/a7e8384f64490c3ea4d467bd80b0da014d9ea0a5))
+
+## 0.3.0 (2026-01-13)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([0a6d61f](https://github.com/ArkHQ-io/ark-ruby/commit/0a6d61fdd21fba363d2ebc84ace142799045cb66))
+* **api:** api update ([3083989](https://github.com/ArkHQ-io/ark-ruby/commit/3083989f24356ccef854dc23cc3b714ed47a43f7))
+* **api:** api update ([130978a](https://github.com/ArkHQ-io/ark-ruby/commit/130978ad1a900a1cb1ee294292c3750f56b24c91))
+* **api:** manual updates ([2b70180](https://github.com/ArkHQ-io/ark-ruby/commit/2b701809d303ff6e1eb53d8c98a6e40d77ae997a))
+* **api:** manual updates ([4661f13](https://github.com/ArkHQ-io/ark-ruby/commit/4661f13e2bda36daeacbd187fef4d1d8500bdc57))
+* **api:** manual updates ([915e7a2](https://github.com/ArkHQ-io/ark-ruby/commit/915e7a2a054f0a71c530fcf5a59605d04429e794))
+* **api:** manual updates ([da378de](https://github.com/ArkHQ-io/ark-ruby/commit/da378de1cba810f6a8aa65e0003dae5950bb7513))
+* **api:** manual updates ([58385cd](https://github.com/ArkHQ-io/ark-ruby/commit/58385cd1362de9d27c48e53cdc85fd62c2c90ab5))
+* **api:** manual updates ([9a9c4ee](https://github.com/ArkHQ-io/ark-ruby/commit/9a9c4eeb1680ed6b4b391d77841401aa88e4db5d))
+* **api:** manual updates ([cc3363d](https://github.com/ArkHQ-io/ark-ruby/commit/cc3363d8de583741a7897958ae38cf6c2708123a))
+* **api:** manual updates ([ece1bb4](https://github.com/ArkHQ-io/ark-ruby/commit/ece1bb41a99f382b17e1325431f120b62b3935c4))
+* **api:** manual updates ([dd9399a](https://github.com/ArkHQ-io/ark-ruby/commit/dd9399a46e589b4b85cffb7fff2f345cc5aab3e3))
+* **api:** manual updates ([20e1010](https://github.com/ArkHQ-io/ark-ruby/commit/20e10103e8a2eb173e5095b4bc1b89718061dc62))
+* **api:** manual updates ([930a7e7](https://github.com/ArkHQ-io/ark-ruby/commit/930a7e71ffeaa1449fa9f01673995f194aab8c79))
+
+## 0.2.0 (2026-01-12)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** api update ([8e524fa](https://github.com/ArkHQ-io/ark-ruby/commit/8e524fa8da2506ad72d53ee8e9cee5813a65f471))
+
+## 0.1.0 (2026-01-12)
+
+Full Changelog: [v0.0.2...v0.1.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.0.2...v0.1.0)
+
+### Features
+
+* **api:** api update ([2340c5f](https://github.com/ArkHQ-io/ark-ruby/commit/2340c5fd2391d01a2736ff16e3c0b3a58d2fec8b))
+* **api:** api update ([45b17fd](https://github.com/ArkHQ-io/ark-ruby/commit/45b17fd41c2c2b73f26b9bcf2c342a51b269f5cd))
+
+## 0.0.2 (2026-01-12)
+
+Full Changelog: [v0.0.1...v0.0.2](https://github.com/ArkHQ-io/ark-ruby/compare/v0.0.1...v0.0.2)
+
+### Chores
+
+* update SDK settings ([4f1beb2](https://github.com/ArkHQ-io/ark-ruby/commit/4f1beb2fdf09d01694bbaef9be255dded7429951))

data/README.md

@@ -0,0 +1,303 @@
+# Ark Ruby API library
+
+The Ark Ruby library provides convenient access to the Ark REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/ArkHQ-io/ark-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/ark-email).
+
+The REST API documentation can be found on [arkhq.io](https://arkhq.io/docs).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "ark-email", "~> 0.5.1"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "ark_email"
+
+ark = ArkEmail::Client.new(
+  api_key: ENV["ARK_API_KEY"] # This is the default and can be omitted
+)
+
+response = ark.emails.send_(
+  from: "hello@yourdomain.com",
+  subject: "Hello World",
+  to: ["user@example.com"],
+  html: "<h1>Welcome!</h1>"
+)
+
+puts(response.data)
+```
+
+### Pagination
+
+List methods in the Ark API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = ark.emails.list(page: 1, per_page: 10)
+
+# Fetch single item from page.
+email = page.data[0]
+puts(email.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |email|
+  puts(email.id)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].id)
+end
+```
+
+### Handling errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `ArkEmail::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  email = ark.emails.send_(
+    from: "hello@yourdomain.com",
+    subject: "Hello World",
+    to: ["user@example.com"],
+    html: "<h1>Welcome!</h1>"
+  )
+rescue ArkEmail::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue ArkEmail::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue ArkEmail::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
+```
+
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+ark = ArkEmail::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+ark.emails.send_(
+  from: "hello@yourdomain.com",
+  subject: "Hello World",
+  to: ["user@example.com"],
+  html: "<h1>Welcome!</h1>",
+  request_options: {max_retries: 5}
+)
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+ark = ArkEmail::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+ark.emails.send_(
+  from: "hello@yourdomain.com",
+  subject: "Hello World",
+  to: ["user@example.com"],
+  html: "<h1>Welcome!</h1>",
+  request_options: {timeout: 5}
+)
+```
+
+On timeout, `ArkEmail::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `ArkEmail::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+response =
+  ark.emails.send_(
+    from: "hello@yourdomain.com",
+    subject: "Hello World",
+    to: ["user@example.com"],
+    html: "<h1>Welcome!</h1>",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(response[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `ArkEmail::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `ArkEmail::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+ark.emails.send_(
+  from: "hello@yourdomain.com",
+  subject: "Hello World",
+  to: ["user@example.com"],
+  html: "<h1>Welcome!</h1>"
+)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+ark.emails.send_(
+  from: "hello@yourdomain.com",
+  subject: "Hello World",
+  to: ["user@example.com"],
+  html: "<h1>Welcome!</h1>"
+)
+
+# You can also splat a full Params class:
+params = ArkEmail::EmailSendParams.new(
+  from: "hello@yourdomain.com",
+  subject: "Hello World",
+  to: ["user@example.com"],
+  html: "<h1>Welcome!</h1>"
+)
+ark.emails.send_(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :pending
+puts(ArkEmail::EmailListParams::Status::PENDING)
+
+# Revealed type: `T.all(ArkEmail::EmailListParams::Status, Symbol)`
+T.reveal_type(ArkEmail::EmailListParams::Status::PENDING)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+ark.emails.list(
+  status: ArkEmail::EmailListParams::Status::PENDING,
+  # …
+)
+
+# Literal values are also permissible:
+ark.emails.list(
+  status: :pending,
+  # …
+)
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/ArkHQ-io/ark-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Ark, please follow the respective company's security reporting guidelines.
+
+### Ark Terms and Policies
+
+Please contact hi@arkhq.io for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/ark_email/client.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ArkEmail
+  class Client < ArkEmail::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # Use your API key from
+    # [arkhq.io/org/credentials](https://arkhq.io/org/credentials)
+    #
+    # ```
+    # Authorization: Bearer YOUR_API_KEY
+    # ```
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [ArkEmail::Resources::Emails]
+    attr_reader :emails
+
+    # @return [ArkEmail::Resources::Domains]
+    attr_reader :domains
+
+    # @return [ArkEmail::Resources::Suppressions]
+    attr_reader :suppressions
+
+    # @return [ArkEmail::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @return [ArkEmail::Resources::Tracking]
+    attr_reader :tracking
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Use your API key from
+    # [arkhq.io/org/credentials](https://arkhq.io/org/credentials)
+    #
+    # ````
+    # Authorization: Bearer YOUR_API_KEY
+    # ``` Defaults to `ENV["ARK_API_KEY"]`
+    # ````
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["ARK_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["ARK_API_KEY"],
+      base_url: ENV["ARK_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.arkhq.io/v1"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"ARK_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @emails = ArkEmail::Resources::Emails.new(client: self)
+      @domains = ArkEmail::Resources::Domains.new(client: self)
+      @suppressions = ArkEmail::Resources::Suppressions.new(client: self)
+      @webhooks = ArkEmail::Resources::Webhooks.new(client: self)
+      @tracking = ArkEmail::Resources::Tracking.new(client: self)
+    end
+  end
+end