zupost 0.5.1 → 0.6.0

package/dist/index.d.mts

@@ -618,6 +618,183 @@ declare class Sequences {
     trigger(id: string, options: TriggerRunOptions): Promise<SequenceRun>;
 }
 
+/**
+ * Verification status shared by a domain and its individual DNS records.
+ */
+type DomainVerificationStatus = 'NOT_STARTED' | 'PENDING' | 'SUCCESS' | 'FAILED' | 'TEMPORARY_FAILURE';
+type DomainDnsRecordType = 'MX' | 'TXT' | 'CNAME';
+/**
+ * A single DNS record you need to add at your DNS provider for the domain to
+ * verify (DKIM, SPF, the verification TXT record, optional DMARC, …).
+ */
+interface DomainDnsRecord {
+    type: DomainDnsRecordType;
+    /** Record name/host, e.g. `mail` or `@`. */
+    name: string;
+    /** Record value, e.g. the SPF or DKIM string. */
+    value: string;
+    /** Recommended TTL, e.g. `Auto`. */
+    ttl: string;
+    /** Priority for MX records. */
+    priority?: string | null;
+    /** Verification status of this specific record. */
+    status?: DomainVerificationStatus | null;
+    /** Whether adding this record is recommended (e.g. DMARC). */
+    recommended?: boolean;
+}
+/**
+ * A sending domain with its DNS records and verification state.
+ */
+interface Domain {
+    id: string;
+    /** The domain name, e.g. `example.com`. */
+    name: string;
+    projectId: string;
+    /** Primary sending region, e.g. `eu-central-1`. */
+    mainRegion: string;
+    /** All regions the domain is provisioned in. */
+    regions: string[];
+    clickTracking: boolean;
+    openTracking: boolean;
+    dkimTokens: string[];
+    dkimStatus?: DomainVerificationStatus | null;
+    /** Overall verification status of the domain. */
+    status?: DomainVerificationStatus | null;
+    spfStatus?: DomainVerificationStatus | null;
+    createdAt: string;
+    updatedAt: string;
+    dmarcAdded: boolean;
+    verificationInProcess: boolean;
+    errorMessage?: string | null;
+    subdomain?: string | null;
+    verificationError?: string | null;
+    lastCheckedTime?: string | null;
+    scheduledForDeletion: boolean;
+    /** DNS records to add at your DNS provider to verify the domain. */
+    dnsRecords: DomainDnsRecord[];
+}
+interface CreateDomainOptions {
+    /** The domain name to register, e.g. `example.com`. */
+    name: string;
+    /**
+     * Sending region for the domain. Defaults to `eu-central-1`.
+     */
+    region?: string;
+}
+interface DeleteDomainResponse {
+    success: boolean;
+    message: string;
+}
+interface VerifyDomainResponse {
+    message: string;
+}
+
+/**
+ * Domains API.
+ *
+ * A Domain is a sending domain you own (e.g. `example.com`). After creating it
+ * you add the returned `dnsRecords` (DKIM, SPF, verification TXT) at your DNS
+ * provider and then `verify` it. Only verified domains can send email and
+ * receive inbound mail.
+ */
+declare class Domains {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Register a new sending domain. The response contains the `dnsRecords` you
+     * need to add at your DNS provider before calling {@link verify}.
+     *
+     * @example
+     * ```typescript
+     * const domain = await zupost.domains.create({ name: 'example.com' });
+     * for (const record of domain.dnsRecords) {
+     *   console.log(record.type, record.name, record.value);
+     * }
+     * ```
+     */
+    create(options: CreateDomainOptions): Promise<Domain>;
+    /**
+     * Get a domain by ID, including its current verification status and DNS
+     * records.
+     */
+    get(id: string): Promise<Domain>;
+    /**
+     * List all domains in the project.
+     */
+    list(): Promise<Domain[]>;
+    /**
+     * Start the verification process for a domain. Add the DNS records returned
+     * by {@link create} or {@link get} first; Zupost then checks them and
+     * updates the domain's `status`.
+     */
+    verify(id: string): Promise<VerifyDomainResponse>;
+    /**
+     * Schedule a domain for deletion.
+     */
+    delete(id: string): Promise<DeleteDomainResponse>;
+}
+
+interface CreateInboundChannelOptions {
+    /** Human-readable name for the channel (1-100 characters). */
+    name: string;
+    /** ID of a verified domain that should receive inbound email. */
+    domainId: string;
+    /**
+     * HTTPS URL parsed inbound emails are delivered to. Must resolve to a
+     * public address.
+     */
+    webhookUrl: string;
+    /**
+     * Shared secret (32-512 characters) used to sign webhook deliveries so you
+     * can verify they originate from Zupost.
+     */
+    webhookSecret: string;
+}
+/**
+ * An inbound email channel: it routes mail received on a domain to your
+ * `webhookUrl`.
+ */
+interface InboundChannel {
+    id: string;
+    name: string;
+    projectId: string;
+    domainId: string;
+    webhookUrl: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+/**
+ * Inbound API.
+ *
+ * Receive email sent to a verified domain by routing it through an inbound
+ * channel to your own HTTPS webhook. Deliveries are signed with the
+ * `webhookSecret` you provide so you can verify their authenticity.
+ */
+declare class Inbound {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Inbound channels route mail received on a domain to a webhook.
+     */
+    readonly channels: {
+        /**
+         * Create an inbound channel for a verified domain.
+         *
+         * @example
+         * ```typescript
+         * const channel = await zupost.inbound.channels.create({
+         *   name: 'Support inbox',
+         *   domainId: 'dom_123',
+         *   webhookUrl: 'https://example.com/zupost/inbound',
+         *   webhookSecret: process.env.ZUPOST_INBOUND_SECRET!,
+         * });
+         * ```
+         */
+        create: (options: CreateInboundChannelOptions) => Promise<InboundChannel>;
+    };
+}
+
 interface ZupostOptions {
     /**
      * Custom API URL. Defaults to 'https://api.zupost.com'.
@@ -644,6 +821,16 @@ declare class Zupost {
      * transactional) with branches, waits, tags and webhooks.
      */
     readonly sequences: Sequences;
+    /**
+     * Domains API. A Domain is a sending domain you own, with DNS records and
+     * verification state. Only verified domains can send and receive email.
+     */
+    readonly domains: Domains;
+    /**
+     * Inbound API. Receive email on a verified domain and have it delivered to
+     * your own webhook through an inbound channel.
+     */
+    readonly inbound: Inbound;
     constructor(apiKey: string, options?: ZupostOptions);
 }
 
@@ -713,4 +900,4 @@ declare function defineSequence<TSteps extends Record<string, SequenceStep>>(def
     steps: TSteps;
 }): SequenceDefinition;
 
