emailagent-sdk 0.1.0

package/README.md

@@ -0,0 +1,41 @@
+# emailagent-sdk (TypeScript)
+
+Official TypeScript SDK for EmailAgent.
+
+## Install
+
+```bash
+npm install emailagent-sdk@0.1.0
+```
+
+## Usage
+
+```ts
+import { EmailAgentClient } from 'emailagent-sdk';
+
+const client = new EmailAgentClient({
+  apiKey: process.env.EMAILAGENT_API_KEY!,
+  baseUrl: 'https://api.emailagent.dev'
+});
+
+const inboxes = await client.listInboxes();
+console.log(inboxes.data);
+
+const emails = await client.listEmails({ inboxId: '<inbox_uuid>' });
+console.log(emails.data);
+
+await client.updateEmailRead('<email_uuid>', true, {
+  idempotencyKey: 'mark-read-001'
+});
+```
+
+## Idempotency
+
+Pass `idempotencyKey` for mutating calls:
+
+```ts
+await client.createInbox(
+  { localPart: 'agent-1' },
+  { idempotencyKey: 'create-inbox-agent-1' }
+);
+```

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+export type HttpMethod = 'GET' | 'POST' | 'PATCH' | 'DELETE';
+export interface EmailAgentClientOptions {
+    baseUrl?: string;
+    apiKey: string;
+    fetchImpl?: typeof fetch;
+}
+export interface RequestOptions {
+    idempotencyKey?: string;
+}
+export interface ApiErrorBody {
+    error?: string;
+}
+export declare class EmailAgentApiError extends Error {
+    status: number;
+    body: ApiErrorBody | string | null;
+    constructor(status: number, body: ApiErrorBody | string | null);
+}
+export declare class EmailAgentClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly fetchImpl;
+    constructor(options: EmailAgentClientOptions);
+    private request;
+    listInboxes(): Promise<{
+        data: unknown[];
+    }>;
+    createInbox(payload: {
+        localPart: string;
+        displayName?: string;
+        domainName?: string;
+    }, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    updateInbox(id: string, payload: {
+        displayName: string;
+    }, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    deleteInbox(id: string, options?: RequestOptions): Promise<{
+        ok: true;
+    }>;
+    sendEmail(payload: {
+        inboxId: string;
+        to: string;
+        subject?: string;
+        text?: string;
+    }, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    listEmails(params?: {
+        inboxId?: string;
+    }): Promise<{
+        data: unknown[];
+    }>;
+    updateEmailRead(id: string, isRead: boolean, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    deleteEmail(id: string, options?: RequestOptions): Promise<{
+        ok: true;
+    }>;
+    listDomains(): Promise<{
+        data: unknown[];
+    }>;
+    createDomain(payload: {
+        name: string;
+    }, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    verifyDomain(id: string, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    deleteDomain(id: string, options?: RequestOptions): Promise<{
+        ok: true;
+    }>;
+    listApiKeys(): Promise<{
+        data: unknown[];
+    }>;
+    createApiKey(payload: {
+        name: string;
+        scopes?: string[] | string;
+    }, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    rotateApiKey(id: string, options?: RequestOptions): Promise<{
+        data: unknown;
+    }>;
+    revokeApiKey(id: string, options?: RequestOptions): Promise<{
+        ok: true;
+    }>;
+    getMetrics(): Promise<{
+        data: unknown;
+    }>;
+}

package/dist/index.js

@@ -0,0 +1,95 @@
+export class EmailAgentApiError extends Error {
+    status;
+    body;
+    constructor(status, body) {
+        const message = typeof body === 'object' && body?.error ? body.error : `EmailAgent API error (${status})`;
+        super(message);
+        this.name = 'EmailAgentApiError';
+        this.status = status;
+        this.body = body;
+    }
+}
+export class EmailAgentClient {
+    baseUrl;
+    apiKey;
+    fetchImpl;
+    constructor(options) {
+        this.baseUrl = (options.baseUrl ?? 'https://api.emailagent.dev').replace(/\/$/, '');
+        this.apiKey = options.apiKey;
+        this.fetchImpl = options.fetchImpl ?? fetch;
+    }
+    async request(method, path, body, options) {
+        const headers = {
+            Authorization: `Bearer ${this.apiKey}`
+        };
+        if (body !== undefined) {
+            headers['Content-Type'] = 'application/json';
+        }
+        if (options?.idempotencyKey) {
+            headers['Idempotency-Key'] = options.idempotencyKey;
+        }
+        const response = await this.fetchImpl(`${this.baseUrl}${path}`, {
+            method,
+            headers,
+            body: body === undefined ? undefined : JSON.stringify(body)
+        });
+        const text = await response.text();
+        const parsed = text ? JSON.parse(text) : null;
+        if (!response.ok) {
+            throw new EmailAgentApiError(response.status, parsed);
+        }
+        return parsed;
+    }
+    listInboxes() {
+        return this.request('GET', '/api/v1/inboxes');
+    }
+    createInbox(payload, options) {
+        return this.request('POST', '/api/v1/inboxes', payload, options);
+    }
+    updateInbox(id, payload, options) {
+        return this.request('PATCH', `/api/v1/inboxes/${id}`, payload, options);
+    }
+    deleteInbox(id, options) {
+        return this.request('DELETE', `/api/v1/inboxes/${id}`, undefined, options);
+    }
+    sendEmail(payload, options) {
+        return this.request('POST', '/api/v1/emails/send', payload, options);
+    }
+    listEmails(params) {
+        const query = params?.inboxId ? `?inboxId=${encodeURIComponent(params.inboxId)}` : '';
+        return this.request('GET', `/api/v1/emails${query}`);
+    }
+    updateEmailRead(id, isRead, options) {
+        return this.request('PATCH', `/api/v1/emails/${id}/read`, { isRead }, options);
+    }
+    deleteEmail(id, options) {
+        return this.request('DELETE', `/api/v1/emails/${id}`, undefined, options);
+    }
+    listDomains() {
+        return this.request('GET', '/api/v1/domains');
+    }
+    createDomain(payload, options) {
+        return this.request('POST', '/api/v1/domains', payload, options);
+    }
+    verifyDomain(id, options) {
+        return this.request('POST', `/api/v1/domains/${id}/verify`, undefined, options);
+    }
+    deleteDomain(id, options) {
+        return this.request('DELETE', `/api/v1/domains/${id}`, undefined, options);
+    }
+    listApiKeys() {
+        return this.request('GET', '/api/v1/api-keys');
+    }
+    createApiKey(payload, options) {
+        return this.request('POST', '/api/v1/api-keys', payload, options);
+    }
+    rotateApiKey(id, options) {
+        return this.request('POST', `/api/v1/api-keys/${id}/rotate`, undefined, options);
+    }
+    revokeApiKey(id, options) {
+        return this.request('POST', `/api/v1/api-keys/${id}/revoke`, undefined, options);
+    }
+    getMetrics() {
+        return this.request('GET', '/api/v1/metrics');
+    }
+}

package/generated/.openapi-generator/FILES

@@ -0,0 +1,41 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+package.json
+src/apis/APIKeysApi.ts
+src/apis/DomainsApi.ts
+src/apis/EmailsApi.ts
+src/apis/InboxesApi.ts
+src/apis/MetricsApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/ApiKeyCreated.ts
+src/models/ApiKeyCreatedResponse.ts
+src/models/ApiKeyListItem.ts
+src/models/ApiKeyListResponse.ts
+src/models/CreateApiKeyRequest.ts
+src/models/CreateApiKeyRequestScopes.ts
+src/models/CreateDomainRequest.ts
+src/models/CreateInboxRequest.ts
+src/models/Domain.ts
+src/models/DomainListResponse.ts
+src/models/DomainResponse.ts
+src/models/Email.ts
+src/models/EmailListResponse.ts
+src/models/EmailResponse.ts
+src/models/ErrorResponse.ts
+src/models/Inbox.ts
+src/models/InboxListResponse.ts
+src/models/InboxResponse.ts
+src/models/MetricsData.ts
+src/models/MetricsResponse.ts
+src/models/OkResponse.ts
+src/models/PlanLimits.ts
+src/models/SendEmailRequest.ts
+src/models/UpdateEmailReadRequest.ts
+src/models/UpdateInboxRequest.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.esm.json
+tsconfig.json

package/generated/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.14.0

package/generated/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/generated/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "emailagent-sdk",
+  "version": "0.1.0",
+  "description": "OpenAPI client for emailagent-sdk",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}

package/generated/src/apis/APIKeysApi.ts

@@ -0,0 +1,314 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EmailAgent API
+ * API for creating agent inboxes, sending emails, managing custom domains, managing API keys, and reading usage metrics.  Authentication uses API keys via `Authorization: Bearer <api_key>`.  For mutating endpoints, send an optional `Idempotency-Key` header. - Replaying the same key with the same payload returns the original response. - Reusing a key with a different payload returns `409`. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ApiKeyCreatedResponse,
+  ApiKeyListResponse,
+  CreateApiKeyRequest,
+  ErrorResponse,
+  OkResponse,
+} from '../models/index';
+import {
+    ApiKeyCreatedResponseFromJSON,
+    ApiKeyCreatedResponseToJSON,
+    ApiKeyListResponseFromJSON,
+    ApiKeyListResponseToJSON,
+    CreateApiKeyRequestFromJSON,
+    CreateApiKeyRequestToJSON,
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+    OkResponseFromJSON,
+    OkResponseToJSON,
+} from '../models/index';
+
+export interface CreateApiKeyOperationRequest {
+    createApiKeyRequest: CreateApiKeyRequest;
+    idempotencyKey?: string;
+}
+
+export interface RevokeApiKeyRequest {
+    id: string;
+    idempotencyKey?: string;
+}
+
+export interface RotateApiKeyRequest {
+    id: string;
+    idempotencyKey?: string;
+}
+
+/**
+ * APIKeysApi - interface
+ * 
+ * @export
+ * @interface APIKeysApiInterface
+ */
+export interface APIKeysApiInterface {
+    /**
+     * 
+     * @summary Create API key
+     * @param {CreateApiKeyRequest} createApiKeyRequest 
+     * @param {string} [idempotencyKey] Optional key for safe retries of mutating operations.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof APIKeysApiInterface
+     */
+    createApiKeyRaw(requestParameters: CreateApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyCreatedResponse>>;
+
+    /**
+     * Create API key
+     */
+    createApiKey(requestParameters: CreateApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyCreatedResponse>;
+
+    /**
+     * 
+     * @summary List API keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof APIKeysApiInterface
+     */
+    listApiKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyListResponse>>;
+
+    /**
+     * List API keys
+     */
+    listApiKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyListResponse>;
+
+    /**
+     * 
+     * @summary Revoke API key
+     * @param {string} id 
+     * @param {string} [idempotencyKey] Optional key for safe retries of mutating operations.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof APIKeysApiInterface
+     */
+    revokeApiKeyRaw(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
+
+    /**
+     * Revoke API key
+     */
+    revokeApiKey(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
+
+    /**
+     * 
+     * @summary Rotate API key (creates new key and revokes old key)
+     * @param {string} id 
+     * @param {string} [idempotencyKey] Optional key for safe retries of mutating operations.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof APIKeysApiInterface
+     */
+    rotateApiKeyRaw(requestParameters: RotateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyCreatedResponse>>;
+
+    /**
+     * Rotate API key (creates new key and revokes old key)
+     */
+    rotateApiKey(requestParameters: RotateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyCreatedResponse>;
+
+}
+
+/**
+ * 
+ */
+export class APIKeysApi extends runtime.BaseAPI implements APIKeysApiInterface {
+
+    /**
+     * Create API key
+     */
+    async createApiKeyRaw(requestParameters: CreateApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyCreatedResponse>> {
+        if (requestParameters['createApiKeyRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createApiKeyRequest',
+                'Required parameter "createApiKeyRequest" was null or undefined when calling createApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/api-keys`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateApiKeyRequestToJSON(requestParameters['createApiKeyRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyCreatedResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create API key
+     */
+    async createApiKey(requestParameters: CreateApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyCreatedResponse> {
+        const response = await this.createApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List API keys
+     */
+    async listApiKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyListResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/api-keys`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List API keys
+     */
+    async listApiKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyListResponse> {
+        const response = await this.listApiKeysRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Revoke API key
+     */
+    async revokeApiKeyRaw(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling revokeApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/api-keys/{id}/revoke`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Revoke API key
+     */
+    async revokeApiKey(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse> {
+        const response = await this.revokeApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Rotate API key (creates new key and revokes old key)
+     */
+    async rotateApiKeyRaw(requestParameters: RotateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyCreatedResponse>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling rotateApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/api-keys/{id}/rotate`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyCreatedResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Rotate API key (creates new key and revokes old key)
+     */
+    async rotateApiKey(requestParameters: RotateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyCreatedResponse> {
+        const response = await this.rotateApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}