supersendtx 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+type ApiErrorCode = 'validation_error' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'plan_limit' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited' | 'upstream_error' | 'not_configured' | 'internal_error';
 type SendEmailParams = {
     from: string | {
         email: string;
@@ -11,6 +12,8 @@ type SendEmailParams = {
     reply_to?: string;
     cc?: string | string[];
     bcc?: string | string[];
+    /** Optional Idempotency-Key (24h TTL). */
+    idempotencyKey?: string;
 };
 type SendEmailResult = {
     id: string;
@@ -31,6 +34,42 @@ type EmailListItem = {
 };
 type ListEmailsParams = {
     limit?: number;
+    cursor?: string;
+};
+type ListEmailsResult = {
+    emails: EmailListItem[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type ApiKeyScope = 'full' | 'sending';
+type ApiKey = {
+    id: string;
+    name: string;
+    scope: ApiKeyScope;
+    prefix: string;
+    created_at: string;
+    last_used_at: string | null;
+};
+type ListApiKeysParams = {
+    limit?: number;
+    cursor?: string;
+};
+type ListApiKeysResult = {
+    data: ApiKey[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type CreateApiKeyParams = {
+    name?: string;
+    scope?: ApiKeyScope;
+};
+type CreateApiKeyResult = {
+    id: string;
+    name: string;
+    scope: ApiKeyScope;
+    prefix: string;
+    token: string;
+    created_at: string;
 };
 type WebhookEventType = 'email.delivered' | 'email.bounced';
 type WebhookEndpoint = {
@@ -111,14 +150,21 @@ type ApiErrorBody = {
     error?: string | {
         message?: string;
         details?: unknown;
+        code?: string;
+        upgrade_url?: string;
     };
 };
 
 declare class DomainsResource {
     private readonly client;
     constructor(client: SuperSendTX);
-    list(): Promise<{
+    list(params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
         domains: Domain[];
+        has_more: boolean;
+        next_cursor: string | null;
     }>;
     get(idOrName: string): Promise<{
         domain: Domain;
@@ -129,6 +175,13 @@ declare class DomainsResource {
     delete(idOrName: string): Promise<{
         ok: boolean;
     }>;
+    /**
+     * Apply DNS using a Cloudflare token stored in the SuperSend TX dashboard
+     * (Settings → Integrations).
+     */
+    apply(idOrName: string, options?: {
+        provider?: 'cloudflare';
+    }): Promise<ApplyDnsResult$1>;
     /**
      * Fetch SuperSend TX DNS records, then write them at Cloudflare or GoDaddy
      * using the caller's provider credentials (never sent to SuperSend TX).
@@ -139,17 +192,33 @@ declare class DomainsResource {
 declare class EmailsResource {
     private readonly client;
     constructor(client: SuperSendTX);
-    list(params?: ListEmailsParams): Promise<{
-        emails: EmailListItem[];
+    list(params?: ListEmailsParams): Promise<ListEmailsResult>;
+    get(id: string): Promise<{
+        email: EmailListItem;
     }>;
     send(params: SendEmailParams): Promise<SendEmailResult>;
 }
 
+declare class KeysResource {
+    private readonly client;
+    constructor(client: SuperSendTX);
+    list(params?: ListApiKeysParams): Promise<ListApiKeysResult>;
+    create(params?: CreateApiKeyParams): Promise<CreateApiKeyResult>;
+    remove(id: string): Promise<{
+        ok: boolean;
+    }>;
+}
+
 declare class WebhooksResource {
     private readonly client;
     constructor(client: SuperSendTX);
-    list(): Promise<{
+    list(params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
         webhooks: WebhookEndpoint[];
+        has_more: boolean;
+        next_cursor: string | null;
     }>;
     create(params: CreateWebhookParams): Promise<WebhookEndpointWithSecret>;
     delete(id: string): Promise<{
@@ -164,6 +233,7 @@ declare class SuperSendTX {
     readonly domains: DomainsResource;
     readonly emails: EmailsResource;
     readonly webhooks: WebhooksResource;
+    readonly apiKeys: KeysResource;
     constructor(apiKey: string, options?: SuperSendTXOptions);
     get baseUrl(): string;
     get fetchImpl(): typeof fetch;
@@ -173,7 +243,12 @@ declare class SuperSendTX {
 declare class SuperSendTXError extends Error {
     readonly status: number;
     readonly details?: unknown;
-    constructor(message: string, status: number, details?: unknown);
+    readonly code?: string;
+    readonly upgradeUrl?: string;
+    constructor(message: string, status: number, details?: unknown, options?: {
+        code?: string;
+        upgradeUrl?: string;
+    });
     static fromResponse(status: number, body: ApiErrorBody): SuperSendTXError;
 }
 
@@ -207,4 +282,4 @@ declare function applyDnsRecords(input: {
     fetchImpl?: typeof fetch;
 }): Promise<ApplyDnsResult>;
 
-export { type ApplyDnsParams, type ApplyDnsRecordResult$1 as ApplyDnsRecordResult, type ApplyDnsResult$1 as ApplyDnsResult, type CreateDomainParams, type CreateDomainResult, type CreateWebhookParams, DEFAULT_API_BASE_URL, type DnsProviderName$1 as DnsProviderName, type DnsRecord, type Domain, type DomainStatus, type EmailListItem, type ListEmailsParams, type SendEmailParams, type SendEmailResult, SuperSendTX, SuperSendTXError, type SuperSendTXOptions, type VerifyDomainResult, type WebhookEndpoint, type WebhookEndpointWithSecret, type WebhookEventType, applyDnsRecords, mergeSpfInclude };
+export { type ApiErrorCode, type ApiKey, type ApiKeyScope, type ApplyDnsParams, type ApplyDnsRecordResult$1 as ApplyDnsRecordResult, type ApplyDnsResult$1 as ApplyDnsResult, type CreateApiKeyParams, type CreateApiKeyResult, type CreateDomainParams, type CreateDomainResult, type CreateWebhookParams, DEFAULT_API_BASE_URL, type DnsProviderName$1 as DnsProviderName, type DnsRecord, type Domain, type DomainStatus, type EmailListItem, type ListApiKeysParams, type ListApiKeysResult, type ListEmailsParams, type ListEmailsResult, type SendEmailParams, type SendEmailResult, SuperSendTX, SuperSendTXError, type SuperSendTXOptions, type VerifyDomainResult, type WebhookEndpoint, type WebhookEndpointWithSecret, type WebhookEventType, applyDnsRecords, mergeSpfInclude };

package/dist/index.js

@@ -1,16 +1,20 @@
 // src/errors.ts
 var SuperSendTXError = class _SuperSendTXError extends Error {
-  constructor(message, status, details) {
+  constructor(message, status, details, options) {
     super(message);
     this.name = "SuperSendTXError";
     this.status = status;
     this.details = details;
+    this.code = options?.code;
+    this.upgradeUrl = options?.upgradeUrl;
   }
   static fromResponse(status, body) {
     const err = body.error;
     const message = typeof err === "string" ? err : err?.message || `Request failed with status ${status}`;
     const details = typeof err === "object" && err ? err.details : void 0;
-    return new _SuperSendTXError(message, status, details);
+    const code = typeof err === "object" && err && "code" in err ? String(err.code) : void 0;
+    const upgradeUrl = typeof err === "object" && err && "upgrade_url" in err ? String(err.upgrade_url) : void 0;
+    return new _SuperSendTXError(message, status, details, { code, upgradeUrl });
   }
 };
 
@@ -337,8 +341,12 @@ var DomainsResource = class {
   constructor(client) {
     this.client = client;
   }
-  async list() {
-    return this.client.request("/domains", { method: "GET" });
+  async list(params = {}) {
+    const search = new URLSearchParams();
+    if (params.limit != null) search.set("limit", String(params.limit));
+    if (params.cursor) search.set("cursor", params.cursor);
+    const query = search.toString();
+    return this.client.request(`/domains${query ? `?${query}` : ""}`, { method: "GET" });
   }
   async get(idOrName) {
     return this.client.request(`/domains/${encodeURIComponent(idOrName)}`, { method: "GET" });
@@ -360,6 +368,19 @@ var DomainsResource = class {
       method: "DELETE"
     });
   }
+  /**
+   * Apply DNS using a Cloudflare token stored in the SuperSend TX dashboard
+   * (Settings → Integrations).
+   */
+  async apply(idOrName, options = {}) {
+    return this.client.request(`/domains/${encodeURIComponent(idOrName)}`, {
+      method: "POST",
+      body: JSON.stringify({
+        action: "apply",
+        provider: options.provider || "cloudflare"
+      })
+    });
+  }
   /**
    * Fetch SuperSend TX DNS records, then write them at Cloudflare or GoDaddy
    * using the caller's provider credentials (never sent to SuperSend TX).
@@ -387,8 +408,16 @@ var EmailsResource = class {
     this.client = client;
   }
   async list(params = {}) {
-    const query = params.limit ? `?limit=${params.limit}` : "";
-    return this.client.request(`/emails${query}`, {
+    const search = new URLSearchParams();
+    if (params.limit != null) search.set("limit", String(params.limit));
+    if (params.cursor) search.set("cursor", params.cursor);
+    const query = search.toString();
+    return this.client.request(`/emails${query ? `?${query}` : ""}`, {
+      method: "GET"
+    });
+  }
+  async get(id) {
+    return this.client.request(`/emails/${encodeURIComponent(id)}`, {
       method: "GET"
     });
   }
@@ -404,20 +433,59 @@ var EmailsResource = class {
     if (replyTo) payload.reply_to = replyTo;
     if (params.cc) payload.cc = params.cc;
     if (params.bcc) payload.bcc = params.bcc;
+    const headers = {};
+    if (params.idempotencyKey) {
+      headers["Idempotency-Key"] = params.idempotencyKey;
+    }
     return this.client.request("/emails", {
       method: "POST",
+      headers,
       body: JSON.stringify(payload)
     });
   }
 };
 
+// src/keys.ts
+var KeysResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list(params = {}) {
+    const search = new URLSearchParams();
+    if (params.limit != null) search.set("limit", String(params.limit));
+    if (params.cursor) search.set("cursor", params.cursor);
+    const query = search.toString();
+    return this.client.request(`/api-keys${query ? `?${query}` : ""}`, {
+      method: "GET"
+    });
+  }
+  async create(params = {}) {
+    return this.client.request("/api-keys", {
+      method: "POST",
+      body: JSON.stringify({
+        ...params.name ? { name: params.name } : {},
+        ...params.scope ? { scope: params.scope } : {}
+      })
+    });
+  }
+  async remove(id) {
+    return this.client.request(`/api-keys/${encodeURIComponent(id)}`, {
+      method: "DELETE"
+    });
+  }
+};
+
 // src/webhooks.ts
 var WebhooksResource = class {
   constructor(client) {
     this.client = client;
   }
-  async list() {
-    return this.client.request("/webhooks", { method: "GET" });
+  async list(params = {}) {
+    const search = new URLSearchParams();
+    if (params.limit != null) search.set("limit", String(params.limit));
+    if (params.cursor) search.set("cursor", params.cursor);
+    const query = search.toString();
+    return this.client.request(`/webhooks${query ? `?${query}` : ""}`, { method: "GET" });
   }
   async create(params) {
     return this.client.request("/webhooks", {
@@ -442,6 +510,7 @@ var SuperSendTX = class {
     this.domains = new DomainsResource(this);
     this.emails = new EmailsResource(this);
     this.webhooks = new WebhooksResource(this);
+    this.apiKeys = new KeysResource(this);
   }
   get baseUrl() {
     return (this.options.baseUrl || DEFAULT_API_BASE_URL).replace(/\/$/, "");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supersendtx",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "SuperSend TX transactional email API client",
   "license": "MIT",
   "type": "module",
@@ -12,7 +12,9 @@
       "import": "./dist/index.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Super-Send/superTX-app.git",