-export { type BranchCondition, type Contact, type ContactEvent, type ContactEventType, type ContactExport, type ContactTag, type CreateContactOptions, type CreateSequenceOptions, type EmailRecipientType, type ForgetContactResponse, type ListContactsOptions, type ListContactsResponse, type ListEventsOptions, type ListEventsResponse, type ListRunsOptions, type ListRunsResponse, type ListSequencesOptions, type ListSequencesResponse, type SaveVersionOptions, type SendCampaignOptions, type SendCampaignResponse, type SendEmailOptions, type SendEmailResponse, type Sequence, type SequenceDefinition, type SequenceRun, type SequenceRunStatus, type SequenceStatus, type SequenceStep, type SequenceTriggerType, type SequenceType, type SequenceVersion, type TriggerRunOptions, type UpdateContactOptions, type WaitDuration, Zupost, ZupostError, type ZupostOptions, defineSequence };
+export { type BranchCondition, type Contact, type ContactEvent, type ContactEventType, type ContactExport, type ContactTag, type CreateContactOptions, type CreateDomainOptions, type CreateInboundChannelOptions, type CreateSequenceOptions, type DeleteDomainResponse, type Domain, type DomainDnsRecord, type DomainDnsRecordType, type DomainVerificationStatus, type EmailRecipientType, type ForgetContactResponse, type InboundChannel, type ListContactsOptions, type ListContactsResponse, type ListEventsOptions, type ListEventsResponse, type ListRunsOptions, type ListRunsResponse, type ListSequencesOptions, type ListSequencesResponse, type SaveVersionOptions, type SendCampaignOptions, type SendCampaignResponse, type SendEmailOptions, type SendEmailResponse, type Sequence, type SequenceDefinition, type SequenceRun, type SequenceRunStatus, type SequenceStatus, type SequenceStep, type SequenceTriggerType, type SequenceType, type SequenceVersion, type TriggerRunOptions, type UpdateContactOptions, type VerifyDomainResponse, type WaitDuration, Zupost, ZupostError, type ZupostOptions, defineSequence };

