emailr 1.0.1 → 1.2.0

package/dist/index.d.mts

@@ -170,6 +170,7 @@ interface Template {
     subject: string;
     html_content: string | null;
     text_content: string | null;
+    preview_html: string | null;
     variables: string[] | null;
     from_email: string | null;
     reply_to: string | null;
@@ -202,6 +203,12 @@ interface ListTemplatesParams {
     page?: number;
     limit?: number;
 }
+interface PushPreviewResponse {
+    preview_url: string;
+}
+interface FetchTemplateOptions {
+    preview?: boolean;
+}
 interface DnsRecord {
     type: 'TXT' | 'MX' | 'CNAME';
     name: string;
@@ -492,23 +499,6 @@ declare class EmailsResource {
      * Forward an email to other recipients
      */
     forward(data: ForwardEmailRequest): Promise<SendEmailResponse>;
-    /**
-     * Create an email forwarding rule
-     */
-    createForwardingRule(data: CreateForwardingRuleRequest): Promise<{
-        id: string;
-        success: boolean;
-    }>;
-    /**
-     * List all forwarding rules
-     */
-    listForwardingRules(): Promise<{
-        data: ForwardingRule[];
-    }>;
-    /**
-     * Delete a forwarding rule
-     */
-    deleteForwardingRule(id: string): Promise<SuccessResponse>;
 }
 
 declare class ContactsResource {
@@ -575,6 +565,30 @@ declare class TemplatesResource {
      * Duplicate a template
      */
     duplicate(id: string): Promise<Template>;
+    /**
+     * Push preview HTML for a template
+     *
+     * Uploads HTML content to the template's preview, which can be accessed
+     * publicly at /preview/{template_id} without authentication.
+     * This is useful for sharing previews with AI agents for review.
+     *
+     * @param id - The template ID
+     * @param htmlContent - The HTML content for the preview
+     * @returns The public preview URL
+     */
+    pushPreview(id: string, htmlContent: string): Promise<PushPreviewResponse>;
+    /**
+     * Fetch template HTML content
+     *
+     * Downloads the template's HTML content. By default, returns the published
+     * html_content. Use `{ preview: true }` to fetch the preview_html instead.
+     *
+     * @param id - The template ID
+     * @param options - Fetch options
+     * @param options.preview - If true, fetch preview_html instead of html_content
+     * @returns The HTML content as a string
+     */
+    fetch(id: string, options?: FetchTemplateOptions): Promise<string>;
 }
 
 declare class DomainsResource {
@@ -825,6 +839,28 @@ declare class MetricsResource {
     getEmailMetrics(): Promise<EmailMetrics>;
 }
 
+declare class ForwardingRulesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Create an email forwarding rule
+     */
+    create(data: CreateForwardingRuleRequest): Promise<{
+        id: string;
+        success: boolean;
+    }>;
+    /**
+     * List all forwarding rules
+     */
+    list(): Promise<{
+        data: ForwardingRule[];
+    }>;
+    /**
+     * Delete a forwarding rule
+     */
+    delete(id: string): Promise<SuccessResponse>;
+}
+
 /**
  * Configuration options for the Emailr client
  */
@@ -908,6 +944,10 @@ declare class Emailr {
      * Usage and email metrics
      */
     readonly metrics: MetricsResource;
+    /**
+     * Email forwarding rules
+     */
+    readonly forwardingRules: ForwardingRulesResource;
     private readonly http;
     constructor(config: EmailrConfig);
 }
@@ -955,4 +995,4 @@ declare class ValidationError extends EmailrError {
     constructor(message: string, details?: Record<string, unknown>, requestId?: string);
 }
 
-export { type AddDomainRequest, type ApiKey, type Attachment, AuthenticationError, type Broadcast, type BulkCreateContactsRequest, type BulkCreateContactsResponse, type Contact, type ContactListResponse, type CreateApiKeyRequest, type CreateBroadcastRequest, type CreateContactRequest, type CreateForwardingRuleRequest, type CreateSegmentRequest, type CreateTemplateRequest, type CreateWebhookRequest, type DnsRecord, type DnsVerificationStatus, type Domain, type DomainDnsRecords, type DomainVerificationStatus, type Email, Emailr, Emailr as EmailrClient, type EmailrConfig, EmailrError, type ForwardEmailRequest, type ForwardingRule, type ListApiKeysParams, type ListBroadcastsParams, type ListContactsParams, type ListEmailsParams, type ListSegmentsParams, type ListTemplatesParams, type ListWebhooksParams, NetworkError, NotFoundError, type PaginatedResponse, RateLimitError, type ReplyTo, type Segment, type SendBroadcastResponse, type SendEmailRequest, type SendEmailResponse, type SuccessResponse, type Template, type UpdateBroadcastRequest, type UpdateContactRequest, type UpdateDomainRequest, type UpdateSegmentRequest, type UpdateTemplateRequest, type UpdateWebhookRequest, ValidationError, type Webhook, type WebhookDelivery, type WebhookToggleResponse };
+export { type AddDomainRequest, type ApiKey, type Attachment, AuthenticationError, type Broadcast, type BulkCreateContactsRequest, type BulkCreateContactsResponse, type Contact, type ContactListResponse, type CreateApiKeyRequest, type CreateBroadcastRequest, type CreateContactRequest, type CreateForwardingRuleRequest, type CreateSegmentRequest, type CreateTemplateRequest, type CreateWebhookRequest, type DnsRecord, type DnsVerificationStatus, type Domain, type DomainDnsRecords, type DomainVerificationStatus, type Email, Emailr, Emailr as EmailrClient, type EmailrConfig, EmailrError, type FetchTemplateOptions, type ForwardEmailRequest, type ForwardingRule, type ListApiKeysParams, type ListBroadcastsParams, type ListContactsParams, type ListEmailsParams, type ListSegmentsParams, type ListTemplatesParams, type ListWebhooksParams, NetworkError, NotFoundError, type PaginatedResponse, type PushPreviewResponse, RateLimitError, type ReplyTo, type Segment, type SendBroadcastResponse, type SendEmailRequest, type SendEmailResponse, type SuccessResponse, type Template, type UpdateBroadcastRequest, type UpdateContactRequest, type UpdateDomainRequest, type UpdateSegmentRequest, type UpdateTemplateRequest, type UpdateWebhookRequest, ValidationError, type Webhook, type WebhookDelivery, type WebhookToggleResponse };

package/dist/index.d.ts

@@ -170,6 +170,7 @@ interface Template {
     subject: string;
     html_content: string | null;
     text_content: string | null;
+    preview_html: string | null;
     variables: string[] | null;
     from_email: string | null;
     reply_to: string | null;
@@ -202,6 +203,12 @@ interface ListTemplatesParams {
     page?: number;
     limit?: number;
 }
+interface PushPreviewResponse {
+    preview_url: string;
+}
+interface FetchTemplateOptions {
+    preview?: boolean;
+}
 interface DnsRecord {
     type: 'TXT' | 'MX' | 'CNAME';
     name: string;
@@ -492,23 +499,6 @@ declare class EmailsResource {
      * Forward an email to other recipients
      */
     forward(data: ForwardEmailRequest): Promise<SendEmailResponse>;
-    /**
-     * Create an email forwarding rule
-     */
-    createForwardingRule(data: CreateForwardingRuleRequest): Promise<{
-        id: string;
-        success: boolean;
-    }>;
-    /**
-     * List all forwarding rules
-     */
-    listForwardingRules(): Promise<{
-        data: ForwardingRule[];
-    }>;
-    /**
-     * Delete a forwarding rule
-     */
-    deleteForwardingRule(id: string): Promise<SuccessResponse>;
 }
 
 declare class ContactsResource {
@@ -575,6 +565,30 @@ declare class TemplatesResource {
      * Duplicate a template
      */
     duplicate(id: string): Promise<Template>;
+    /**
+     * Push preview HTML for a template
+     *
+     * Uploads HTML content to the template's preview, which can be accessed
+     * publicly at /preview/{template_id} without authentication.
+     * This is useful for sharing previews with AI agents for review.
+     *
+     * @param id - The template ID
+     * @param htmlContent - The HTML content for the preview
+     * @returns The public preview URL
+     */
+    pushPreview(id: string, htmlContent: string): Promise<PushPreviewResponse>;
+    /**
+     * Fetch template HTML content
+     *
+     * Downloads the template's HTML content. By default, returns the published
+     * html_content. Use `{ preview: true }` to fetch the preview_html instead.
+     *
+     * @param id - The template ID
+     * @param options - Fetch options
+     * @param options.preview - If true, fetch preview_html instead of html_content
+     * @returns The HTML content as a string
+     */
+    fetch(id: string, options?: FetchTemplateOptions): Promise<string>;
 }
 
 declare class DomainsResource {
@@ -825,6 +839,28 @@ declare class MetricsResource {
     getEmailMetrics(): Promise<EmailMetrics>;
 }
 
+declare class ForwardingRulesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Create an email forwarding rule
+     */
+    create(data: CreateForwardingRuleRequest): Promise<{
+        id: string;
+        success: boolean;
+    }>;
+    /**
+     * List all forwarding rules
+     */
+    list(): Promise<{
+        data: ForwardingRule[];
+    }>;
+    /**
+     * Delete a forwarding rule
+     */
+    delete(id: string): Promise<SuccessResponse>;
+}
+
 /**
  * Configuration options for the Emailr client
  */
@@ -908,6 +944,10 @@ declare class Emailr {
      * Usage and email metrics
      */
     readonly metrics: MetricsResource;
+    /**
+     * Email forwarding rules
+     */
+    readonly forwardingRules: ForwardingRulesResource;
     private readonly http;
     constructor(config: EmailrConfig);
 }
@@ -955,4 +995,4 @@ declare class ValidationError extends EmailrError {
     constructor(message: string, details?: Record<string, unknown>, requestId?: string);
 }
 
-export { type AddDomainRequest, type ApiKey, type Attachment, AuthenticationError, type Broadcast, type BulkCreateContactsRequest, type BulkCreateContactsResponse, type Contact, type ContactListResponse, type CreateApiKeyRequest, type CreateBroadcastRequest, type CreateContactRequest, type CreateForwardingRuleRequest, type CreateSegmentRequest, type CreateTemplateRequest, type CreateWebhookRequest, type DnsRecord, type DnsVerificationStatus, type Domain, type DomainDnsRecords, type DomainVerificationStatus, type Email, Emailr, Emailr as EmailrClient, type EmailrConfig, EmailrError, type ForwardEmailRequest, type ForwardingRule, type ListApiKeysParams, type ListBroadcastsParams, type ListContactsParams, type ListEmailsParams, type ListSegmentsParams, type ListTemplatesParams, type ListWebhooksParams, NetworkError, NotFoundError, type PaginatedResponse, RateLimitError, type ReplyTo, type Segment, type SendBroadcastResponse, type SendEmailRequest, type SendEmailResponse, type SuccessResponse, type Template, type UpdateBroadcastRequest, type UpdateContactRequest, type UpdateDomainRequest, type UpdateSegmentRequest, type UpdateTemplateRequest, type UpdateWebhookRequest, ValidationError, type Webhook, type WebhookDelivery, type WebhookToggleResponse };
+export { type AddDomainRequest, type ApiKey, type Attachment, AuthenticationError, type Broadcast, type BulkCreateContactsRequest, type BulkCreateContactsResponse, type Contact, type ContactListResponse, type CreateApiKeyRequest, type CreateBroadcastRequest, type CreateContactRequest, type CreateForwardingRuleRequest, type CreateSegmentRequest, type CreateTemplateRequest, type CreateWebhookRequest, type DnsRecord, type DnsVerificationStatus, type Domain, type DomainDnsRecords, type DomainVerificationStatus, type Email, Emailr, Emailr as EmailrClient, type EmailrConfig, EmailrError, type FetchTemplateOptions, type ForwardEmailRequest, type ForwardingRule, type ListApiKeysParams, type ListBroadcastsParams, type ListContactsParams, type ListEmailsParams, type ListSegmentsParams, type ListTemplatesParams, type ListWebhooksParams, NetworkError, NotFoundError, type PaginatedResponse, type PushPreviewResponse, RateLimitError, type ReplyTo, type Segment, type SendBroadcastResponse, type SendEmailRequest, type SendEmailResponse, type SuccessResponse, type Template, type UpdateBroadcastRequest, type UpdateContactRequest, type UpdateDomainRequest, type UpdateSegmentRequest, type UpdateTemplateRequest, type UpdateWebhookRequest, ValidationError, type Webhook, type WebhookDelivery, type WebhookToggleResponse };

package/dist/index.js

@@ -210,24 +210,6 @@ var EmailsResource = class {
   async forward(data) {
     return this.http.post("/v1/emails/forward", data);
   }
-  /**
-   * Create an email forwarding rule
-   */
-  async createForwardingRule(data) {
-    return this.http.post("/v1/emails/forwarding-rules", data);
-  }
-  /**
-   * List all forwarding rules
-   */
-  async listForwardingRules() {
-    return this.http.get("/v1/emails/forwarding-rules");
-  }
-  /**
-   * Delete a forwarding rule
-   */
-  async deleteForwardingRule(id) {
-    return this.http.delete(`/v1/emails/forwarding-rules/${id}`);
-  }
 };
 
 // src/resources/contacts.ts
@@ -330,6 +312,40 @@ var TemplatesResource = class {
   async duplicate(id) {
     return this.http.post(`/v1/templates/${id}/duplicate`);
   }
+  /**
+   * Push preview HTML for a template
+   * 
+   * Uploads HTML content to the template's preview, which can be accessed
+   * publicly at /preview/{template_id} without authentication.
+   * This is useful for sharing previews with AI agents for review.
+   * 
+   * @param id - The template ID
+   * @param htmlContent - The HTML content for the preview
+   * @returns The public preview URL
+   */
+  async pushPreview(id, htmlContent) {
+    return this.http.put(`/v1/templates/${id}/preview`, {
+      html_content: htmlContent
+    });
+  }
+  /**
+   * Fetch template HTML content
+   * 
+   * Downloads the template's HTML content. By default, returns the published
+   * html_content. Use `{ preview: true }` to fetch the preview_html instead.
+   * 
+   * @param id - The template ID
+   * @param options - Fetch options
+   * @param options.preview - If true, fetch preview_html instead of html_content
+   * @returns The HTML content as a string
+   */
+  async fetch(id, options) {
+    const template = await this.get(id);
+    if (options?.preview) {
+      return template.preview_html ?? "";
+    }
+    return template.html_content ?? "";
+  }
 };
 
 // src/resources/domains.ts
@@ -663,6 +679,31 @@ var MetricsResource = class {
   }
 };
 
+// src/resources/forwarding-rules.ts
+var ForwardingRulesResource = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Create an email forwarding rule
+   */
+  async create(data) {
+    return this.http.post("/v1/forwarding-rules", data);
+  }
+  /**
+   * List all forwarding rules
+   */
+  async list() {
+    return this.http.get("/v1/forwarding-rules");
+  }
+  /**
+   * Delete a forwarding rule
+   */
+  async delete(id) {
+    return this.http.delete(`/v1/forwarding-rules/${id}`);
+  }
+};
+
 // src/client.ts
 var Emailr = class {
   constructor(config) {
@@ -685,6 +726,7 @@ var Emailr = class {
     this.smtp = new SmtpResource(this.http);
     this.settings = new SettingsResource(this.http);
     this.metrics = new MetricsResource(this.http);
+    this.forwardingRules = new ForwardingRulesResource(this.http);
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -177,24 +177,6 @@ var EmailsResource = class {
   async forward(data) {
     return this.http.post("/v1/emails/forward", data);
   }
-  /**
-   * Create an email forwarding rule
-   */
-  async createForwardingRule(data) {
-    return this.http.post("/v1/emails/forwarding-rules", data);
-  }
-  /**
-   * List all forwarding rules
-   */
-  async listForwardingRules() {
-    return this.http.get("/v1/emails/forwarding-rules");
-  }
-  /**
-   * Delete a forwarding rule
-   */
-  async deleteForwardingRule(id) {
-    return this.http.delete(`/v1/emails/forwarding-rules/${id}`);
-  }
 };
 
 // src/resources/contacts.ts
@@ -297,6 +279,40 @@ var TemplatesResource = class {
   async duplicate(id) {
     return this.http.post(`/v1/templates/${id}/duplicate`);
   }
+  /**
+   * Push preview HTML for a template
+   * 
+   * Uploads HTML content to the template's preview, which can be accessed
+   * publicly at /preview/{template_id} without authentication.
+   * This is useful for sharing previews with AI agents for review.
+   * 
+   * @param id - The template ID
+   * @param htmlContent - The HTML content for the preview
+   * @returns The public preview URL
+   */
+  async pushPreview(id, htmlContent) {
+    return this.http.put(`/v1/templates/${id}/preview`, {
+      html_content: htmlContent
+    });
+  }
+  /**
+   * Fetch template HTML content
+   * 
+   * Downloads the template's HTML content. By default, returns the published
+   * html_content. Use `{ preview: true }` to fetch the preview_html instead.
+   * 
+   * @param id - The template ID
+   * @param options - Fetch options
+   * @param options.preview - If true, fetch preview_html instead of html_content
+   * @returns The HTML content as a string
+   */
+  async fetch(id, options) {
+    const template = await this.get(id);
+    if (options?.preview) {
+      return template.preview_html ?? "";
+    }
+    return template.html_content ?? "";
+  }
 };
 
 // src/resources/domains.ts
@@ -630,6 +646,31 @@ var MetricsResource = class {
   }
 };
 
+// src/resources/forwarding-rules.ts
+var ForwardingRulesResource = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Create an email forwarding rule
+   */
+  async create(data) {
+    return this.http.post("/v1/forwarding-rules", data);
+  }
+  /**
+   * List all forwarding rules
+   */
+  async list() {
+    return this.http.get("/v1/forwarding-rules");
+  }
+  /**
+   * Delete a forwarding rule
+   */
+  async delete(id) {
+    return this.http.delete(`/v1/forwarding-rules/${id}`);
+  }
+};
+
 // src/client.ts
 var Emailr = class {
   constructor(config) {
@@ -652,6 +693,7 @@ var Emailr = class {
     this.smtp = new SmtpResource(this.http);
     this.settings = new SettingsResource(this.http);
     this.metrics = new MetricsResource(this.http);
+    this.forwardingRules = new ForwardingRulesResource(this.http);
   }
 };
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emailr",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Official Emailr API SDK for TypeScript/JavaScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -15,6 +15,11 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
   "keywords": [
     "emailr",
     "email",
@@ -31,10 +36,5 @@
   },
   "engines": {
     "node": ">=18.0.0"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
-    "test": "vitest run",
-    "typecheck": "tsc --noEmit"
   }
-}
+}