@easybits.cloud/mailmask 0.4.3 → 0.4.5

package/README.md

@@ -1,6 +1,6 @@
 # @easybits.cloud/mailmask
 
-Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email alias and forwarding API.
+Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email address, mailbox and forwarding API.
 
 ## Install
 
@@ -19,29 +19,30 @@ const mm = new MailMask({ apiKey: "mk_..." });
 const domains = await mm.domains.list();
 const domainId = domains[0].id;
 
-// Create an alias — emails to hello@yourdomain.com forward to your inbox
-const alias = await mm.aliases.create(domainId, {
+// Create an address — emails to hello@yourdomain.com forward to your inbox
+const address = await mm.addresses.create(domainId, {
   alias: "hello",
   destinations: ["you@example.com"],
 });
 
 // Send an email (routed through MailMask for high deliverability)
 await mm.send.send(domainId, {
-  from: "hello",              // must be an active alias; defaults to `noreply`
+  from: "hello",              // must be an active address; defaults to `noreply`
   fromName: "Acme",           // optional display name: Acme <hello@yourdomain.com>
   to: "client@example.com",
   subject: "Welcome!",
   html: "<p>Thanks for signing up.</p>", // or `body` (plain text) / `markdown`
 });
 
-// List aliases for a domain
-const aliases = await mm.aliases.list(domainId);
+// List addresses for a domain
+const addresses = await mm.addresses.list(domainId);
 
 // Add a domain — returns the DNS records to configure (MX, TXT, DKIM, SPF)
 const { domain, dnsRecords } = await mm.domains.create("yourdomain.com");
 
-// An alias with an IMAP mailbox (activated domain): password is returned once
-const inbox = await mm.aliases.create(domainId, { alias: "sales", mailbox: true });
+// An address with an IMAP mailbox (activated domain): password is returned once
+const inbox = await mm.addresses.create(domainId, { alias: "sales", mailbox: true });
+// `mm.aliases` still works: it is the same resource under its old name.
 console.log(inbox.buzon?.password, inbox.buzon?.imap);
 ```
 
@@ -79,7 +80,7 @@ Full API reference and examples: https://mailmask.studio/docs
 
 ## Links
 
-- [MailMask](https://mailmask.studio) — Email alias & forwarding service
+- [MailMask](https://mailmask.studio) — Email addresses, mailboxes & forwarding on your domain
 - [EasyBits](https://easybits.cloud) — Cloud platform
 - [Fixter](https://fixter.org) — Development team
 

package/dist/index.cjs

@@ -59,7 +59,8 @@ var MailMask = class {
     const doFetch = config.fetch ? config.fetch : fetch;
     const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts, doFetch);
     this.domains = new DomainsResource(req);
-    this.aliases = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.addresses = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.aliases = this.addresses;
     this.rules = new RulesResource(req);
     this.logs = new LogsResource(req);
     this.send = new SendResource(req);
@@ -76,6 +77,8 @@ var MailMask = class {
     this.signature = new SignatureResource(req);
     this.canned = new CannedResource(req);
     this.account = new AccountResource(req);
+    this.inbox = new InboxResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.referrals = new ReferralsResource(req);
   }
 };
 var DomainsResource = class {
@@ -104,6 +107,19 @@ var DomainsResource = class {
   dnsSetup(id, opts) {
     return this.req(`/api/domains/${id}/dns-setup${opts?.live ? "?live=1" : ""}`);
   }
+  /** Logo de la firma (PNG, JPG o WebP; máx. 500 KB). Se ve en todo correo en markdown. */
+  setLogo(id, file, filename = "logo") {
+    const form = new FormData();
+    form.append("file", file, filename);
+    return this.req(`/api/domains/${id}/logo`, { method: "POST", body: form });
+  }
+  /** Logo desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+  setLogoFromUrl(id, url) {
+    return this.req(`/api/domains/${id}/logo`, { method: "POST", body: JSON.stringify({ fromUrl: url }) });
+  }
+  removeLogo(id) {
+    return this.req(`/api/domains/${id}/logo`, { method: "DELETE" });
+  }
 };
 var DnsResource = class {
   constructor(req) {
@@ -224,6 +240,10 @@ var AttachmentsResource = class {
     form.append("file", blob, input.filename);
     return this.req(`/api/domains/${domainId}/attachments`, { method: "POST", body: form });
   }
+  /** Desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+  uploadFromUrl(domainId, url, filename) {
+    return this.req(`/api/domains/${domainId}/attachments`, { method: "POST", body: JSON.stringify({ fromUrl: url, filename }) });
+  }
 };
 var SuppressionsResource = class {
   constructor(req) {
@@ -306,7 +326,19 @@ var BillingResource = class {
    * El usuario la abre y paga; hasta entonces no cambia nada.
    */
   checkout(domainId, kind = "domain", opts) {
-    return this.req("/api/addons/checkout", { method: "POST", body: JSON.stringify({ kind, domainId, payerEmail: opts?.payerEmail }) });
+    return this.req("/api/addons/checkout", { method: "POST", body: JSON.stringify({ kind, domainId, payerEmail: opts?.payerEmail, period: opts?.period }) });
+  }
+  /** Cancela la suscripción de un add-on; el cupo sigue hasta el fin del periodo pagado. */
+  cancelAddon(addonId) {
+    return this.req(`/api/addons/${addonId}/cancel`, { method: "POST" });
+  }
+  /** Historial de cobros, cortesías y cancelaciones (más reciente primero). */
+  orders(opts) {
+    const qs = new URLSearchParams();
+    if (opts?.limit) qs.set("limit", String(opts.limit));
+    if (opts?.before) qs.set("before", opts.before);
+    const q = qs.toString();
+    return this.req(`/api/billing/orders${q ? `?${q}` : ""}`);
   }
 };
 var RegistrationsResource = class {
@@ -334,6 +366,10 @@ var RegistrationsResource = class {
   renewal(regId, opts) {
     return this.req(`/api/domains/registrations/${regId}/renewal`, { method: "POST", body: JSON.stringify({ payerEmail: opts?.payerEmail }) });
   }
+  /** Deja de cobrar la renovación anual. El dominio sigue vigente hasta su vencimiento. */
+  cancelRenewal(regId) {
+    return this.req(`/api/domains/registrations/${regId}/renewal/cancel`, { method: "POST" });
+  }
 };
 var TransfersResource = class {
   constructor(req) {
@@ -426,6 +462,77 @@ var AccountResource = class {
     return this.req("/api/profile/avatar", { method: "DELETE" });
   }
 };
+var InboxResource = class {
+  constructor(req, raw) {
+    this.req = req;
+    this.raw = raw;
+  }
+  list(domainId, opts) {
+    const qs = new URLSearchParams({ domainId });
+    for (const [k, v] of Object.entries(opts ?? {})) if (v !== void 0 && v !== "") qs.set(k, String(v));
+    return this.req(`/api/bandeja/conversations?${qs}`);
+  }
+  /** Conversación con sus mensajes (los 30 más recientes, o anteriores a `before`). Abrirla la marca leída. */
+  get(domainId, conversationId, opts) {
+    const qs = new URLSearchParams({ domainId });
+    if (opts?.before) qs.set("before", opts.before);
+    return this.req(`/api/bandeja/conversations/${conversationId}?${qs}`);
+  }
+  /** Un correo nuevo desde una máscara: abre un hilo. Gasta cuota de envío (dominio activado). */
+  compose(domainId, input) {
+    return this.req("/api/bandeja/conversations", { method: "POST", body: JSON.stringify({ ...input, domainId }) });
+  }
+  /** Responde en el hilo desde la máscara del hilo. No gasta cuota de envío. */
+  reply(domainId, conversationId, input) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/reply`, { method: "POST", body: JSON.stringify({ ...input, domainId }) });
+  }
+  update(domainId, conversationId, input) {
+    return this.req(`/api/bandeja/conversations/${conversationId}`, { method: "PATCH", body: JSON.stringify({ ...input, domainId }) });
+  }
+  markRead(domainId, conversationId) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/read`, { method: "POST", body: JSON.stringify({ domainId }) });
+  }
+  /** Sin `assignedTo` la deja sin asignar. */
+  assign(domainId, conversationId, assignedTo) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/assign`, { method: "POST", body: JSON.stringify({ domainId, assignedTo }) });
+  }
+  /** Nota interna: la ve el equipo, nunca el contacto. */
+  addNote(domainId, conversationId, body) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/note`, { method: "POST", body: JSON.stringify({ domainId, body }) });
+  }
+  /** A la papelera (se puede restaurar). Máx. 200 por llamada. */
+  delete(domainId, conversationIds) {
+    return this.req("/api/bandeja/conversations/bulk-delete", { method: "POST", body: JSON.stringify({ domainId, ids: conversationIds }) });
+  }
+  restore(domainId, conversationId) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/restore`, { method: "POST", body: JSON.stringify({ domainId }) });
+  }
+  metrics(domainId, opts) {
+    const qs = new URLSearchParams({ domainId });
+    if (opts?.days) qs.set("days", String(opts.days));
+    return this.req(`/api/bandeja/metrics?${qs}`);
+  }
+  /** Bytes de un adjunto de un mensaje (id del mensaje e índice de `attachments`). */
+  attachment(domainId, conversationId, messageId, index) {
+    return this.raw(`/api/bandeja/conversations/${conversationId}/attachments/${messageId}/${index}?domainId=${encodeURIComponent(domainId)}`);
+  }
+};
+var ReferralsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  get() {
+    return this.req("/api/referrals");
+  }
+  /** 3-30 caracteres: minúsculas, números y guiones. */
+  setSlug(slug) {
+    return this.req("/api/referrals/slug", { method: "PUT", body: JSON.stringify({ slug }) });
+  }
+  /** Nombre que ven los invitados (2-40 caracteres). */
+  setName(name) {
+    return this.req("/api/referrals/name", { method: "PUT", body: JSON.stringify({ name }) });
+  }
+};
 
 // src/verify.ts
 function hex(buf) {

package/dist/index.d.cts

@@ -47,6 +47,14 @@ interface DomainVerification {
     stale?: boolean;
     error?: string;
 }
+/** Nombre público de `Alias` desde la 0.4.5. */
+type Address = Alias;
+/** Nombre público de `AliasCreated` desde la 0.4.5. */
+type AddressCreated = AliasCreated;
+/** Nombre público de `CreateAliasInput` desde la 0.4.5. */
+type CreateAddressInput = CreateAliasInput;
+/** Nombre público de `UpdateAliasInput` desde la 0.4.5. */
+type UpdateAddressInput = UpdateAliasInput;
 interface Alias {
     alias: string;
     domainId: string;
@@ -521,6 +529,139 @@ interface AccountProfile {
     /** Ruta relativa al host de MailMask (`/api/avatar/...`), o null sin foto. */
     avatarUrl: string | null;
 }
+type InboxStatus = "open" | "snoozed" | "closed";
+interface InboxConversation {
+    id: string;
+    domainId: string;
+    /** El contacto externo (en un hilo que inició el dominio, el destinatario). */
+    from: string;
+    /** La máscara del dominio por la que va el hilo (`ventas@tudominio.com`). */
+    to: string;
+    subject: string;
+    status: InboxStatus;
+    assignedTo?: string;
+    priority: "normal" | "urgent";
+    lastMessageAt: string;
+    messageCount: number;
+    tags: string[];
+    deletedAt?: string;
+    snoozedUntil?: string;
+    /** Para quien pregunta: hay mensajes que no ha visto. */
+    unread?: boolean;
+    /** Sólo en búsqueda: fragmento con la coincidencia. */
+    snippet?: string;
+    [k: string]: unknown;
+}
+interface InboxListOptions {
+    /** `open`, `snoozed`, `closed`, `unread` (de quien pregunta) o `deleted` (papelera). */
+    status?: InboxStatus | "unread" | "deleted";
+    /** Dirección completa de la máscara (`ventas@tudominio.com`). */
+    to?: string;
+    assignedTo?: string;
+    /** Búsqueda en asunto, remitente y cuerpo. Con `q` no hay paginación (tope 50). */
+    q?: string;
+    /** Máx. 100. */
+    limit?: number;
+    cursor?: string;
+}
+interface InboxPage {
+    items: InboxConversation[];
+    nextCursor: string | null;
+    /** Máscaras con conversaciones (sólo en la primera página). */
+    aliases?: string[];
+    mode: "list" | "search" | "search-degraded";
+    unreadCount?: number;
+    [k: string]: unknown;
+}
+interface InboxAttachment {
+    index: number;
+    filename: string;
+    contentType: string;
+    size: number;
+}
+interface InboxMessage {
+    id: string;
+    conversationId: string;
+    from: string;
+    /** Texto plano. */
+    body?: string;
+    html?: string;
+    direction: "inbound" | "outbound";
+    createdAt: string;
+    messageId?: string;
+    deliveryStatus?: "sent" | "delivered" | "bounced" | "complained";
+    attachments?: InboxAttachment[];
+    /** El original ya no está (retención de 90 días o pérdida): `body` puede venir del índice. */
+    bodyDegraded?: string;
+}
+interface InboxNote {
+    id: string;
+    conversationId: string;
+    author: string;
+    body: string;
+    createdAt: string;
+}
+interface InboxConversationDetail extends InboxConversation {
+    messages: InboxMessage[];
+    notes: InboxNote[];
+    totalMessages: number;
+    hasMore: boolean;
+}
+interface InboxComposeInput {
+    /** Parte local (o dirección completa) de una máscara activa del dominio. */
+    fromAlias: string;
+    to: string;
+    subject: string;
+    markdown?: string;
+    html?: string;
+    body?: string;
+    cc?: string[];
+    bcc?: string[];
+    attachments?: AttachmentRef[];
+}
+interface InboxReplyInput {
+    markdown?: string;
+    html?: string;
+    body?: string;
+    cc?: string[];
+    bcc?: string[];
+    /** Cita el último mensaje recibido (por omisión true; sólo con markdown). */
+    quote?: boolean;
+    attachments?: AttachmentRef[];
+}
+interface InboxUpdateInput {
+    status?: InboxStatus;
+    /** ISO, futura y a menos de 90 días. Obligatoria con `status: "snoozed"`. */
+    snoozedUntil?: string;
+    tags?: string[];
+    priority?: "normal" | "urgent";
+}
+interface Order {
+    id: string;
+    number: string;
+    date: string;
+    kind: string;
+    concept: string;
+    subject: string | null;
+    amountCents: number;
+    listPriceCents: number | null;
+    currency: string;
+    periodStart: string | null;
+    periodEnd: string | null;
+    failureReason: string | null;
+    note: string | null;
+    reference: string | null;
+}
+interface OrdersPage {
+    orders: Order[];
+    nextCursor: string | null;
+    invoiceNote: string;
+}
+interface ReferralStats {
+    slug?: string | null;
+    referrals: unknown[];
+    [k: string]: unknown;
+}
 
 declare class MailMaskError extends Error {
     status: number;
@@ -530,6 +671,9 @@ declare class MailMask {
     private baseUrl;
     private apiKey;
     domains: DomainsResource;
+    /** Las direcciones del dominio (máscaras), con reenvío, buzón o ambos. */
+    addresses: AliasesResource;
+    /** @deprecated Usa `addresses`; es el mismo recurso y no se va a retirar. */
     aliases: AliasesResource;
     rules: RulesResource;
     logs: LogsResource;
@@ -547,6 +691,8 @@ declare class MailMask {
     signature: SignatureResource;
     canned: CannedResource;
     account: AccountResource;
+    inbox: InboxResource;
+    referrals: ReferralsResource;
     constructor(config: MailMaskConfig);
 }
 type Req = <T>(path: string, opts?: RequestInit) => Promise<T>;
@@ -565,6 +711,19 @@ declare class DomainsResource {
     dnsSetup(id: string, opts?: {
         live?: boolean;
     }): Promise<DnsSetup>;
+    /** Logo de la firma (PNG, JPG o WebP; máx. 500 KB). Se ve en todo correo en markdown. */
+    setLogo(id: string, file: Blob, filename?: string): Promise<{
+        ok: boolean;
+        logoUrl: string;
+    }>;
+    /** Logo desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+    setLogoFromUrl(id: string, url: string): Promise<{
+        ok: boolean;
+        logoUrl: string;
+    }>;
+    removeLogo(id: string): Promise<{
+        ok: boolean;
+    }>;
 }
 declare class DnsResource {
     private req;
@@ -645,6 +804,8 @@ declare class AttachmentsResource {
     constructor(req: Req);
     /** Máx. 5 MB. Ejecutables bloqueados (415). La llave vale hasta que se envía. */
     upload(domainId: string, input: UploadAttachmentInput): Promise<UploadedAttachment>;
+    /** Desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+    uploadFromUrl(domainId: string, url: string, filename?: string): Promise<UploadedAttachment>;
 }
 declare class SuppressionsResource {
     private req;
@@ -702,7 +863,18 @@ declare class BillingResource {
      */
     checkout(domainId: string, kind?: "domain" | "storage50" | "sends100", opts?: {
         payerEmail?: string;
+        period?: "monthly" | "annual";
     }): Promise<CheckoutLink>;
+    /** Cancela la suscripción de un add-on; el cupo sigue hasta el fin del periodo pagado. */
+    cancelAddon(addonId: string): Promise<{
+        ok: boolean;
+        activeUntil: string | null;
+    }>;
+    /** Historial de cobros, cortesías y cancelaciones (más reciente primero). */
+    orders(opts?: {
+        limit?: number;
+        before?: string;
+    }): Promise<OrdersPage>;
 }
 declare class RegistrationsResource {
     private req;
@@ -721,6 +893,11 @@ declare class RegistrationsResource {
     renewal(regId: string, opts?: {
         payerEmail?: string;
     }): Promise<RenewalLink>;
+    /** Deja de cobrar la renovación anual. El dominio sigue vigente hasta su vencimiento. */
+    cancelRenewal(regId: string): Promise<{
+        ok: boolean;
+        aviso: string;
+    }>;
 }
 declare class TransfersResource {
     private req;
@@ -810,6 +987,67 @@ declare class AccountResource {
         ok: boolean;
     }>;
 }
+/**
+ * La Bandeja: conversaciones del dominio. Todo pasa por los mismos permisos que la app
+ * (dueño, admin o agente invitado) y los mismos topes de envío.
+ */
+declare class InboxResource {
+    private req;
+    private raw;
+    constructor(req: Req, raw: (path: string) => Promise<Response>);
+    list(domainId: string, opts?: InboxListOptions): Promise<InboxPage>;
+    /** Conversación con sus mensajes (los 30 más recientes, o anteriores a `before`). Abrirla la marca leída. */
+    get(domainId: string, conversationId: string, opts?: {
+        before?: string;
+    }): Promise<InboxConversationDetail>;
+    /** Un correo nuevo desde una máscara: abre un hilo. Gasta cuota de envío (dominio activado). */
+    compose(domainId: string, input: InboxComposeInput): Promise<{
+        ok: boolean;
+        conversationId: string;
+        messageId: string;
+    }>;
+    /** Responde en el hilo desde la máscara del hilo. No gasta cuota de envío. */
+    reply(domainId: string, conversationId: string, input: InboxReplyInput): Promise<{
+        ok: boolean;
+        messageId: string;
+    }>;
+    update(domainId: string, conversationId: string, input: InboxUpdateInput): Promise<InboxConversation>;
+    markRead(domainId: string, conversationId: string): Promise<{
+        ok: boolean;
+        unreadCount: number;
+    }>;
+    /** Sin `assignedTo` la deja sin asignar. */
+    assign(domainId: string, conversationId: string, assignedTo?: string): Promise<InboxConversation>;
+    /** Nota interna: la ve el equipo, nunca el contacto. */
+    addNote(domainId: string, conversationId: string, body: string): Promise<InboxNote>;
+    /** A la papelera (se puede restaurar). Máx. 200 por llamada. */
+    delete(domainId: string, conversationIds: string[]): Promise<{
+        ok: boolean;
+        deleted: number;
+    }>;
+    restore(domainId: string, conversationId: string): Promise<{
+        ok: boolean;
+    }>;
+    metrics(domainId: string, opts?: {
+        days?: number;
+    }): Promise<Record<string, unknown>>;
+    /** Bytes de un adjunto de un mensaje (id del mensaje e índice de `attachments`). */
+    attachment(domainId: string, conversationId: string, messageId: string, index: number): Promise<Response>;
+}
+declare class ReferralsResource {
+    private req;
+    constructor(req: Req);
+    get(): Promise<ReferralStats>;
+    /** 3-30 caracteres: minúsculas, números y guiones. */
+    setSlug(slug: string): Promise<{
+        ok: boolean;
+        slug: string;
+    }>;
+    /** Nombre que ven los invitados (2-40 caracteres). */
+    setName(name: string): Promise<{
+        ok: boolean;
+    }>;
+}
 
 interface WebhookSignatureHeaders {
     /** Header `X-MailMask-Signature`, con forma `sha256=<hex>`. */
@@ -824,4 +1062,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type AccountProfile, type Addon, type AddonsResponse, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
+export { type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };

package/dist/index.d.ts

@@ -47,6 +47,14 @@ interface DomainVerification {
     stale?: boolean;
     error?: string;
 }
+/** Nombre público de `Alias` desde la 0.4.5. */
+type Address = Alias;
+/** Nombre público de `AliasCreated` desde la 0.4.5. */
+type AddressCreated = AliasCreated;
+/** Nombre público de `CreateAliasInput` desde la 0.4.5. */
+type CreateAddressInput = CreateAliasInput;
+/** Nombre público de `UpdateAliasInput` desde la 0.4.5. */
+type UpdateAddressInput = UpdateAliasInput;
 interface Alias {
     alias: string;
     domainId: string;
@@ -521,6 +529,139 @@ interface AccountProfile {
     /** Ruta relativa al host de MailMask (`/api/avatar/...`), o null sin foto. */
     avatarUrl: string | null;
 }
+type InboxStatus = "open" | "snoozed" | "closed";
+interface InboxConversation {
+    id: string;
+    domainId: string;
+    /** El contacto externo (en un hilo que inició el dominio, el destinatario). */
+    from: string;
+    /** La máscara del dominio por la que va el hilo (`ventas@tudominio.com`). */
+    to: string;
+    subject: string;
+    status: InboxStatus;
+    assignedTo?: string;
+    priority: "normal" | "urgent";
+    lastMessageAt: string;
+    messageCount: number;
+    tags: string[];
+    deletedAt?: string;
+    snoozedUntil?: string;
+    /** Para quien pregunta: hay mensajes que no ha visto. */
+    unread?: boolean;
+    /** Sólo en búsqueda: fragmento con la coincidencia. */
+    snippet?: string;
+    [k: string]: unknown;
+}
+interface InboxListOptions {
+    /** `open`, `snoozed`, `closed`, `unread` (de quien pregunta) o `deleted` (papelera). */
+    status?: InboxStatus | "unread" | "deleted";
+    /** Dirección completa de la máscara (`ventas@tudominio.com`). */
+    to?: string;
+    assignedTo?: string;
+    /** Búsqueda en asunto, remitente y cuerpo. Con `q` no hay paginación (tope 50). */
+    q?: string;
+    /** Máx. 100. */
+    limit?: number;
+    cursor?: string;
+}
+interface InboxPage {
+    items: InboxConversation[];
+    nextCursor: string | null;
+    /** Máscaras con conversaciones (sólo en la primera página). */
+    aliases?: string[];
+    mode: "list" | "search" | "search-degraded";
+    unreadCount?: number;
+    [k: string]: unknown;
+}
+interface InboxAttachment {
+    index: number;
+    filename: string;
+    contentType: string;
+    size: number;
+}
+interface InboxMessage {
+    id: string;
+    conversationId: string;
+    from: string;
+    /** Texto plano. */
+    body?: string;
+    html?: string;
+    direction: "inbound" | "outbound";
+    createdAt: string;
+    messageId?: string;
+    deliveryStatus?: "sent" | "delivered" | "bounced" | "complained";
+    attachments?: InboxAttachment[];
+    /** El original ya no está (retención de 90 días o pérdida): `body` puede venir del índice. */
+    bodyDegraded?: string;
+}
+interface InboxNote {
+    id: string;
+    conversationId: string;
+    author: string;
+    body: string;
+    createdAt: string;
+}
+interface InboxConversationDetail extends InboxConversation {
+    messages: InboxMessage[];
+    notes: InboxNote[];
+    totalMessages: number;
+    hasMore: boolean;
+}
+interface InboxComposeInput {
+    /** Parte local (o dirección completa) de una máscara activa del dominio. */
+    fromAlias: string;
+    to: string;
+    subject: string;
+    markdown?: string;
+    html?: string;
+    body?: string;
+    cc?: string[];
+    bcc?: string[];
+    attachments?: AttachmentRef[];
+}
+interface InboxReplyInput {
+    markdown?: string;
+    html?: string;
+    body?: string;
+    cc?: string[];
+    bcc?: string[];
+    /** Cita el último mensaje recibido (por omisión true; sólo con markdown). */
+    quote?: boolean;
+    attachments?: AttachmentRef[];
+}
+interface InboxUpdateInput {
+    status?: InboxStatus;
+    /** ISO, futura y a menos de 90 días. Obligatoria con `status: "snoozed"`. */
+    snoozedUntil?: string;
+    tags?: string[];
+    priority?: "normal" | "urgent";
+}
+interface Order {
+    id: string;
+    number: string;
+    date: string;
+    kind: string;
+    concept: string;
+    subject: string | null;
+    amountCents: number;
+    listPriceCents: number | null;
+    currency: string;
+    periodStart: string | null;
+    periodEnd: string | null;
+    failureReason: string | null;
+    note: string | null;
+    reference: string | null;
+}
+interface OrdersPage {
+    orders: Order[];
+    nextCursor: string | null;
+    invoiceNote: string;
+}
+interface ReferralStats {
+    slug?: string | null;
+    referrals: unknown[];
+    [k: string]: unknown;
+}
 
 declare class MailMaskError extends Error {
     status: number;
@@ -530,6 +671,9 @@ declare class MailMask {
     private baseUrl;
     private apiKey;
     domains: DomainsResource;
+    /** Las direcciones del dominio (máscaras), con reenvío, buzón o ambos. */
+    addresses: AliasesResource;
+    /** @deprecated Usa `addresses`; es el mismo recurso y no se va a retirar. */
     aliases: AliasesResource;
     rules: RulesResource;
     logs: LogsResource;
@@ -547,6 +691,8 @@ declare class MailMask {
     signature: SignatureResource;
     canned: CannedResource;
     account: AccountResource;
+    inbox: InboxResource;
+    referrals: ReferralsResource;
     constructor(config: MailMaskConfig);
 }
 type Req = <T>(path: string, opts?: RequestInit) => Promise<T>;
@@ -565,6 +711,19 @@ declare class DomainsResource {
     dnsSetup(id: string, opts?: {
         live?: boolean;
     }): Promise<DnsSetup>;
+    /** Logo de la firma (PNG, JPG o WebP; máx. 500 KB). Se ve en todo correo en markdown. */
+    setLogo(id: string, file: Blob, filename?: string): Promise<{
+        ok: boolean;
+        logoUrl: string;
+    }>;
+    /** Logo desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+    setLogoFromUrl(id: string, url: string): Promise<{
+        ok: boolean;
+        logoUrl: string;
+    }>;
+    removeLogo(id: string): Promise<{
+        ok: boolean;
+    }>;
 }
 declare class DnsResource {
     private req;
@@ -645,6 +804,8 @@ declare class AttachmentsResource {
     constructor(req: Req);
     /** Máx. 5 MB. Ejecutables bloqueados (415). La llave vale hasta que se envía. */
     upload(domainId: string, input: UploadAttachmentInput): Promise<UploadedAttachment>;
+    /** Desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+    uploadFromUrl(domainId: string, url: string, filename?: string): Promise<UploadedAttachment>;
 }
 declare class SuppressionsResource {
     private req;
@@ -702,7 +863,18 @@ declare class BillingResource {
      */
     checkout(domainId: string, kind?: "domain" | "storage50" | "sends100", opts?: {
         payerEmail?: string;
+        period?: "monthly" | "annual";
     }): Promise<CheckoutLink>;
+    /** Cancela la suscripción de un add-on; el cupo sigue hasta el fin del periodo pagado. */
+    cancelAddon(addonId: string): Promise<{
+        ok: boolean;
+        activeUntil: string | null;
+    }>;
+    /** Historial de cobros, cortesías y cancelaciones (más reciente primero). */
+    orders(opts?: {
+        limit?: number;
+        before?: string;
+    }): Promise<OrdersPage>;
 }
 declare class RegistrationsResource {
     private req;
@@ -721,6 +893,11 @@ declare class RegistrationsResource {
     renewal(regId: string, opts?: {
         payerEmail?: string;
     }): Promise<RenewalLink>;
+    /** Deja de cobrar la renovación anual. El dominio sigue vigente hasta su vencimiento. */
+    cancelRenewal(regId: string): Promise<{
+        ok: boolean;
+        aviso: string;
+    }>;
 }
 declare class TransfersResource {
     private req;
@@ -810,6 +987,67 @@ declare class AccountResource {
         ok: boolean;
     }>;
 }
+/**
+ * La Bandeja: conversaciones del dominio. Todo pasa por los mismos permisos que la app
+ * (dueño, admin o agente invitado) y los mismos topes de envío.
+ */
+declare class InboxResource {
+    private req;
+    private raw;
+    constructor(req: Req, raw: (path: string) => Promise<Response>);
+    list(domainId: string, opts?: InboxListOptions): Promise<InboxPage>;
+    /** Conversación con sus mensajes (los 30 más recientes, o anteriores a `before`). Abrirla la marca leída. */
+    get(domainId: string, conversationId: string, opts?: {
+        before?: string;
+    }): Promise<InboxConversationDetail>;
+    /** Un correo nuevo desde una máscara: abre un hilo. Gasta cuota de envío (dominio activado). */
+    compose(domainId: string, input: InboxComposeInput): Promise<{
+        ok: boolean;
+        conversationId: string;
+        messageId: string;
+    }>;
+    /** Responde en el hilo desde la máscara del hilo. No gasta cuota de envío. */
+    reply(domainId: string, conversationId: string, input: InboxReplyInput): Promise<{
+        ok: boolean;
+        messageId: string;
+    }>;
+    update(domainId: string, conversationId: string, input: InboxUpdateInput): Promise<InboxConversation>;
+    markRead(domainId: string, conversationId: string): Promise<{
+        ok: boolean;
+        unreadCount: number;
+    }>;
+    /** Sin `assignedTo` la deja sin asignar. */
+    assign(domainId: string, conversationId: string, assignedTo?: string): Promise<InboxConversation>;
+    /** Nota interna: la ve el equipo, nunca el contacto. */
+    addNote(domainId: string, conversationId: string, body: string): Promise<InboxNote>;
+    /** A la papelera (se puede restaurar). Máx. 200 por llamada. */
+    delete(domainId: string, conversationIds: string[]): Promise<{
+        ok: boolean;
+        deleted: number;
+    }>;
+    restore(domainId: string, conversationId: string): Promise<{
+        ok: boolean;
+    }>;
+    metrics(domainId: string, opts?: {
+        days?: number;
+    }): Promise<Record<string, unknown>>;
+    /** Bytes de un adjunto de un mensaje (id del mensaje e índice de `attachments`). */
+    attachment(domainId: string, conversationId: string, messageId: string, index: number): Promise<Response>;
+}
+declare class ReferralsResource {
+    private req;
+    constructor(req: Req);
+    get(): Promise<ReferralStats>;
+    /** 3-30 caracteres: minúsculas, números y guiones. */
+    setSlug(slug: string): Promise<{
+        ok: boolean;
+        slug: string;
+    }>;
+    /** Nombre que ven los invitados (2-40 caracteres). */
+    setName(name: string): Promise<{
+        ok: boolean;
+    }>;
+}
 
 interface WebhookSignatureHeaders {
     /** Header `X-MailMask-Signature`, con forma `sha256=<hex>`. */
@@ -824,4 +1062,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type AccountProfile, type Addon, type AddonsResponse, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
+export { type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };

package/dist/index.js

@@ -31,7 +31,8 @@ var MailMask = class {
     const doFetch = config.fetch ? config.fetch : fetch;
     const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts, doFetch);
     this.domains = new DomainsResource(req);
-    this.aliases = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.addresses = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.aliases = this.addresses;
     this.rules = new RulesResource(req);
     this.logs = new LogsResource(req);
     this.send = new SendResource(req);
@@ -48,6 +49,8 @@ var MailMask = class {
     this.signature = new SignatureResource(req);
     this.canned = new CannedResource(req);
     this.account = new AccountResource(req);
+    this.inbox = new InboxResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.referrals = new ReferralsResource(req);
   }
 };
 var DomainsResource = class {
@@ -76,6 +79,19 @@ var DomainsResource = class {
   dnsSetup(id, opts) {
     return this.req(`/api/domains/${id}/dns-setup${opts?.live ? "?live=1" : ""}`);
   }
+  /** Logo de la firma (PNG, JPG o WebP; máx. 500 KB). Se ve en todo correo en markdown. */
+  setLogo(id, file, filename = "logo") {
+    const form = new FormData();
+    form.append("file", file, filename);
+    return this.req(`/api/domains/${id}/logo`, { method: "POST", body: form });
+  }
+  /** Logo desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+  setLogoFromUrl(id, url) {
+    return this.req(`/api/domains/${id}/logo`, { method: "POST", body: JSON.stringify({ fromUrl: url }) });
+  }
+  removeLogo(id) {
+    return this.req(`/api/domains/${id}/logo`, { method: "DELETE" });
+  }
 };
 var DnsResource = class {
   constructor(req) {
@@ -196,6 +212,10 @@ var AttachmentsResource = class {
     form.append("file", blob, input.filename);
     return this.req(`/api/domains/${domainId}/attachments`, { method: "POST", body: form });
   }
+  /** Desde un adjunto del chat del asistente (URL firmada de `/api/asistente/files/*`). */
+  uploadFromUrl(domainId, url, filename) {
+    return this.req(`/api/domains/${domainId}/attachments`, { method: "POST", body: JSON.stringify({ fromUrl: url, filename }) });
+  }
 };
 var SuppressionsResource = class {
   constructor(req) {
@@ -278,7 +298,19 @@ var BillingResource = class {
    * El usuario la abre y paga; hasta entonces no cambia nada.
    */
   checkout(domainId, kind = "domain", opts) {
-    return this.req("/api/addons/checkout", { method: "POST", body: JSON.stringify({ kind, domainId, payerEmail: opts?.payerEmail }) });
+    return this.req("/api/addons/checkout", { method: "POST", body: JSON.stringify({ kind, domainId, payerEmail: opts?.payerEmail, period: opts?.period }) });
+  }
+  /** Cancela la suscripción de un add-on; el cupo sigue hasta el fin del periodo pagado. */
+  cancelAddon(addonId) {
+    return this.req(`/api/addons/${addonId}/cancel`, { method: "POST" });
+  }
+  /** Historial de cobros, cortesías y cancelaciones (más reciente primero). */
+  orders(opts) {
+    const qs = new URLSearchParams();
+    if (opts?.limit) qs.set("limit", String(opts.limit));
+    if (opts?.before) qs.set("before", opts.before);
+    const q = qs.toString();
+    return this.req(`/api/billing/orders${q ? `?${q}` : ""}`);
   }
 };
 var RegistrationsResource = class {
@@ -306,6 +338,10 @@ var RegistrationsResource = class {
   renewal(regId, opts) {
     return this.req(`/api/domains/registrations/${regId}/renewal`, { method: "POST", body: JSON.stringify({ payerEmail: opts?.payerEmail }) });
   }
+  /** Deja de cobrar la renovación anual. El dominio sigue vigente hasta su vencimiento. */
+  cancelRenewal(regId) {
+    return this.req(`/api/domains/registrations/${regId}/renewal/cancel`, { method: "POST" });
+  }
 };
 var TransfersResource = class {
   constructor(req) {
@@ -398,6 +434,77 @@ var AccountResource = class {
     return this.req("/api/profile/avatar", { method: "DELETE" });
   }
 };
+var InboxResource = class {
+  constructor(req, raw) {
+    this.req = req;
+    this.raw = raw;
+  }
+  list(domainId, opts) {
+    const qs = new URLSearchParams({ domainId });
+    for (const [k, v] of Object.entries(opts ?? {})) if (v !== void 0 && v !== "") qs.set(k, String(v));
+    return this.req(`/api/bandeja/conversations?${qs}`);
+  }
+  /** Conversación con sus mensajes (los 30 más recientes, o anteriores a `before`). Abrirla la marca leída. */
+  get(domainId, conversationId, opts) {
+    const qs = new URLSearchParams({ domainId });
+    if (opts?.before) qs.set("before", opts.before);
+    return this.req(`/api/bandeja/conversations/${conversationId}?${qs}`);
+  }
+  /** Un correo nuevo desde una máscara: abre un hilo. Gasta cuota de envío (dominio activado). */
+  compose(domainId, input) {
+    return this.req("/api/bandeja/conversations", { method: "POST", body: JSON.stringify({ ...input, domainId }) });
+  }
+  /** Responde en el hilo desde la máscara del hilo. No gasta cuota de envío. */
+  reply(domainId, conversationId, input) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/reply`, { method: "POST", body: JSON.stringify({ ...input, domainId }) });
+  }
+  update(domainId, conversationId, input) {
+    return this.req(`/api/bandeja/conversations/${conversationId}`, { method: "PATCH", body: JSON.stringify({ ...input, domainId }) });
+  }
+  markRead(domainId, conversationId) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/read`, { method: "POST", body: JSON.stringify({ domainId }) });
+  }
+  /** Sin `assignedTo` la deja sin asignar. */
+  assign(domainId, conversationId, assignedTo) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/assign`, { method: "POST", body: JSON.stringify({ domainId, assignedTo }) });
+  }
+  /** Nota interna: la ve el equipo, nunca el contacto. */
+  addNote(domainId, conversationId, body) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/note`, { method: "POST", body: JSON.stringify({ domainId, body }) });
+  }
+  /** A la papelera (se puede restaurar). Máx. 200 por llamada. */
+  delete(domainId, conversationIds) {
+    return this.req("/api/bandeja/conversations/bulk-delete", { method: "POST", body: JSON.stringify({ domainId, ids: conversationIds }) });
+  }
+  restore(domainId, conversationId) {
+    return this.req(`/api/bandeja/conversations/${conversationId}/restore`, { method: "POST", body: JSON.stringify({ domainId }) });
+  }
+  metrics(domainId, opts) {
+    const qs = new URLSearchParams({ domainId });
+    if (opts?.days) qs.set("days", String(opts.days));
+    return this.req(`/api/bandeja/metrics?${qs}`);
+  }
+  /** Bytes de un adjunto de un mensaje (id del mensaje e índice de `attachments`). */
+  attachment(domainId, conversationId, messageId, index) {
+    return this.raw(`/api/bandeja/conversations/${conversationId}/attachments/${messageId}/${index}?domainId=${encodeURIComponent(domainId)}`);
+  }
+};
+var ReferralsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  get() {
+    return this.req("/api/referrals");
+  }
+  /** 3-30 caracteres: minúsculas, números y guiones. */
+  setSlug(slug) {
+    return this.req("/api/referrals/slug", { method: "PUT", body: JSON.stringify({ slug }) });
+  }
+  /** Nombre que ven los invitados (2-40 caracteres). */
+  setName(name) {
+    return this.req("/api/referrals/name", { method: "PUT", body: JSON.stringify({ name }) });
+  }
+};
 
 // src/verify.ts
 function hex(buf) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easybits.cloud/mailmask",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "description": "Official SDK for the MailMask email alias/forwarding API",
   "type": "module",
   "main": "./dist/index.cjs",