package/dist/index.d.ts

@@ -618,6 +618,183 @@ declare class Sequences {
     trigger(id: string, options: TriggerRunOptions): Promise<SequenceRun>;
 }
 
+/**
+ * Verification status shared by a domain and its individual DNS records.
+ */
+type DomainVerificationStatus = 'NOT_STARTED' | 'PENDING' | 'SUCCESS' | 'FAILED' | 'TEMPORARY_FAILURE';
+type DomainDnsRecordType = 'MX' | 'TXT' | 'CNAME';
+/**
+ * A single DNS record you need to add at your DNS provider for the domain to
+ * verify (DKIM, SPF, the verification TXT record, optional DMARC, …).
+ */
+interface DomainDnsRecord {
+    type: DomainDnsRecordType;
+    /** Record name/host, e.g. `mail` or `@`. */
+    name: string;
+    /** Record value, e.g. the SPF or DKIM string. */
+    value: string;
+    /** Recommended TTL, e.g. `Auto`. */
+    ttl: string;
+    /** Priority for MX records. */
+    priority?: string | null;
+    /** Verification status of this specific record. */
+    status?: DomainVerificationStatus | null;
+    /** Whether adding this record is recommended (e.g. DMARC). */
+    recommended?: boolean;
+}
+/**
+ * A sending domain with its DNS records and verification state.
+ */
+interface Domain {
+    id: string;
+    /** The domain name, e.g. `example.com`. */
+    name: string;
+    projectId: string;
+    /** Primary sending region, e.g. `eu-central-1`. */
+    mainRegion: string;
+    /** All regions the domain is provisioned in. */
+    regions: string[];
+    clickTracking: boolean;
+    openTracking: boolean;
+    dkimTokens: string[];
+    dkimStatus?: DomainVerificationStatus | null;
+    /** Overall verification status of the domain. */
+    status?: DomainVerificationStatus | null;
+    spfStatus?: DomainVerificationStatus | null;
+    createdAt: string;
+    updatedAt: string;
+    dmarcAdded: boolean;
+    verificationInProcess: boolean;
+    errorMessage?: string | null;
+    subdomain?: string | null;
+    verificationError?: string | null;
+    lastCheckedTime?: string | null;
+    scheduledForDeletion: boolean;
+    /** DNS records to add at your DNS provider to verify the domain. */
+    dnsRecords: DomainDnsRecord[];
+}
+interface CreateDomainOptions {
+    /** The domain name to register, e.g. `example.com`. */
+    name: string;
+    /**
+     * Sending region for the domain. Defaults to `eu-central-1`.
+     */
+    region?: string;
+}
+interface DeleteDomainResponse {
+    success: boolean;
+    message: string;
+}
+interface VerifyDomainResponse {
+    message: string;
+}
+
+/**
+ * Domains API.
+ *
+ * A Domain is a sending domain you own (e.g. `example.com`). After creating it
+ * you add the returned `dnsRecords` (DKIM, SPF, verification TXT) at your DNS
+ * provider and then `verify` it. Only verified domains can send email and
+ * receive inbound mail.
+ */
+declare class Domains {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Register a new sending domain. The response contains the `dnsRecords` you
+     * need to add at your DNS provider before calling {@link verify}.
+     *
+     * @example
+     * ```typescript
+     * const domain = await zupost.domains.create({ name: 'example.com' });
+     * for (const record of domain.dnsRecords) {
+     *   console.log(record.type, record.name, record.value);
+     * }
+     * ```
+     */
+    create(options: CreateDomainOptions): Promise<Domain>;
+    /**
+     * Get a domain by ID, including its current verification status and DNS
+     * records.
+     */
+    get(id: string): Promise<Domain>;
+    /**
+     * List all domains in the project.
+     */
+    list(): Promise<Domain[]>;
+    /**
+     * Start the verification process for a domain. Add the DNS records returned
+     * by {@link create} or {@link get} first; Zupost then checks them and
+     * updates the domain's `status`.
+     */
+    verify(id: string): Promise<VerifyDomainResponse>;
+    /**
+     * Schedule a domain for deletion.
+     */
+    delete(id: string): Promise<DeleteDomainResponse>;
+}
+
+interface CreateInboundChannelOptions {
+    /** Human-readable name for the channel (1-100 characters). */
+    name: string;
+    /** ID of a verified domain that should receive inbound email. */
+    domainId: string;
+    /**
+     * HTTPS URL parsed inbound emails are delivered to. Must resolve to a
+     * public address.
+     */
+    webhookUrl: string;
+    /**
+     * Shared secret (32-512 characters) used to sign webhook deliveries so you
+     * can verify they originate from Zupost.
+     */
+    webhookSecret: string;
+}
+/**
+ * An inbound email channel: it routes mail received on a domain to your
+ * `webhookUrl`.
+ */
+interface InboundChannel {
+    id: string;
+    name: string;
+    projectId: string;
+    domainId: string;
+    webhookUrl: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+/**
+ * Inbound API.
+ *
+ * Receive email sent to a verified domain by routing it through an inbound
+ * channel to your own HTTPS webhook. Deliveries are signed with the
+ * `webhookSecret` you provide so you can verify their authenticity.
+ */
+declare class Inbound {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Inbound channels route mail received on a domain to a webhook.
+     */
+    readonly channels: {
+        /**
+         * Create an inbound channel for a verified domain.
+         *
+         * @example
+         * ```typescript
+         * const channel = await zupost.inbound.channels.create({
+         *   name: 'Support inbox',
+         *   domainId: 'dom_123',
+         *   webhookUrl: 'https://example.com/zupost/inbound',
+         *   webhookSecret: process.env.ZUPOST_INBOUND_SECRET!,
+         * });
+         * ```
+         */
+        create: (options: CreateInboundChannelOptions) => Promise<InboundChannel>;
+    };
+}
+
 interface ZupostOptions {
     /**
      * Custom API URL. Defaults to 'https://api.zupost.com'.
@@ -644,6 +821,16 @@ declare class Zupost {
      * transactional) with branches, waits, tags and webhooks.
      */
     readonly sequences: Sequences;
+    /**
+     * Domains API. A Domain is a sending domain you own, with DNS records and
+     * verification state. Only verified domains can send and receive email.
+     */
+    readonly domains: Domains;
+    /**
+     * Inbound API. Receive email on a verified domain and have it delivered to
+     * your own webhook through an inbound channel.
+     */
+    readonly inbound: Inbound;
     constructor(apiKey: string, options?: ZupostOptions);
 }
 
@@ -713,4 +900,4 @@ declare function defineSequence<TSteps extends Record<string, SequenceStep>>(def
     steps: TSteps;
 }): SequenceDefinition;
 
