emailr 1.1.0 → 1.3.0

package/dist/index.d.mts

@@ -128,6 +128,7 @@ interface Contact {
     metadata: Record<string, unknown> | null;
     subscribed: boolean;
     unsubscribed_at: string | null;
+    tags?: string[];
     created_at: string;
     updated_at: string;
 }
@@ -137,6 +138,7 @@ interface CreateContactRequest {
     last_name?: string;
     subscribed?: boolean;
     metadata?: Record<string, unknown>;
+    tags?: string[];
 }
 interface UpdateContactRequest {
     email?: string;
@@ -144,11 +146,13 @@ interface UpdateContactRequest {
     last_name?: string;
     subscribed?: boolean;
     metadata?: Record<string, unknown>;
+    tags?: string[];
 }
 interface ListContactsParams {
     limit?: number;
     offset?: number;
     subscribed?: boolean;
+    tags?: string;
 }
 interface ContactListResponse {
     contacts: Contact[];
@@ -170,7 +174,9 @@ interface Template {
     subject: string;
     html_content: string | null;
     text_content: string | null;
+    preview_html: string | null;
     variables: string[] | null;
+    tags?: string[];
     from_email: string | null;
     reply_to: string | null;
     preview_text: string | null;
@@ -184,6 +190,7 @@ interface CreateTemplateRequest {
     html_content?: string;
     text_content?: string;
     variables?: string[];
+    tags?: string[];
     from_email?: string;
     reply_to?: string;
     preview_text?: string;
@@ -194,6 +201,7 @@ interface UpdateTemplateRequest {
     html_content?: string;
     text_content?: string;
     variables?: string[];
+    tags?: string[];
     from_email?: string;
     reply_to?: string;
     preview_text?: string;
@@ -201,6 +209,13 @@ interface UpdateTemplateRequest {
 interface ListTemplatesParams {
     page?: number;
     limit?: number;
+    tags?: string;
+}
+interface PushPreviewResponse {
+    preview_url: string;
+}
+interface FetchTemplateOptions {
+    preview?: boolean;
 }
 interface DnsRecord {
     type: 'TXT' | 'MX' | 'CNAME';
@@ -314,6 +329,7 @@ interface Broadcast {
     scheduled_at: string | null;
     started_at: string | null;
     completed_at: string | null;
+    tags?: string[];
     created_by: string | null;
     created_at: string;
 }
@@ -326,6 +342,7 @@ interface CreateBroadcastRequest {
     html_content?: string;
     text_content?: string;
     scheduled_at?: string;
+    tags?: string[];
 }
 interface UpdateBroadcastRequest {
     name?: string;
@@ -336,6 +353,7 @@ interface UpdateBroadcastRequest {
     html_content?: string;
     text_content?: string;
     scheduled_at?: string;
+    tags?: string[];
 }
 interface SendBroadcastResponse {
     success: boolean;
@@ -346,6 +364,7 @@ interface ListBroadcastsParams {
     page?: number;
     limit?: number;
     status?: string;
+    tags?: string;
 }
 interface Segment {
     id: string;
@@ -353,6 +372,7 @@ interface Segment {
     name: string;
     description: string | null;
     conditions: Record<string, unknown>;
+    tags?: string[];
     created_by: string | null;
     created_at: string;
     updated_at: string;
@@ -361,15 +381,18 @@ interface CreateSegmentRequest {
     name: string;
     description?: string;
     conditions: Record<string, unknown>;
+    tags?: string[];
 }
 interface UpdateSegmentRequest {
     name?: string;
     description?: string;
     conditions?: Record<string, unknown>;
+    tags?: string[];
 }
 interface ListSegmentsParams {
     page?: number;
     limit?: number;
+    tags?: string;
 }
 interface ApiKey {
     id: string;
@@ -558,6 +581,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 {
@@ -964,4 +1011,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

@@ -128,6 +128,7 @@ interface Contact {
     metadata: Record<string, unknown> | null;
     subscribed: boolean;
     unsubscribed_at: string | null;
+    tags?: string[];
     created_at: string;
     updated_at: string;
 }
@@ -137,6 +138,7 @@ interface CreateContactRequest {
     last_name?: string;
     subscribed?: boolean;
     metadata?: Record<string, unknown>;
+    tags?: string[];
 }
 interface UpdateContactRequest {
     email?: string;
@@ -144,11 +146,13 @@ interface UpdateContactRequest {
     last_name?: string;
     subscribed?: boolean;
     metadata?: Record<string, unknown>;
+    tags?: string[];
 }
 interface ListContactsParams {
     limit?: number;
     offset?: number;
     subscribed?: boolean;
+    tags?: string;
 }
 interface ContactListResponse {
     contacts: Contact[];
@@ -170,7 +174,9 @@ interface Template {
     subject: string;
     html_content: string | null;
     text_content: string | null;
+    preview_html: string | null;
     variables: string[] | null;
+    tags?: string[];
     from_email: string | null;
     reply_to: string | null;
     preview_text: string | null;
@@ -184,6 +190,7 @@ interface CreateTemplateRequest {
     html_content?: string;
     text_content?: string;
     variables?: string[];
+    tags?: string[];
     from_email?: string;
     reply_to?: string;
     preview_text?: string;
@@ -194,6 +201,7 @@ interface UpdateTemplateRequest {
     html_content?: string;
     text_content?: string;
     variables?: string[];
+    tags?: string[];
     from_email?: string;
     reply_to?: string;
     preview_text?: string;
@@ -201,6 +209,13 @@ interface UpdateTemplateRequest {
 interface ListTemplatesParams {
     page?: number;
     limit?: number;
+    tags?: string;
+}
+interface PushPreviewResponse {
+    preview_url: string;
+}
+interface FetchTemplateOptions {
+    preview?: boolean;
 }
 interface DnsRecord {
     type: 'TXT' | 'MX' | 'CNAME';
@@ -314,6 +329,7 @@ interface Broadcast {
     scheduled_at: string | null;
     started_at: string | null;
     completed_at: string | null;
+    tags?: string[];
     created_by: string | null;
     created_at: string;
 }
@@ -326,6 +342,7 @@ interface CreateBroadcastRequest {
     html_content?: string;
     text_content?: string;
     scheduled_at?: string;
+    tags?: string[];
 }
 interface UpdateBroadcastRequest {
     name?: string;
@@ -336,6 +353,7 @@ interface UpdateBroadcastRequest {
     html_content?: string;
     text_content?: string;
     scheduled_at?: string;
+    tags?: string[];
 }
 interface SendBroadcastResponse {
     success: boolean;
@@ -346,6 +364,7 @@ interface ListBroadcastsParams {
     page?: number;
     limit?: number;
     status?: string;
+    tags?: string;
 }
 interface Segment {
     id: string;
@@ -353,6 +372,7 @@ interface Segment {
     name: string;
     description: string | null;
     conditions: Record<string, unknown>;
+    tags?: string[];
     created_by: string | null;
     created_at: string;
     updated_at: string;
@@ -361,15 +381,18 @@ interface CreateSegmentRequest {
     name: string;
     description?: string;
     conditions: Record<string, unknown>;
+    tags?: string[];
 }
 interface UpdateSegmentRequest {
     name?: string;
     description?: string;
     conditions?: Record<string, unknown>;
+    tags?: string[];
 }
 interface ListSegmentsParams {
     page?: number;
     limit?: number;
+    tags?: string;
 }
 interface ApiKey {
     id: string;
@@ -558,6 +581,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 {
@@ -964,4 +1011,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

@@ -312,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
@@ -451,6 +485,7 @@ var BroadcastsResource = class {
     if (params?.page) queryParams.page = String(params.page);
     if (params?.limit) queryParams.limit = String(params.limit);
     if (params?.status) queryParams.status = params.status;
+    if (params?.tags) queryParams.tags = params.tags;
     const data = await this.http.get("/v1/broadcasts", queryParams);
     if (Array.isArray(data)) {
       return data;

package/dist/index.mjs

@@ -279,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
@@ -418,6 +452,7 @@ var BroadcastsResource = class {
     if (params?.page) queryParams.page = String(params.page);
     if (params?.limit) queryParams.limit = String(params.limit);
     if (params?.status) queryParams.status = params.status;
+    if (params?.tags) queryParams.tags = params.tags;
     const data = await this.http.get("/v1/broadcasts", queryParams);
     if (Array.isArray(data)) {
       return data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emailr",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Official Emailr API SDK for TypeScript/JavaScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",