emailr 0.1.0

package/README.md

@@ -0,0 +1,689 @@
+# emailr
+
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *emailr* API.
+
+[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=emailr&utm_campaign=typescript)
+[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)
+
+
+<br /><br />
+> [!IMPORTANT]
+> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/hormo/emailr). Delete this section before > publishing to a package manager.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [emailr](#emailr)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+> [!TIP]
+> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
+
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add <UNSET>
+```
+
+### PNPM
+
+```bash
+pnpm add <UNSET>
+```
+
+### Bun
+
+```bash
+bun add <UNSET>
+```
+
+### Yarn
+
+```bash
+yarn add <UNSET>
+```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { Emailr } from "emailr";
+
+const emailr = new Emailr({
+  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await emailr.emails.send({
+    from: "sender@example.com",
+    to: "recipient@example.com",
+    subject: "Hello World",
+    html: "<h1>Hello</h1>",
+    text: "Hello",
+    templateId: "123e4567-e89b-12d3-a456-426614174000",
+    templateData: {
+      "name": "John",
+      "company": "Acme",
+    },
+    tags: {
+      "campaign": "welcome",
+      "source": "signup",
+    },
+    attachments: [
+      {
+        filename: "document.pdf",
+        content: "JVBERi0xLjQKJe...",
+        contentType: "application/pdf",
+      },
+    ],
+    replyTo: {
+      inReplyTo: "<message-id@domain.com>",
+      threadId: "123e4567-e89b-12d3-a456-426614174000",
+      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name         | Type | Scheme      | Environment Variable |
+| ------------ | ---- | ----------- | -------------------- |
+| `bearerAuth` | http | HTTP Bearer | `EMAILR_BEARER_AUTH` |
+
+To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { Emailr } from "emailr";
+
+const emailr = new Emailr({
+  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await emailr.emails.send({
+    from: "sender@example.com",
+    to: "recipient@example.com",
+    subject: "Hello World",
+    html: "<h1>Hello</h1>",
+    text: "Hello",
+    templateId: "123e4567-e89b-12d3-a456-426614174000",
+    templateData: {
+      "name": "John",
+      "company": "Acme",
+    },
+    tags: {
+      "campaign": "welcome",
+      "source": "signup",
+    },
+    attachments: [
+      {
+        filename: "document.pdf",
+        content: "JVBERi0xLjQKJe...",
+        contentType: "application/pdf",
+      },
+    ],
+    replyTo: {
+      inReplyTo: "<message-id@domain.com>",
+      threadId: "123e4567-e89b-12d3-a456-426614174000",
+      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [ApiKeys](docs/sdks/apikeys/README.md)
+
+* [create](docs/sdks/apikeys/README.md#create) - Create API key
+* [list](docs/sdks/apikeys/README.md#list) - List API keys
+* [revoke](docs/sdks/apikeys/README.md#revoke) - Revoke API key
+
+### [Broadcasts](docs/sdks/broadcasts/README.md)
+
+* [create](docs/sdks/broadcasts/README.md#create) - Create broadcast
+* [list](docs/sdks/broadcasts/README.md#list) - List broadcasts
+* [send](docs/sdks/broadcasts/README.md#send) - Send broadcast
+* [get](docs/sdks/broadcasts/README.md#get) - Get broadcast
+
+### [Contacts](docs/sdks/contacts/README.md)
+
+* [create](docs/sdks/contacts/README.md#create) - Create a contact
+* [list](docs/sdks/contacts/README.md#list) - List contacts
+* [bulkCreate](docs/sdks/contacts/README.md#bulkcreate) - Bulk create contacts
+* [get](docs/sdks/contacts/README.md#get) - Get contact
+* [update](docs/sdks/contacts/README.md#update) - Update contact
+* [delete](docs/sdks/contacts/README.md#delete) - Delete contact
+
+### [Domains](docs/sdks/domains/README.md)
+
+* [add](docs/sdks/domains/README.md#add) - Add domain
+* [list](docs/sdks/domains/README.md#list) - List domains
+* [verify](docs/sdks/domains/README.md#verify) - Verify domain
+* [getDnsStatus](docs/sdks/domains/README.md#getdnsstatus) - Get DNS status
+* [update](docs/sdks/domains/README.md#update) - Update domain
+* [delete](docs/sdks/domains/README.md#delete) - Delete domain
+
+### [Emails](docs/sdks/emails/README.md)
+
+* [send](docs/sdks/emails/README.md#send) - Send an email
+* [get](docs/sdks/emails/README.md#get) - Get email by ID
+* [list](docs/sdks/emails/README.md#list) - List emails
+
+### [Logs](docs/sdks/logs/README.md)
+
+* [list](docs/sdks/logs/README.md#list) - Get email logs
+
+### [Metrics](docs/sdks/metrics/README.md)
+
+* [getUsage](docs/sdks/metrics/README.md#getusage) - Get usage metrics
+* [getEmail](docs/sdks/metrics/README.md#getemail) - Get email metrics
+
+### [Segments](docs/sdks/segments/README.md)
+
+* [create](docs/sdks/segments/README.md#create) - Create segment
+* [list](docs/sdks/segments/README.md#list) - List segments
+* [addContact](docs/sdks/segments/README.md#addcontact) - Add contact to segment
+
+### [Settings](docs/sdks/settings/README.md)
+
+* [getOrganization](docs/sdks/settings/README.md#getorganization) - Get organization settings
+* [updateOrganization](docs/sdks/settings/README.md#updateorganization) - Update organization settings
+* [getTeam](docs/sdks/settings/README.md#getteam) - Get team members
+* [getUnsubscribe](docs/sdks/settings/README.md#getunsubscribe) - Get unsubscribe settings
+* [updateUnsubscribe](docs/sdks/settings/README.md#updateunsubscribe) - Update unsubscribe settings
+
+### [Templates](docs/sdks/templates/README.md)
+
+* [create](docs/sdks/templates/README.md#create) - Create a template
+* [list](docs/sdks/templates/README.md#list) - List templates
+* [get](docs/sdks/templates/README.md#get) - Get template
+* [update](docs/sdks/templates/README.md#update) - Update template
+* [delete](docs/sdks/templates/README.md#delete) - Delete template
+
+### [Webhooks](docs/sdks/webhooks/README.md)
+
+* [create](docs/sdks/webhooks/README.md#create) - Create webhook
+* [list](docs/sdks/webhooks/README.md#list) - List webhooks
+* [toggle](docs/sdks/webhooks/README.md#toggle) - Toggle webhook
+* [delete](docs/sdks/webhooks/README.md#delete) - Delete webhook
+* [getDeliveries](docs/sdks/webhooks/README.md#getdeliveries) - Get webhook deliveries
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`apiKeysCreate`](docs/sdks/apikeys/README.md#create) - Create API key
+- [`apiKeysList`](docs/sdks/apikeys/README.md#list) - List API keys
+- [`apiKeysRevoke`](docs/sdks/apikeys/README.md#revoke) - Revoke API key
+- [`broadcastsCreate`](docs/sdks/broadcasts/README.md#create) - Create broadcast
+- [`broadcastsGet`](docs/sdks/broadcasts/README.md#get) - Get broadcast
+- [`broadcastsList`](docs/sdks/broadcasts/README.md#list) - List broadcasts
+- [`broadcastsSend`](docs/sdks/broadcasts/README.md#send) - Send broadcast
+- [`contactsBulkCreate`](docs/sdks/contacts/README.md#bulkcreate) - Bulk create contacts
+- [`contactsCreate`](docs/sdks/contacts/README.md#create) - Create a contact
+- [`contactsDelete`](docs/sdks/contacts/README.md#delete) - Delete contact
+- [`contactsGet`](docs/sdks/contacts/README.md#get) - Get contact
+- [`contactsList`](docs/sdks/contacts/README.md#list) - List contacts
+- [`contactsUpdate`](docs/sdks/contacts/README.md#update) - Update contact
+- [`domainsAdd`](docs/sdks/domains/README.md#add) - Add domain
+- [`domainsDelete`](docs/sdks/domains/README.md#delete) - Delete domain
+- [`domainsGetDnsStatus`](docs/sdks/domains/README.md#getdnsstatus) - Get DNS status
+- [`domainsList`](docs/sdks/domains/README.md#list) - List domains
+- [`domainsUpdate`](docs/sdks/domains/README.md#update) - Update domain
+- [`domainsVerify`](docs/sdks/domains/README.md#verify) - Verify domain
+- [`emailsGet`](docs/sdks/emails/README.md#get) - Get email by ID
+- [`emailsList`](docs/sdks/emails/README.md#list) - List emails
+- [`emailsSend`](docs/sdks/emails/README.md#send) - Send an email
+- [`logsList`](docs/sdks/logs/README.md#list) - Get email logs
+- [`metricsGetEmail`](docs/sdks/metrics/README.md#getemail) - Get email metrics
+- [`metricsGetUsage`](docs/sdks/metrics/README.md#getusage) - Get usage metrics
+- [`segmentsAddContact`](docs/sdks/segments/README.md#addcontact) - Add contact to segment
+- [`segmentsCreate`](docs/sdks/segments/README.md#create) - Create segment
+- [`segmentsList`](docs/sdks/segments/README.md#list) - List segments
+- [`settingsGetOrganization`](docs/sdks/settings/README.md#getorganization) - Get organization settings
+- [`settingsGetTeam`](docs/sdks/settings/README.md#getteam) - Get team members
+- [`settingsGetUnsubscribe`](docs/sdks/settings/README.md#getunsubscribe) - Get unsubscribe settings
+- [`settingsUpdateOrganization`](docs/sdks/settings/README.md#updateorganization) - Update organization settings
+- [`settingsUpdateUnsubscribe`](docs/sdks/settings/README.md#updateunsubscribe) - Update unsubscribe settings
+- [`templatesCreate`](docs/sdks/templates/README.md#create) - Create a template
+- [`templatesDelete`](docs/sdks/templates/README.md#delete) - Delete template
+- [`templatesGet`](docs/sdks/templates/README.md#get) - Get template
+- [`templatesList`](docs/sdks/templates/README.md#list) - List templates
+- [`templatesUpdate`](docs/sdks/templates/README.md#update) - Update template
+- [`webhooksCreate`](docs/sdks/webhooks/README.md#create) - Create webhook
+- [`webhooksDelete`](docs/sdks/webhooks/README.md#delete) - Delete webhook
+- [`webhooksGetDeliveries`](docs/sdks/webhooks/README.md#getdeliveries) - Get webhook deliveries
+- [`webhooksList`](docs/sdks/webhooks/README.md#list) - List webhooks
+- [`webhooksToggle`](docs/sdks/webhooks/README.md#toggle) - Toggle webhook
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Emailr } from "emailr";
+
+const emailr = new Emailr({
+  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await emailr.emails.send({
+    from: "sender@example.com",
+    to: "recipient@example.com",
+    subject: "Hello World",
+    html: "<h1>Hello</h1>",
+    text: "Hello",
+    templateId: "123e4567-e89b-12d3-a456-426614174000",
+    templateData: {
+      "name": "John",
+      "company": "Acme",
+    },
+    tags: {
+      "campaign": "welcome",
+      "source": "signup",
+    },
+    attachments: [
+      {
+        filename: "document.pdf",
+        content: "JVBERi0xLjQKJe...",
+        contentType: "application/pdf",
+      },
+    ],
+    replyTo: {
+      inReplyTo: "<message-id@domain.com>",
+      threadId: "123e4567-e89b-12d3-a456-426614174000",
+      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
+    },
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { Emailr } from "emailr";
+
+const emailr = new Emailr({
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await emailr.emails.send({
+    from: "sender@example.com",
+    to: "recipient@example.com",
+    subject: "Hello World",
+    html: "<h1>Hello</h1>",
+    text: "Hello",
+    templateId: "123e4567-e89b-12d3-a456-426614174000",
+    templateData: {
+      "name": "John",
+      "company": "Acme",
+    },
+    tags: {
+      "campaign": "welcome",
+      "source": "signup",
+    },
+    attachments: [
+      {
+        filename: "document.pdf",
+        content: "JVBERi0xLjQKJe...",
+        contentType: "application/pdf",
+      },
+    ],
+    replyTo: {
+      inReplyTo: "<message-id@domain.com>",
+      threadId: "123e4567-e89b-12d3-a456-426614174000",
+      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+[`EmailrError`](./src/models/errors/emailrerror.ts) is the base class for all HTTP error responses. It has the following properties:
+
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
+
+### Example
+```typescript
+import { Emailr } from "emailr";
+import * as errors from "emailr/models/errors";
+
+const emailr = new Emailr({
+  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  try {
+    const result = await emailr.emails.send({
+      from: "sender@example.com",
+      to: "recipient@example.com",
+      subject: "Hello World",
+      html: "<h1>Hello</h1>",
+      text: "Hello",
+      templateId: "123e4567-e89b-12d3-a456-426614174000",
+      templateData: {
+        "name": "John",
+        "company": "Acme",
+      },
+      tags: {
+        "campaign": "welcome",
+        "source": "signup",
+      },
+      attachments: [
+        {
+          filename: "document.pdf",
+          content: "JVBERi0xLjQKJe...",
+          contentType: "application/pdf",
+        },
+      ],
+      replyTo: {
+        inReplyTo: "<message-id@domain.com>",
+        threadId: "123e4567-e89b-12d3-a456-426614174000",
+        parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
+      },
+    });
+
+    console.log(result);
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.EmailrError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.ErrorT) {
+        console.log(error.data$.error); // string
+        console.log(error.data$.code); // string
+        console.log(error.data$.details); // any
+      }
+    }
+  }
+}
+
+run();
+
+```
+
+### Error Classes
+**Primary errors:**
+* [`EmailrError`](./src/models/errors/emailrerror.ts): The base class for HTTP error responses.
+  * [`ErrorT`](./src/models/errors/errort.ts): Generic error.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`EmailrError`](./src/models/errors/emailrerror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### Override Server URL Per-Client
+
+The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { Emailr } from "emailr";
+
+const emailr = new Emailr({
+  serverURL: "https://api.emailr.dev",
+  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await emailr.emails.send({
+    from: "sender@example.com",
+    to: "recipient@example.com",
+    subject: "Hello World",
+    html: "<h1>Hello</h1>",
+    text: "Hello",
+    templateId: "123e4567-e89b-12d3-a456-426614174000",
+    templateData: {
+      "name": "John",
+      "company": "Acme",
+    },
+    tags: {
+      "campaign": "welcome",
+      "source": "signup",
+    },
+    attachments: [
+      {
+        filename: "document.pdf",
+        content: "JVBERi0xLjQKJe...",
+        contentType: "application/pdf",
+      },
+    ],
+    replyTo: {
+      inReplyTo: "<message-id@domain.com>",
+      threadId: "123e4567-e89b-12d3-a456-426614174000",
+      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { Emailr } from "emailr";
+import { HTTPClient } from "emailr/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new Emailr({ httpClient: httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { Emailr } from "emailr";
+
+const sdk = new Emailr({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `EMAILR_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=emailr&utm_campaign=typescript)