-export { type BranchCondition, type Contact, type ContactEvent, type ContactEventType, type ContactExport, type ContactTag, type CreateContactOptions, type CreateSequenceOptions, type EmailRecipientType, type ForgetContactResponse, type ListContactsOptions, type ListContactsResponse, type ListEventsOptions, type ListEventsResponse, type ListRunsOptions, type ListRunsResponse, type ListSequencesOptions, type ListSequencesResponse, type SaveVersionOptions, type SendCampaignOptions, type SendCampaignResponse, type SendEmailOptions, type SendEmailResponse, type Sequence, type SequenceDefinition, type SequenceRun, type SequenceRunStatus, type SequenceStatus, type SequenceStep, type SequenceTriggerType, type SequenceType, type SequenceVersion, type TriggerRunOptions, type UpdateContactOptions, type WaitDuration, Zupost, ZupostError, type ZupostOptions, defineSequence };
+export { type BranchCondition, type Contact, type ContactEvent, type ContactEventType, type ContactExport, type ContactTag, type CreateContactOptions, type CreateDomainOptions, type CreateInboundChannelOptions, type CreateSequenceOptions, type DeleteDomainResponse, type Domain, type DomainDnsRecord, type DomainDnsRecordType, type DomainVerificationStatus, type EmailRecipientType, type ForgetContactResponse, type InboundChannel, type ListContactsOptions, type ListContactsResponse, type ListEventsOptions, type ListEventsResponse, type ListRunsOptions, type ListRunsResponse, type ListSequencesOptions, type ListSequencesResponse, type SaveVersionOptions, type SendCampaignOptions, type SendCampaignResponse, type SendEmailOptions, type SendEmailResponse, type Sequence, type SequenceDefinition, type SequenceRun, type SequenceRunStatus, type SequenceStatus, type SequenceStep, type SequenceTriggerType, type SequenceType, type SequenceVersion, type TriggerRunOptions, type UpdateContactOptions, type VerifyDomainResponse, type WaitDuration, Zupost, ZupostError, type ZupostOptions, defineSequence };

