openemail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b529e237ea6cc98204574ecf5b0b0b58fb7e774cd18ed07ac265ec243885fe1c
+  data.tar.gz: 26844441518ca76d25b0908248924119c0528f56bf874b919c6f4a8dd1942e2d
+SHA512:
+  metadata.gz: b6236ffe92657e77e6478042d728023a16826bbc194b70178d7cdb809815ef577bae64b62d1ada664760ad4f0a3771a04a2b993254a43bccceb9db541680c9bd
+  data.tar.gz: 871936c1946ea670dd8728a4651295114be58d11328307ba9bc298eb9b6c556793cb8112d932fe3a0958eb429f0c38721cd7072cc35fb8e2cf7d0f36fc033f47

data/README.md

@@ -0,0 +1,183 @@
+<div align='center'>
+   <a href='https://openemail.uk'>
+        <img
+            src='https://openemail.uk/logo.svg'
+            alt='OpenEmail Logo'
+            width='180'
+        />
+   </a>
+
+   <br />
+</div>
+
+<p align='center'>
+    Email you can build on. Send mail, read the mailbox and automate a workspace from Ruby.
+</p>
+
+<p align='center'>
+    <a href='https://openemail.uk'><b>Website</b></a>
+    •
+    <a href='https://openemail.uk/docs/ruby'><b>Documentation</b></a>
+    •
+    <a href='https://openemail.uk/docs/ruby/reference/methods'><b>Every method</b></a>
+    •
+    <a href='https://openemail.uk/docs/api/reference'><b>API Reference</b></a>
+</p>
+
+<br />
+
+## The Ruby gem
+
+The official Ruby client for the OpenEmail API. It has one method for every method of the TypeScript SDK, under the same names in snake_case, and a parity check proves that each one sends the same request. It needs Ruby 3.2 or later and has no runtime dependencies: the HTTP client is Net::HTTP from the standard library, with a pool of kept-alive connections that one client shares safely across threads and that is rebuilt after a fork.
+
+It carries a workspace API key or an OAuth access token, so it belongs on a server, in a job or in a tool that runs on your own machine.
+
+### Installing
+```bash
+bundle add openemail
+```
+
+Or `gem install openemail` without Bundler.
+
+### Using
+```ruby
+require "openemail"
+
+client = OpenEmail::Client.new(api_key: ENV.fetch("OPENEMAIL_API_KEY"))
+
+sent = client.emails.send(
+  from: "Acme Billing <billing@acme.com>",
+  to: "ada@example.com",
+  subject: "Your September invoice",
+  html: "<p>Your invoice is attached.</p>",
+  attachments: [{filename: "invoice.pdf", content: File.binread("invoice.pdf"), contentType: "application/pdf"}]
+)
+
+puts sent[:id], sent[:status]
+```
+
+Create a key in OpenEmail under Settings, API keys. It is shown once, and it belongs in an environment variable or your credentials store rather than in code.
+
+A request body goes in as keyword arguments or as one Hash, and its keys keep the API's names, so `replyTo:`, `scheduledAt:` and `contentType:` stay camelCase. Options of the call itself are snake_case: `idempotency_key:`, `api_key:`, `limit:`, `cursor:`. What comes back is the parsed JSON as a Hash with Symbol keys, read with `sent[:id]`.
+
+Or skip building a client. `OpenEmail.emails`, `OpenEmail.threads` and every other namespace use a shared client built from `OPENEMAIL_API_KEY` the first time one is touched:
+
+```ruby
+OpenEmail.emails.send(from: "hello@acme.com", to: "ada@example.com", subject: "Welcome", text: "Glad you are here.")
+```
+
+Every send carries an idempotency key, generated once per call and reused by its retries, so a retried request replays the original message rather than sending a second one. Pass your own with `idempotency_key:` to make that hold across processes and restarts.
+
+### Reading the mailbox
+```ruby
+page = client.threads.list(folder: "inbox", limit: 25)
+page.items.each { |thread| puts thread[:subject] }
+
+client.threads.iterate(folder: "inbox", query: "invoice") do |thread|
+  full = client.threads.get(thread[:id])
+  puts full[:messageCount], full[:hasUnread]
+end
+```
+
+Every paginated resource has `list` for one page (an `OpenEmail::Page` with `items`, `has_more?` and `next_cursor`), `list_all` for every page at once as an Array, and `iterate`, which yields each item to a block, or without one returns an Enumerator that fetches the next page only when it gets there, so `first(10)` stops early. `addresses.list_all` is the exception and returns the whole address book.
+
+### Errors
+```ruby
+template = "order-shipped"
+
+begin
+  client.templates.send(template, from: "dispatch@acme.com", to: "ada@example.com", props: {orderId: "AC-4192"})
+rescue OpenEmail::ValidationError => error
+  warn [error.code, error.param, error.request_id].join(" ")
+  raise
+end
+```
+
+An API refusal raises an `OpenEmail::ApiError`, or the subclass for its type: `AuthenticationError`, `PermissionError`, `NotFoundError`, `ConflictError`, `ValidationError`, `RateLimitError` or `InvalidRequestError`. Each carries `status`, `type`, `code`, `param`, `request_id` and `body`, plus `validation?`, `not_found?`, `rate_limited?` and friends to branch on. No response at all raises `OpenEmail::NetworkError`, with `timeout?` when the deadline passed. A mistake in the call itself, such as a malformed key or an empty id, raises `ArgumentError` before anything is sent.
+
+### Webhooks
+```ruby
+class OpenEmailWebhooksController < ActionController::API
+  def create
+    event = OpenEmail.verify_webhook_signature(
+      payload: request.raw_post,
+      headers: request.headers,
+      secret: Rails.application.credentials.openemail_webhook_secret
+    )
+
+    Rails.logger.info("#{event[:type]} #{event[:data]}")
+    head :no_content
+  rescue OpenEmail::WebhookSignatureError
+    head :bad_request
+  end
+end
+```
+
+It checks the HMAC in constant time and rejects a delivery more than five minutes old, then returns the parsed event. Pass the raw body: a parsed or re-encoded body no longer matches its signature. The headers can be a Hash in any case, a Rack env or Rails' `request.headers`.
+
+### Disposable inboxes
+```ruby
+temp_mail = OpenEmail.create_temp_mail
+
+inbox = temp_mail.create(ttlMinutes: 60)
+
+page = temp_mail.list_messages(inbox[:id], inbox_token: inbox[:token])
+```
+
+`create` needs no credential and is the only call that returns the inbox token, so keep it.
+
+### OAuth access tokens
+An app a person connected to OpenEmail with OAuth, such as a command line tool or an agent, holds an access token rather than an API key. Pass it as `access_token:`, either the token itself or anything that responds to `call` and returns it:
+
+```ruby
+client = OpenEmail::Client.new(access_token: -> { session.fresh_access_token })
+```
+
+The callable runs before every request, so renew the token there when it is close to expiring and the client never has to be rebuilt. Pass `api_key:` or `access_token:`, not both. `OpenEmail.create_client` reads `OPENEMAIL_ACCESS_TOKEN` when you pass neither and `OPENEMAIL_API_KEY` is not set.
+
+A token acts for a person, so before a sensitive change, such as deleting a domain or changing a webhook, it is asked for the same verification code the web app asks for. The request raises with `step_up_required?`. Ask for a code, check it, then replay the request:
+
+```ruby
+begin
+  client.domains.delete(domain_id)
+rescue OpenEmail::ApiError => error
+  raise unless error.step_up_required?
+
+  challenge = client.security.begin_step_up
+  code = ask(challenge[:method] == "email" ? "Enter the code we emailed to #{challenge[:sentTo]}" : "Enter the code from your authenticator app")
+
+  client.security.verify_step_up(code:)
+  client.domains.delete(domain_id)
+end
+```
+
+API keys are never asked for a code.
+
+### Configuring
+```ruby
+client = OpenEmail::Client.new(
+  api_key: ENV.fetch("OPENEMAIL_API_KEY"),
+  base_url: "https://api.openemail.uk",
+  timeout: 30,
+  max_retries: 2,
+  headers: {"X-Team" => "billing"}
+)
+```
+
+`OpenEmail.create_client(...)` takes the same options and reads what you leave out from the environment: `OPENEMAIL_API_KEY`, then `OPENEMAIL_ACCESS_TOKEN`, and `OPENEMAIL_BASE_URL`, where a bare host such as `localhost:2222` gets its scheme added. `OpenEmail.init(...)` does the same for the shared client.
+
+Use an `https:` origin: the client refuses to send an API key, an access token or an inbox token over plain `http:` unless the server is on this machine, at `localhost`, a `127.x.x.x` address or `::1`. A `base_url` on `0.0.0.0` raises when the client is built, since that is the address a server listens on: use `127.0.0.1` with the same port. `timeout:` is in seconds and bounds a whole attempt, 0 turns it off, and uploads wait at least ten minutes. Reads, sends and every write that is safe to repeat are retried on 408, 500, 502, 503 and 504 with backoff, and on a 429 only when it carries a `Retry-After` of a minute or less. Any other write is never retried. Every method takes `api_key:` to act with another key for one call, so one process can serve several workspaces with one client, and the `temp_mail` methods take `inbox_token:` instead. `HTTPS_PROXY` and `NO_PROXY` are honoured.
+
+An endpoint no method wraps yet is one `client.raw.request` away, with the client's credential, base URL, timeout and retry policy applied:
+
+```ruby
+client.raw.request("/something-new", method: :post, body: {name: "Invoices"})
+```
+
+The path must begin with a single `/`, and a path whose finished URL leaves the base URL's origin raises before a request is sent, so the credential never reaches another host.
+
+`adapter:` swaps the HTTP layer for anything that responds to `call(request)` and returns an `OpenEmail::HttpResponse`, which is how a test drives the client without a network.
+
+When a newer version is on RubyGems the client says so once on a TTY. `OPENEMAIL_DISABLE_UPDATE_NOTICE=1` or `disable_update_notice: true` turns that off.
+
+Everything else, from templates, rules, tracking, calendar, contacts, audiences and broadcasts to roles, members, settings, mailbox imports and provider imports, plus the full reference for every method, lives in the [documentation](https://openemail.uk/docs/ruby). What changed in each release is in the [changelog](https://openemail.uk/docs/ruby/changelog).

data/lib/openemail/api_paths.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module OpenEmail
+  module ApiPaths
+    ACCOUNT_CONNECTED_APP = "/account/connected-apps/:clientId"
+    ACCOUNT_CONNECTED_APPS = "/account/connected-apps"
+    ACCOUNT_INVITATIONS = "/account/invitations"
+    ACCOUNT_INVITATION_ACCEPT = "/account/invitations/:invitationId/accept"
+    ACCOUNT_INVITATION_DECLINE = "/account/invitations/:invitationId/decline"
+    ACCOUNT_NOTIFICATIONS = "/account/notifications"
+    ACCOUNT_NOTIFICATION_EMAIL = "/account/notifications/email/:category"
+    ACCOUNT_NOTIFICATION_PUSH = "/account/notifications/push/:workspaceId"
+    ACCOUNT_PHOTO = "/account/photo"
+    ACCOUNT_USERNAME = "/account/username"
+    ACCOUNT_USERNAME_AVAILABILITY = "/account/username/availability"
+    ADDRESSES = "/addresses"
+    ANALYTICS_MAILBOX = "/analytics/mailbox"
+    ANALYTICS_SENDING = "/analytics/sending"
+    APP_HOST = "/app-host"
+    APP_HOST_VERIFY = "/app-host/verify"
+    AUDIENCE = "/audiences/:id"
+    AUDIENCES = "/audiences"
+    AUDIENCES_GROWTH = "/audiences/growth"
+    AUDIENCE_CONTACT = "/audiences/:id/contacts/:email"
+    AUDIENCE_CONTACTS = "/audiences/:id/contacts"
+    AUDIENCE_CONTACTS_BATCH = "/audiences/:id/contacts/batch"
+    AUDIENCE_CONTACTS_BATCH_REMOVE = "/audiences/:id/contacts/batch-remove"
+    AUDIENCE_EMPTY = "/audiences/:id/empty"
+    AUDIENCE_IMPORT = "/audiences/:id/import"
+    BILLING = "/billing"
+    BILLING_ALERTS = "/billing/alerts"
+    BILLING_CHECKOUT = "/billing/checkout"
+    BILLING_COUNTRIES = "/billing/countries"
+    BILLING_INVOICE = "/billing/invoices/:orderId"
+    BILLING_INVOICES = "/billing/invoices"
+    BILLING_INVOICE_DETAILS = "/billing/invoices/:orderId/details"
+    BILLING_PAY_AS_YOU_GO = "/billing/pay-as-you-go"
+    BILLING_PAY_AS_YOU_GO_CONFIRM = "/billing/pay-as-you-go/confirm"
+    BILLING_PAY_AS_YOU_GO_LIMIT = "/billing/pay-as-you-go/limit"
+    BILLING_PLANS = "/billing/plans"
+    BILLING_PORTAL = "/billing/portal"
+    BILLING_USAGE = "/billing/usage"
+    BRANDING = "/branding"
+    BRANDING_IMAGE = "/branding/images/:variant"
+    BROADCAST = "/broadcasts/:id"
+    BROADCASTS = "/broadcasts"
+    BROADCASTS_ANALYTICS = "/broadcasts/analytics"
+    BROADCASTS_PREVIEW = "/broadcasts/preview"
+    BROADCAST_CANCEL = "/broadcasts/:id/cancel"
+    BROADCAST_RECIPIENT = "/broadcasts/:id/recipients/:emailId"
+    BROADCAST_RECIPIENTS = "/broadcasts/:id/recipients"
+    BROADCAST_STATS = "/broadcasts/:id/stats"
+    CALENDAR_EVENT = "/calendar/events/:id"
+    CALENDAR_EVENTS = "/calendar/events"
+    CALENDAR_EVENT_CANCEL = "/calendar/events/:id/cancel"
+    CALENDAR_EVENT_ICS = "/calendar/events/:id/ics"
+    CALENDAR_EVENT_RESPOND = "/calendar/events/:id/respond"
+    CHAT = "/chats/:id"
+    CHATS = "/chats"
+    CONTACT = "/contacts/:email"
+    CONTACTS = "/contacts"
+    CONTACTS_BATCH_DELETE = "/contacts/batch-delete"
+    CONTACTS_PEOPLE = "/contacts/people"
+    CONTACT_ACTIVITY = "/contacts/:email/activity"
+    CONTACT_AUDIENCES = "/contacts/:email/audiences"
+    CONTACT_BLOCK = "/contacts/:email/block"
+    CONTACT_PHOTO = "/contacts/:email/photo"
+    CONTACT_THREADS = "/contacts/:email/threads"
+    DNS_CONNECTION = "/dns-connections/:id"
+    DNS_CONNECTIONS = "/dns-connections"
+    DOMAIN = "/domains/:id"
+    DOMAINS = "/domains"
+    DOMAIN_ADDRESS = "/domains/:id/addresses/:addressId"
+    DOMAIN_ADDRESSES = "/domains/:id/addresses"
+    DOMAIN_ADDRESS_FORWARD = "/domains/:id/addresses/:addressId/forwards/:forwardId"
+    DOMAIN_ADDRESS_FORWARDS = "/domains/:id/addresses/:addressId/forwards"
+    DOMAIN_ADDRESS_FORWARD_RESEND = "/domains/:id/addresses/:addressId/forwards/:forwardId/resend"
+    DOMAIN_ADDRESS_LOGIN = "/domains/:id/addresses/:addressId/login"
+    DOMAIN_ADDRESS_MEMBERS = "/domains/:id/addresses/:addressId/members"
+    DOMAIN_ADDRESS_PHOTO = "/domains/:id/addresses/:addressId/photo"
+    DOMAIN_DNS = "/domains/:id/dns"
+    DOMAIN_DNS_SYNC = "/domains/:id/dns/sync"
+    DOMAIN_LOGO = "/domains/:id/logo"
+    DOMAIN_LOGO_CERTIFICATE = "/domains/:id/logo/certificate"
+    DOMAIN_VERIFY = "/domains/:id/verify"
+    DRAFT = "/drafts/:id"
+    DRAFTS = "/drafts"
+    EMAIL = "/emails/:id"
+    EMAILS = "/emails"
+    EMAILS_BATCH = "/emails/batch"
+    EMAILS_CHECK = "/emails/check"
+    EMAILS_COMPOSE = "/emails/compose"
+    EMAILS_REWRITE = "/emails/rewrite"
+    EMAILS_SUBJECT = "/emails/subject"
+    EMAILS_TRANSLATE = "/emails/translate"
+    EMAIL_CANCEL = "/emails/:id/cancel"
+    EMAIL_EVENTS = "/emails/:id/events"
+    EMAIL_TRACKING = "/emails/:id/tracking"
+    ENCRYPTION_KEYS = "/encryption/keys"
+    ENCRYPTION_KEYS_LOOKUP = "/encryption/keys/lookup"
+    FILE = "/files/:id"
+    FILES = "/files"
+    FILES_BATCH_DELETE = "/files/batch-delete"
+    FILES_STATS = "/files/stats"
+    FILE_CONTENT = "/files/:id/content"
+    FILE_LINK = "/files/:id/links/:linkId"
+    FILE_LINKS = "/files/:id/links"
+    FORM = "/forms/:id"
+    FORMS = "/forms"
+    FORMS_DESIGN = "/forms/design"
+    FORM_ANALYTICS = "/forms/:id/analytics"
+    FORM_DUPLICATE = "/forms/:id/duplicate"
+    FORM_PAUSE = "/forms/:id/pause"
+    FORM_PUBLISH = "/forms/:id/publish"
+    FORM_REDESIGN = "/forms/:id/redesign"
+    FORM_RESUME = "/forms/:id/resume"
+    FORM_STARTER = "/forms/starters/:slug"
+    FORM_STARTERS = "/forms/starters"
+    FORM_SUBMISSION = "/forms/:id/submissions/:submissionId"
+    FORM_SUBMISSIONS = "/forms/:id/submissions"
+    FORM_SUBMISSIONS_BATCH_REMOVE = "/forms/:id/submissions/batch-remove"
+    FORM_SUBMISSION_APPROVE = "/forms/:id/submissions/:submissionId/approve"
+    FORM_SUBMISSION_RESEND = "/forms/:id/submissions/:submissionId/resend"
+    IMPORT = "/imports/:id"
+    IMPORTS = "/imports"
+    IMPORT_CANCEL = "/imports/:id/cancel"
+    IMPORT_FAILURES = "/imports/:id/failures"
+    IMPORT_FILE_CHUNK = "/imports/:id/files/:file/chunks/:chunk"
+    IMPORT_START = "/imports/:id/start"
+    IMPORT_UPLOAD = "/imports/:id/upload"
+    KEY = "/keys/:id"
+    KEYS = "/keys"
+    KEYS_ACTIVITY = "/keys/activity"
+    KEYS_REQUESTS = "/keys/requests"
+    KEYS_STATS = "/keys/stats"
+    KEY_ACTIVITY = "/keys/:id/activity"
+    KEY_REQUESTS = "/keys/:id/requests"
+    KEY_REVOKE = "/keys/:id/revoke"
+    KEY_ROTATE = "/keys/:id/rotate"
+    KEY_SELF = "/keys/self"
+    KEY_SELF_ROTATE = "/keys/self/rotate"
+    LABEL = "/labels/:id"
+    LABELS = "/labels"
+    LABEL_COLORS = "/labels/colors"
+    LANGUAGES = "/languages"
+    MAILBOX_EXPORT = "/exports/:id"
+    MAILBOX_EXPORTS = "/exports"
+    MAILBOX_EXPORTS_PREVIEW = "/exports/preview"
+    MAILBOX_EXPORT_CONTENT = "/exports/:id/content"
+    MEMBER = "/members/:userId"
+    MEMBERS = "/members"
+    MEMBER_ADDRESS = "/members/:userId/addresses/:addressId"
+    MEMBER_ADDRESSES = "/members/:userId/addresses"
+    MEMBER_DOMAIN = "/members/:userId/domains/:domainId"
+    MEMBER_DOMAINS = "/members/:userId/domains"
+    MEMBER_INVITATION = "/members/invitations/:invitationId"
+    MEMBER_INVITATIONS = "/members/invitations"
+    MEMBER_INVITATION_RESEND = "/members/invitations/:invitationId/resend"
+    PING = "/ping"
+    PROVIDER_IMPORT = "/provider-imports/:id"
+    PROVIDER_IMPORTS = "/provider-imports"
+    PROVIDER_IMPORTS_INSPECT = "/provider-imports/inspect"
+    PROVIDER_IMPORT_CANCEL = "/provider-imports/:id/cancel"
+    ROLE = "/roles/:id"
+    ROLES = "/roles"
+    ROLE_PERMISSIONS = "/roles/permissions"
+    RULE = "/rules/:id"
+    RULES = "/rules"
+    RULES_REORDER = "/rules/reorder"
+    RULE_RUNS = "/rules/runs"
+    RULE_TEST = "/rules/:id/test"
+    SECURITY_STEP_UP = "/security/step-up"
+    SECURITY_STEP_UP_VERIFY = "/security/step-up/verify"
+    SENDER = "/senders/:email"
+    SENDER_RESEARCH = "/senders/:email/research"
+    SETTINGS = "/settings"
+    SUBSCRIBE_FORM = "/subscribe/:formId"
+    SUBSCRIPTIONS = "/subscriptions"
+    SUBSCRIPTION_DOMAINS = "/subscriptions/domains"
+    SUBSCRIPTION_DOMAIN_UNSUBSCRIBE = "/subscriptions/domains/:domain/unsubscribe"
+    SUBSCRIPTION_MOVE = "/subscriptions/:id/move"
+    SUBSCRIPTION_UNSUBSCRIBE = "/subscriptions/:id/unsubscribe"
+    SUPPORT = "/support"
+    SUPPRESSION = "/suppressions/:id"
+    SUPPRESSIONS = "/suppressions"
+    TEMPLATE = "/templates/:id"
+    TEMPLATES = "/templates"
+    TEMPLATES_DESIGN = "/templates/design"
+    TEMPLATE_ANALYTICS = "/templates/:id/analytics"
+    TEMPLATE_CONTENT = "/templates/:id/content"
+    TEMPLATE_DUPLICATE = "/templates/:id/duplicate"
+    TEMPLATE_FONTS = "/templates/fonts"
+    TEMPLATE_IMAGES = "/templates/images"
+    TEMPLATE_PREVIEW = "/templates/:id/preview"
+    TEMPLATE_REDESIGN = "/templates/:id/redesign"
+    TEMPLATE_RENDER = "/templates/render"
+    TEMPLATE_SEND = "/templates/:id/send"
+    TEMPLATE_SENDS = "/templates/:id/sends"
+    TEMPLATE_STARTER = "/templates/starters/:slug"
+    TEMPLATE_STARTERS = "/templates/starters"
+    TEMPLATE_VERSION = "/templates/:id/versions/:version"
+    TEMPLATE_VERSIONS = "/templates/:id/versions"
+    TEMPLATE_VERSION_RESTORE = "/templates/:id/versions/:version/restore"
+    TEMP_MAIL_DOMAINS = "/temp-mail/domains"
+    TEMP_MAIL_INBOX = "/temp-mail/inboxes/:id"
+    TEMP_MAIL_INBOXES = "/temp-mail/inboxes"
+    TEMP_MAIL_INBOX_EXTEND = "/temp-mail/inboxes/:id/extend"
+    TEMP_MAIL_MESSAGE = "/temp-mail/inboxes/:id/messages/:messageId"
+    TEMP_MAIL_MESSAGES = "/temp-mail/inboxes/:id/messages"
+    TEMP_MAIL_MESSAGE_ATTACHMENTS = "/temp-mail/inboxes/:id/messages/:messageId/attachments"
+    THREAD = "/threads/:id"
+    THREADS = "/threads"
+    THREADS_COUNTS = "/threads/counts"
+    THREAD_EVENT = "/threads/:id/event"
+    THREAD_MESSAGE_ATTACHMENTS = "/threads/:id/messages/:messageId/attachments"
+    THREAD_NOTE = "/threads/:id/notes/:noteId"
+    THREAD_NOTES = "/threads/:id/notes"
+    THREAD_NOTES_REORDER = "/threads/:id/notes/reorder"
+    THREAD_RESTORE = "/threads/:id/restore"
+    THREAD_SNOOZE = "/threads/:id/snooze"
+    THREAD_SUMMARY = "/threads/:id/summary"
+    THREAD_TRASH = "/threads/:id/trash"
+    THREAD_UNSNOOZE = "/threads/:id/unsnooze"
+    THREAD_UNSUBSCRIBE = "/threads/:id/unsubscribe"
+    TOOLS_BIMI = "/tools/bimi"
+    TOOLS_DELIVERABILITY = "/tools/deliverability"
+    TOOLS_DMARC = "/tools/dmarc"
+    TRACKED = "/tracking/:id"
+    TRACKED_CLICKS = "/tracking/:id/clicks"
+    TRACKED_OPENS = "/tracking/:id/opens"
+    TRACKING = "/tracking"
+    TRACKING_STATS = "/tracking/stats"
+    WEBHOOK = "/webhooks/:id"
+    WEBHOOKS = "/webhooks"
+    WEBHOOKS_ACTIVITY = "/webhooks/activity"
+    WEBHOOKS_DELIVERIES = "/webhooks/deliveries"
+    WEBHOOKS_EVENTS = "/webhooks/events"
+    WEBHOOKS_STATS = "/webhooks/stats"
+    WEBHOOK_ACTIVITY = "/webhooks/:id/activity"
+    WEBHOOK_DELIVERIES = "/webhooks/:id/deliveries"
+    WEBHOOK_DELIVERY = "/webhooks/:id/deliveries/:deliveryId"
+    WEBHOOK_DELIVERY_REPLAY = "/webhooks/:id/deliveries/:deliveryId/replay"
+    WEBHOOK_ROTATE_SECRET = "/webhooks/:id/rotate-secret"
+    WEBHOOK_TEST = "/webhooks/:id/test"
+    WORKSPACE = "/workspaces/:id"
+    WORKSPACES = "/workspaces"
+    WORKSPACES_ACTIVE = "/workspaces/active"
+  end
+end

data/lib/openemail/client.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenEmail
+  class Client
+    NAMESPACES = {
+      me: Resources::Me,
+      security: Resources::Security,
+      keys: Resources::Keys,
+      addresses: Resources::Addresses,
+      languages: Resources::Languages,
+      emails: Resources::Emails,
+      templates: Resources::Templates,
+      tracking: Resources::Tracking,
+      threads: Resources::Threads,
+      drafts: Resources::Drafts,
+      labels: Resources::Labels,
+      contacts: Resources::Contacts,
+      audiences: Resources::Audiences,
+      billing: Resources::Billing,
+      forms: Resources::Forms,
+      broadcasts: Resources::Broadcasts,
+      domains: Resources::Domains,
+      app_host: Resources::AppHost,
+      branding: Resources::Branding,
+      rules: Resources::Rules,
+      webhooks: Resources::Webhooks,
+      imports: Resources::Imports,
+      provider_imports: Resources::ProviderImports,
+      calendar: Resources::Calendar,
+      settings: Resources::Settings,
+      roles: Resources::Roles,
+      members: Resources::Members,
+      suppressions: Resources::Suppressions,
+      files: Resources::Files,
+      temp_mail: Resources::TempMail,
+      exports: Resources::Exports,
+      chats: Resources::Chats,
+      encryption: Resources::Encryption,
+      support: Resources::Support,
+      tools: Resources::Tools,
+      senders: Resources::Senders,
+      analytics: Resources::Analytics,
+      subscriptions: Resources::Subscriptions,
+      dns_connections: Resources::DnsConnections,
+      workspaces: Resources::Workspaces,
+      account: Resources::Account
+    }.freeze
+
+    attr_reader :mode, :raw, *NAMESPACES.keys
+
+    def initialize(key = nil, api_key: nil, access_token: nil, base_url: nil, adapter: nil, max_retries: nil,
+      timeout: nil, user_agent: nil, headers: nil, disable_update_notice: false)
+      raise ArgumentError, Defaults::MESSAGES[:KEY_TWICE] unless key.nil? || api_key.nil?
+
+      api_key = key if api_key.nil?
+      Credentials.assert_credential(api_key, access_token, required: true)
+
+      @raw = Transport.new(api_key:, access_token:, base_url:, adapter:, max_retries:, timeout:, user_agent:, headers:,
+        disable_update_notice:)
+      @mode = Credentials.mode_of(api_key)
+      NAMESPACES.each { |name, resource| instance_variable_set(:"@#{name}", resource.new(@raw)) }
+      freeze
+    end
+
+    def inspect
+      "#<#{self.class.name} mode=#{@mode.inspect} base_url=#{@raw.base_url.inspect}>"
+    end
+  end
+end