@ptkl/sdk 1.1.0 → 1.3.0

package/dist/v0.9/types/integrations/mail.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Represents the status of an email in the system.
+ */
+export type EmailStatus = "pending" | "sent" | "failed";
+/**
+ * Represents a mail log entry returned by the API.
+ */
+export type MailLog = {
+    /** Unique message identifier (UUID) */
+    message_id: string;
+    /** Project scope UUID */
+    project_uuid: string;
+    /** Tenant scope UUID */
+    tenant_uuid: string;
+    /** Associated workflow component UUID */
+    component_uuid?: string;
+    /** Environment: "dev" or "live" */
+    env: string;
+    /** Sender address (auto-generated from tenant) */
+    from: string;
+    /** Recipient email addresses */
+    to: string[];
+    /** CC email addresses */
+    cc: string[];
+    /** BCC email addresses */
+    bcc: string[];
+    /** Reply-to email address */
+    reply_to?: string;
+    /** Email subject line */
+    subject: string;
+    /** Email body (HTML) */
+    body: string;
+    /** Attachment metadata as JSON string */
+    attachments?: string;
+    /** Current sending status */
+    status: EmailStatus;
+    /** Number of send retry attempts */
+    retry_count: number;
+    /** Maximum allowed retries */
+    max_retries: number;
+    /** Error message from last failed attempt */
+    error_message?: string;
+    /** Timestamp when email was successfully sent */
+    sent_at?: string;
+    /** Timestamp when email was opened (tracking pixel) */
+    read_at?: string;
+    /** IP address of reader */
+    read_ip?: string;
+    /** User agent of reader */
+    read_user_agent?: string;
+    /** Whether the email was reported as spam */
+    spam_reported: boolean;
+    /** Timestamp of spam report */
+    spam_reported_at?: string;
+    /** Who reported the spam */
+    spam_reported_by?: string;
+    /** IP address of spam reporter */
+    spam_report_ip?: string;
+    /** Record creation timestamp */
+    created_at: string;
+    /** Record update timestamp */
+    updated_at: string;
+};
+/**
+ * Attachment input for sending an email.
+ */
+export type AttachmentInput = {
+    /** DMS file ID reference */
+    file_id?: string;
+    /** File name */
+    file_name: string;
+    /** MIME type (e.g. "application/pdf") */
+    mime_type: string;
+    /** Base64-encoded file content */
+    content?: string;
+    /** File size in bytes */
+    size?: number;
+};
+/**
+ * Request payload for sending an email.
+ */
+export type SendEmailRequest = {
+    /** Recipient email addresses (required) */
+    to: string[];
+    /** CC email addresses */
+    cc?: string[];
+    /** BCC email addresses */
+    bcc?: string[];
+    /** Email subject (required) */
+    subject: string;
+    /** Email body in HTML (required) */
+    body: string;
+    /** Reply-to email address */
+    reply_to?: string;
+    /** Custom sender display name */
+    sender_name?: string;
+    /** File attachments */
+    attachments?: AttachmentInput[];
+};
+/**
+ * Response from the send email endpoint.
+ */
+export type SendEmailResponse = {
+    /** Whether the operation succeeded */
+    status: boolean;
+    /** The generated message ID (UUID) */
+    message_id: string;
+    /** Human-readable status message */
+    message: string;
+};
+/**
+ * Paginated list response for emails.
+ */
+export type EmailListResponse = {
+    /** Array of mail log entries */
+    data: MailLog[];
+    /** Total number of matching emails */
+    total: number;
+    /** Current page number */
+    page: number;
+    /** Number of items per page */
+    limit: number;
+};
+/**
+ * Query parameters for listing emails.
+ */
+export type ListEmailsParams = {
+    /** Filter by email status */
+    status?: EmailStatus;
+    /** Page number (1-indexed) */
+    page?: number;
+    /** Items per page (max 100, default 20) */
+    limit?: number;
+};
+/**
+ * Attachment metadata returned by the list attachments endpoint.
+ */
+export type AttachmentMeta = {
+    /** Attachment record UUID */
+    uuid: string;
+    /** Linked message ID */
+    message_id: string;
+    /** File name */
+    file_name: string;
+    /** MIME type */
+    mime_type: string;
+    /** File size in bytes */
+    file_size: number;
+    /** Record creation timestamp */
+    created_at: string;
+};
+/**
+ * Events published by the mail system for workflow triggers.
+ */
+export type MailEventType = "protokol-mail.email.sent" | "protokol-mail.email.failed" | "protokol-mail.email.opened" | "protokol-mail.email.spam_reported";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",