package/dist/index.js

@@ -79,7 +79,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.5.1";
+var version = "0.6.0";
 
 // src/errors.ts
 var ZupostError = class _ZupostError extends Error {
@@ -536,6 +536,101 @@ var Sequences = class {
   }
 };
 
+// src/domain/domains.ts
+var DEFAULT_REGION = "eu-central-1";
+var Domains = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Register a new sending domain. The response contains the `dnsRecords` you
+   * need to add at your DNS provider before calling {@link verify}.
+   *
+   * @example
+   * ```typescript
+   * const domain = await zupost.domains.create({ name: 'example.com' });
+   * for (const record of domain.dnsRecords) {
+   *   console.log(record.type, record.name, record.value);
+   * }
+   * ```
+   */
+  create(options) {
+    return __async(this, null, function* () {
+      var _a;
+      return this.http.post("/domain", {
+        name: options.name,
+        region: (_a = options.region) != null ? _a : DEFAULT_REGION
+      });
+    });
+  }
+  /**
+   * Get a domain by ID, including its current verification status and DNS
+   * records.
+   */
+  get(id) {
+    return __async(this, null, function* () {
+      return this.http.get(`/domain/${encodeURIComponent(id)}`);
+    });
+  }
+  /**
+   * List all domains in the project.
+   */
+  list() {
+    return __async(this, null, function* () {
+      return this.http.get("/domain");
+    });
+  }
+  /**
+   * Start the verification process for a domain. Add the DNS records returned
+   * by {@link create} or {@link get} first; Zupost then checks them and
+   * updates the domain's `status`.
+   */
+  verify(id) {
+    return __async(this, null, function* () {
+      return this.http.post(
+        `/domain/${encodeURIComponent(id)}/verify`,
+        void 0
+      );
+    });
+  }
+  /**
+   * Schedule a domain for deletion.
+   */
+  delete(id) {
+    return __async(this, null, function* () {
+      return this.http.delete(`/domain/${encodeURIComponent(id)}`);
+    });
+  }
+};
+
+// src/inbound/inbound.ts
+var Inbound = class {
+  constructor(http) {
+    this.http = http;
+    /**
+     * Inbound channels route mail received on a domain to a webhook.
+     */
+    this.channels = {
+      /**
+       * Create an inbound channel for a verified domain.
+       *
+       * @example
+       * ```typescript
+       * const channel = await zupost.inbound.channels.create({
+       *   name: 'Support inbox',
+       *   domainId: 'dom_123',
+       *   webhookUrl: 'https://example.com/zupost/inbound',
+       *   webhookSecret: process.env.ZUPOST_INBOUND_SECRET!,
+       * });
+       * ```
+       */
+      create: (options) => __async(this, null, function* () {
+        return this.http.post("/inbound-channel", options);
+      })
+    };
+  }
+};
+
 // src/zupost.ts
 var _client;
 var Zupost = class {
@@ -551,6 +646,8 @@ var Zupost = class {
     this.campaigns = new Campaigns(__privateGet(this, _client));
     this.contacts = new Contacts(__privateGet(this, _client));
     this.sequences = new Sequences(__privateGet(this, _client));
+    this.domains = new Domains(__privateGet(this, _client));
+    this.inbound = new Inbound(__privateGet(this, _client));
   }
 };
 _client = new WeakMap();

package/dist/index.mjs

@@ -44,7 +44,7 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // package.json
-var version = "0.5.1";
+var version = "0.6.0";
 
 // src/errors.ts
 var ZupostError = class _ZupostError extends Error {
@@ -501,6 +501,101 @@ var Sequences = class {
   }
 };
 
+// src/domain/domains.ts
+var DEFAULT_REGION = "eu-central-1";
+var Domains = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Register a new sending domain. The response contains the `dnsRecords` you
+   * need to add at your DNS provider before calling {@link verify}.
+   *
+   * @example
+   * ```typescript
+   * const domain = await zupost.domains.create({ name: 'example.com' });
+   * for (const record of domain.dnsRecords) {
+   *   console.log(record.type, record.name, record.value);
+   * }
+   * ```
+   */
+  create(options) {
+    return __async(this, null, function* () {
+      var _a;
+      return this.http.post("/domain", {
+        name: options.name,
+        region: (_a = options.region) != null ? _a : DEFAULT_REGION
+      });
+    });
+  }
+  /**
+   * Get a domain by ID, including its current verification status and DNS
+   * records.
+   */
+  get(id) {
+    return __async(this, null, function* () {
+      return this.http.get(`/domain/${encodeURIComponent(id)}`);
+    });
+  }
+  /**
+   * List all domains in the project.
+   */
+  list() {
+    return __async(this, null, function* () {
+      return this.http.get("/domain");
+    });
+  }
+  /**
+   * Start the verification process for a domain. Add the DNS records returned
+   * by {@link create} or {@link get} first; Zupost then checks them and
+   * updates the domain's `status`.
+   */
+  verify(id) {
+    return __async(this, null, function* () {
+      return this.http.post(
+        `/domain/${encodeURIComponent(id)}/verify`,
+        void 0
+      );
+    });
+  }
+  /**
+   * Schedule a domain for deletion.
+   */
+  delete(id) {
+    return __async(this, null, function* () {
+      return this.http.delete(`/domain/${encodeURIComponent(id)}`);
+    });
+  }
+};
+
+// src/inbound/inbound.ts
+var Inbound = class {
+  constructor(http) {
+    this.http = http;
+    /**
+     * Inbound channels route mail received on a domain to a webhook.
+     */
+    this.channels = {
+      /**
+       * Create an inbound channel for a verified domain.
+       *
+       * @example
+       * ```typescript
+       * const channel = await zupost.inbound.channels.create({
+       *   name: 'Support inbox',
+       *   domainId: 'dom_123',
+       *   webhookUrl: 'https://example.com/zupost/inbound',
+       *   webhookSecret: process.env.ZUPOST_INBOUND_SECRET!,
+       * });
+       * ```
+       */
+      create: (options) => __async(this, null, function* () {
+        return this.http.post("/inbound-channel", options);
+      })
+    };
+  }
+};
+
 // src/zupost.ts
 var _client;
 var Zupost = class {
@@ -516,6 +611,8 @@ var Zupost = class {
     this.campaigns = new Campaigns(__privateGet(this, _client));
     this.contacts = new Contacts(__privateGet(this, _client));
     this.sequences = new Sequences(__privateGet(this, _client));
+    this.domains = new Domains(__privateGet(this, _client));
+    this.inbound = new Inbound(__privateGet(this, _client));
   }
 };
 _client = new WeakMap();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zupost",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Node.js SDK for Zupost",
   "engines": {
     "node": ">=20"