@sendly/node 3.30.0 → 3.33.0

package/dist/index.d.ts

@@ -3895,6 +3895,49 @@ declare class MediaResource {
     upload(file: Buffer | NodeJS.ReadableStream, options?: MediaUploadOptions): Promise<MediaFile>;
 }
 
+/**
+ * Verification submit/resubmit payload. All fields optional for resubmits
+ * (server merges with existing record). For initial provision via
+ * `submitVerification` (no existing record), the validator requires:
+ * businessName, website, address, contact, useCase, useCaseSummary,
+ * sampleMessages, optInWorkflow.
+ */
+interface VerificationSubmitInput {
+    businessName?: string;
+    doingBusinessAs?: string;
+    website?: string;
+    address?: {
+        street?: string;
+        address1?: string;
+        address2?: string | null;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country?: string;
+    };
+    contact?: {
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        phone?: string;
+    };
+    brn?: string | null;
+    brnType?: "EIN" | "SSN" | "DUNS" | "CRA" | "VAT" | "LEI" | "OTHER" | null;
+    brnCountry?: string | null;
+    entityType?: "SOLE_PROPRIETOR" | "PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "NON_PROFIT" | "GOVERNMENT";
+    useCase?: string;
+    useCaseSummary?: string;
+    sampleMessages?: string;
+    optInWorkflow?: string;
+    optInImageUrls?: string;
+    monthlyVolume?: string;
+    additionalInformation?: string;
+    ageGatedContent?: boolean;
+    isvReseller?: string;
+    privacyUrl?: string;
+    termsUrl?: string;
+}
+
 declare class WorkspacesSubResource {
     private readonly http;
     constructor(http: HttpClient);
@@ -3919,18 +3962,46 @@ declare class WorkspacesSubResource {
     }>;
     get(workspaceId: string): Promise<EnterpriseWorkspaceDetail>;
     delete(workspaceId: string): Promise<void>;
-    submitVerification(workspaceId: string, data: {
-        businessName: string;
-        businessType: string;
-        ein: string;
-        address: string;
-        city: string;
-        state: string;
-        zip: string;
-        useCase: string;
-        sampleMessages: string[];
-        monthlyVolume?: number;
-    }): Promise<unknown>;
+    /**
+     * Submit (or resubmit) a verification for an enterprise workspace.
+     *
+     * Partial-update friendly (May 2026): for resubmit on an existing
+     * workspace, you only need to send the fields you want to change —
+     * everything else is preserved from the existing record. Hosted page
+     * URLs (`/biz/`, `/opt-in/`, `/legal/`) generated during provision
+     * are auto-preserved.
+     *
+     * For sole proprietors, leave `brn`, `brnType`, `brnCountry` undefined
+     * — the server strips them before forwarding to the carrier.
+     *
+     * @example Full submit
+     * ```ts
+     * await sendly.enterprise.workspaces.submitVerification(workspaceId, {
+     *   businessName: "Acme LLC",
+     *   website: "https://acme.com",
+     *   address: { street: "...", city: "...", state: "California", zip: "90001", country: "US" },
+     *   contact: { firstName: "...", lastName: "...", email: "...", phone: "+15551234567" },
+     *   useCase: "Insurance Services",
+     *   useCaseSummary: "...",
+     *   sampleMessages: "...",
+     *   optInWorkflow: "...",
+     *   entityType: "SOLE_PROPRIETOR",
+     * });
+     * ```
+     *
+     * @example Partial-update resubmit (only changing email)
+     * ```ts
+     * await sendly.enterprise.workspaces.submitVerification(workspaceId, {
+     *   contact: { email: "new@email.com" },
+     * });
+     * ```
+     */
+    submitVerification(workspaceId: string, data: VerificationSubmitInput): Promise<unknown>;
+    /**
+     * Convenience alias for resubmits. Reads more naturally when you only
+     * want to update a few fields after a rejection.
+     */
+    resubmitVerification(workspaceId: string, partialUpdates: VerificationSubmitInput): Promise<unknown>;
     inheritVerification(workspaceId: string, options: {
         sourceWorkspaceId: string;
     }): Promise<unknown>;
@@ -4080,6 +4151,251 @@ declare class RulesResource {
     delete(id: string): Promise<void>;
 }
 
+/**
+ * Business Upgrade Resource — Entity-Upgrade ("fork-with-new-number")
+ *
+ * @packageDocumentation
+ *
+ * Manages the toll-free business entity upgrade flow: when a customer
+ * forms a new legal entity (e.g. an LLC), this resource lets them
+ * reserve a new toll-free number under the new entity, submit it for
+ * carrier review, and atomically swap to it on approval — without
+ * disrupting outbound SMS during the 1-2 week review window.
+ *
+ * @see https://sendly.live/docs/business-upgrade
+ */
+
+type EntityType = "SOLE_PROPRIETOR" | "PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "NON_PROFIT" | "GOVERNMENT";
+type BrnType = "EIN" | "SSN" | "DUNS" | "CRA" | "VAT" | "LEI" | "OTHER";
+type Disposition = "moved" | "released";
+interface PreflightCandidate {
+    businessName: string;
+    doingBusinessAs?: string;
+    brn: string;
+    brnType: BrnType;
+    brnCountry: string;
+    entityType: EntityType;
+    website?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    addressCountry?: string;
+    contactFirstName?: string;
+    contactLastName?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    monthlyVolume?: string;
+    useCase?: string;
+    useCaseSummary?: string;
+    sampleMessages?: string;
+    optInWorkflow?: string;
+    privacyUrl?: string;
+    termsUrl?: string;
+    additionalInformation?: string;
+    ageGatedContent?: boolean;
+}
+interface PreflightIssue {
+    severity: "blocker" | "warning" | "info";
+    field: string;
+    code: string;
+    message: string;
+    suggestion?: string;
+}
+interface PreflightProposedFix {
+    field: string;
+    current: unknown;
+    proposed: unknown;
+    reason: string;
+}
+interface PreflightReport {
+    verificationId: string;
+    businessName: string | null;
+    country: "CA" | "US" | "OTHER" | "UNKNOWN";
+    verdict: "ready" | "warnings" | "blocked";
+    issues: PreflightIssue[];
+    proposedFixes: PreflightProposedFix[];
+}
+interface StartUpgradeParams {
+    businessName: string;
+    brn: string;
+    brnType: BrnType;
+    brnCountry: string;
+    entityType: EntityType;
+    doingBusinessAs?: string;
+    website?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    addressCountry?: string;
+    contactFirstName?: string;
+    contactLastName?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    monthlyVolume?: string;
+    useCase?: string;
+    useCaseSummary?: string;
+    sampleMessages?: string;
+    optInWorkflow?: string;
+    privacyUrl?: string;
+    termsUrl?: string;
+    additionalInformation?: string;
+    ageGatedContent?: boolean;
+}
+interface EinDocumentInput {
+    /** Buffer containing the PDF bytes */
+    buffer: Buffer | Uint8Array;
+    /** Filename (defaults to "ein-doc.pdf") */
+    filename?: string;
+    /** Content-Type (defaults to "application/pdf") */
+    contentType?: string;
+}
+interface StartUpgradeResponse {
+    success: true;
+    pendingVerificationId: string;
+    telnyxVerificationId: string;
+    tollFreeNumber: string;
+    telnyxMessagingProfileId: string;
+    einDocStored: boolean;
+    message: string;
+}
+interface UpgradeStatusResponse {
+    pending: {
+        id: string;
+        businessName: string;
+        status: string;
+        entityType: string | null;
+        brnType: string | null;
+        brnCountry: string | null;
+        tollFreeNumber: string | null;
+        rejectionReason: string | null;
+        createdAt: string;
+        updatedAt: string;
+    } | null;
+}
+interface CancelUpgradeResponse {
+    success: boolean;
+    cancelled: boolean;
+    cancelledVerificationId?: string;
+    message: string;
+}
+interface ResubmitUpgradeResponse {
+    success: boolean;
+    pendingVerificationId: string;
+    message: string;
+}
+interface DispositionResponse {
+    success: boolean;
+    disposition: Disposition;
+    supersededVerificationId: string;
+    message: string;
+}
+interface BestPrefillResponse {
+    prefill: {
+        monthlyVolume?: string;
+        useCase?: string;
+        useCaseSummary?: string;
+        sampleMessages?: string;
+        optInWorkflow?: string;
+        optInImageUrls?: string;
+        optInSource?: string;
+        privacyUrl?: string;
+        termsUrl?: string;
+        additionalInformation?: string;
+        isvReseller?: string;
+        ageGatedContent?: boolean;
+    };
+    sourceWorkspaceCount: number;
+}
+/**
+ * BusinessUpgrade resource
+ *
+ * @example
+ * ```typescript
+ * // Preview validation before submitting
+ * const preview = await sendly.businessUpgrade.preflight({
+ *   businessName: "Acme Holdings LLC",
+ *   brn: "12-3456789",
+ *   brnType: "EIN",
+ *   brnCountry: "US",
+ *   entityType: "PRIVATE_PROFIT",
+ * });
+ *
+ * // Submit the upgrade with the IRS letter
+ * import { readFileSync } from "fs";
+ * const result = await sendly.businessUpgrade.start("ws_abc", {
+ *   businessName: "Acme Holdings LLC",
+ *   brn: "12-3456789",
+ *   brnType: "EIN",
+ *   brnCountry: "US",
+ *   entityType: "PRIVATE_PROFIT",
+ * }, {
+ *   einDoc: { buffer: readFileSync("./CP-575.pdf"), filename: "CP-575.pdf" }
+ * });
+ * ```
+ */
+declare class BusinessUpgradeResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Validate a candidate entity upgrade payload before submission.
+     * Returns issues + proposed auto-fixes. No writes — purely advisory.
+     */
+    preflight(candidate: PreflightCandidate): Promise<PreflightReport>;
+    /**
+     * Get a "best-of" prefill across all the caller's verified workspaces.
+     * Returns most-recent non-empty values per messaging field. Use this
+     * to pre-populate the upgrade form for users whose current workspace
+     * has incomplete data.
+     */
+    bestPrefill(): Promise<BestPrefillResponse>;
+    /**
+     * Start an entity upgrade for the given workspace. Auto-provisions
+     * a new toll-free number + messaging profile and submits to the
+     * carrier for review. Returns the pending verification details.
+     *
+     * The current toll-free number continues sending throughout the
+     * 1-2 week carrier review; on approval, an atomic swap promotes
+     * the new number.
+     */
+    start(workspaceId: string, params: StartUpgradeParams, options?: {
+        einDoc?: EinDocumentInput;
+    }): Promise<StartUpgradeResponse>;
+    /**
+     * Check whether the given workspace has a pending entity upgrade.
+     * Returns `{ pending: null }` if no upgrade is in flight.
+     */
+    status(workspaceId: string): Promise<UpgradeStatusResponse>;
+    /**
+     * Cancel a pending entity upgrade for the given workspace. Releases
+     * the reserved toll-free number, deletes the new messaging profile,
+     * and removes the stored EIN document. Idempotent.
+     */
+    cancel(workspaceId: string): Promise<CancelUpgradeResponse>;
+    /**
+     * Resubmit a rejected (or waiting-for-customer) entity upgrade with
+     * updated fields and optionally a new EIN document.
+     */
+    resubmit(workspaceId: string, params: Partial<StartUpgradeParams>, options?: {
+        einDoc?: EinDocumentInput;
+    }): Promise<ResubmitUpgradeResponse>;
+    /**
+     * After a successful entity-upgrade approval, choose what happens to
+     * the old toll-free number:
+     *
+     * - `moved`: keep it active under another workspace owned by the
+     *   same user (requires `targetWorkspaceId`)
+     * - `released`: return it to the carrier pool
+     */
+    setDisposition(workspaceId: string, body: {
+        disposition: Disposition;
+        targetWorkspaceId?: string;
+    }): Promise<DispositionResponse>;
+}
+
 /**
  * Sendly Client
  * @packageDocumentation
@@ -4290,6 +4606,31 @@ declare class Sendly {
      * ```
      */
     readonly enterprise: EnterpriseResource;
+    /**
+     * Business Upgrade resource — toll-free entity-upgrade flow.
+     *
+     * @example
+     * ```typescript
+     * // Preview a candidate upgrade before submitting
+     * const preview = await sendly.businessUpgrade.preflight({
+     *   businessName: "Acme Holdings LLC",
+     *   brn: "12-3456789",
+     *   brnType: "EIN",
+     *   brnCountry: "US",
+     *   entityType: "PRIVATE_PROFIT",
+     * });
+     *
+     * // Start an upgrade — auto-reserves a new toll-free number
+     * const { pendingVerificationId } = await sendly.businessUpgrade.start("ws_abc", {
+     *   businessName: "Acme Holdings LLC",
+     *   brn: "12-3456789",
+     *   brnType: "EIN",
+     *   brnCountry: "US",
+     *   entityType: "PRIVATE_PROFIT",
+     * }, { einDoc: { buffer: pdfBuffer } });
+     * ```
+     */
+    readonly businessUpgrade: BusinessUpgradeResource;
     private readonly http;
     private readonly config;
     /**

package/dist/index.js

@@ -3075,25 +3075,59 @@ var WorkspacesSubResource = class {
       path: `/enterprise/workspaces/${encodeURIComponent(workspaceId)}`
     });
   }
+  /**
+   * Submit (or resubmit) a verification for an enterprise workspace.
+   *
+   * Partial-update friendly (May 2026): for resubmit on an existing
+   * workspace, you only need to send the fields you want to change —
+   * everything else is preserved from the existing record. Hosted page
+   * URLs (`/biz/`, `/opt-in/`, `/legal/`) generated during provision
+   * are auto-preserved.
+   *
+   * For sole proprietors, leave `brn`, `brnType`, `brnCountry` undefined
+   * — the server strips them before forwarding to the carrier.
+   *
+   * @example Full submit
+   * ```ts
+   * await sendly.enterprise.workspaces.submitVerification(workspaceId, {
+   *   businessName: "Acme LLC",
+   *   website: "https://acme.com",
+   *   address: { street: "...", city: "...", state: "California", zip: "90001", country: "US" },
+   *   contact: { firstName: "...", lastName: "...", email: "...", phone: "+15551234567" },
+   *   useCase: "Insurance Services",
+   *   useCaseSummary: "...",
+   *   sampleMessages: "...",
+   *   optInWorkflow: "...",
+   *   entityType: "SOLE_PROPRIETOR",
+   * });
+   * ```
+   *
+   * @example Partial-update resubmit (only changing email)
+   * ```ts
+   * await sendly.enterprise.workspaces.submitVerification(workspaceId, {
+   *   contact: { email: "new@email.com" },
+   * });
+   * ```
+   */
   async submitVerification(workspaceId, data) {
+    const body = {};
+    for (const [k, v] of Object.entries(data)) {
+      if (v !== void 0) body[k] = v;
+    }
     const response = await this.http.request({
       method: "POST",
       path: `/enterprise/workspaces/${encodeURIComponent(workspaceId)}/verification/submit`,
-      body: {
-        business_name: data.businessName,
-        business_type: data.businessType,
-        ein: data.ein,
-        address: data.address,
-        city: data.city,
-        state: data.state,
-        zip: data.zip,
-        use_case: data.useCase,
-        sample_messages: data.sampleMessages,
-        ...data.monthlyVolume && { monthly_volume: data.monthlyVolume }
-      }
+      body
     });
     return transformKeys(response);
   }
+  /**
+   * Convenience alias for resubmits. Reads more naturally when you only
+   * want to update a few fields after a rejection.
+   */
+  async resubmitVerification(workspaceId, partialUpdates) {
+    return this.submitVerification(workspaceId, partialUpdates);
+  }
   async inheritVerification(workspaceId, options) {
     const response = await this.http.request({
       method: "POST",
@@ -3783,6 +3817,130 @@ var RulesResource = class {
   }
 };
 
+// src/resources/businessUpgrade.ts
+var BusinessUpgradeResource = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Validate a candidate entity upgrade payload before submission.
+   * Returns issues + proposed auto-fixes. No writes — purely advisory.
+   */
+  async preflight(candidate) {
+    return this.http.request({
+      method: "POST",
+      path: "/verification/preflight",
+      body: candidate
+    });
+  }
+  /**
+   * Get a "best-of" prefill across all the caller's verified workspaces.
+   * Returns most-recent non-empty values per messaging field. Use this
+   * to pre-populate the upgrade form for users whose current workspace
+   * has incomplete data.
+   */
+  async bestPrefill() {
+    return this.http.request({
+      method: "GET",
+      path: "/verification/best-prefill"
+    });
+  }
+  /**
+   * Start an entity upgrade for the given workspace. Auto-provisions
+   * a new toll-free number + messaging profile and submits to the
+   * carrier for review. Returns the pending verification details.
+   *
+   * The current toll-free number continues sending throughout the
+   * 1-2 week carrier review; on approval, an atomic swap promotes
+   * the new number.
+   */
+  async start(workspaceId, params, options) {
+    const form = new FormData();
+    for (const [k, v] of Object.entries(params)) {
+      if (v === void 0 || v === null) continue;
+      form.append(k, typeof v === "boolean" ? String(v) : v);
+    }
+    if (options?.einDoc) {
+      const blob = new Blob([options.einDoc.buffer], {
+        type: options.einDoc.contentType || "application/pdf"
+      });
+      form.append(
+        "einDoc",
+        blob,
+        options.einDoc.filename || "ein-doc.pdf"
+      );
+    }
+    return this.http.requestFormData(
+      `/workspaces/${encodeURIComponent(workspaceId)}/upgrade`,
+      form
+    );
+  }
+  /**
+   * Check whether the given workspace has a pending entity upgrade.
+   * Returns `{ pending: null }` if no upgrade is in flight.
+   */
+  async status(workspaceId) {
+    return this.http.request({
+      method: "GET",
+      path: `/workspaces/${encodeURIComponent(workspaceId)}/upgrade/status`
+    });
+  }
+  /**
+   * Cancel a pending entity upgrade for the given workspace. Releases
+   * the reserved toll-free number, deletes the new messaging profile,
+   * and removes the stored EIN document. Idempotent.
+   */
+  async cancel(workspaceId) {
+    return this.http.request({
+      method: "POST",
+      path: `/workspaces/${encodeURIComponent(workspaceId)}/upgrade/cancel`
+    });
+  }
+  /**
+   * Resubmit a rejected (or waiting-for-customer) entity upgrade with
+   * updated fields and optionally a new EIN document.
+   */
+  async resubmit(workspaceId, params, options) {
+    const form = new FormData();
+    for (const [k, v] of Object.entries(params)) {
+      if (v === void 0 || v === null) continue;
+      form.append(k, typeof v === "boolean" ? String(v) : v);
+    }
+    if (options?.einDoc) {
+      const blob = new Blob([options.einDoc.buffer], {
+        type: options.einDoc.contentType || "application/pdf"
+      });
+      form.append(
+        "einDoc",
+        blob,
+        options.einDoc.filename || "ein-doc.pdf"
+      );
+    }
+    return this.http.requestFormData(
+      `/workspaces/${encodeURIComponent(workspaceId)}/upgrade/resubmit`,
+      form
+    );
+  }
+  /**
+   * After a successful entity-upgrade approval, choose what happens to
+   * the old toll-free number:
+   *
+   * - `moved`: keep it active under another workspace owned by the
+   *   same user (requires `targetWorkspaceId`)
+   * - `released`: return it to the carrier pool
+   */
+  async setDisposition(workspaceId, body) {
+    return this.http.request({
+      method: "POST",
+      path: `/workspaces/${encodeURIComponent(workspaceId)}/upgrade/disposition`,
+      body: {
+        disposition: body.disposition,
+        targetOrgId: body.targetWorkspaceId
+      }
+    });
+  }
+};
+
 // src/client.ts
 var DEFAULT_BASE_URL2 = "https://sendly.live/api/v1";
 var DEFAULT_TIMEOUT2 = 3e4;
@@ -3961,6 +4119,31 @@ var Sendly = class {
    * ```
    */
   enterprise;
+  /**
+   * Business Upgrade resource — toll-free entity-upgrade flow.
+   *
+   * @example
+   * ```typescript
+   * // Preview a candidate upgrade before submitting
+   * const preview = await sendly.businessUpgrade.preflight({
+   *   businessName: "Acme Holdings LLC",
+   *   brn: "12-3456789",
+   *   brnType: "EIN",
+   *   brnCountry: "US",
+   *   entityType: "PRIVATE_PROFIT",
+   * });
+   *
+   * // Start an upgrade — auto-reserves a new toll-free number
+   * const { pendingVerificationId } = await sendly.businessUpgrade.start("ws_abc", {
+   *   businessName: "Acme Holdings LLC",
+   *   brn: "12-3456789",
+   *   brnType: "EIN",
+   *   brnCountry: "US",
+   *   entityType: "PRIVATE_PROFIT",
+   * }, { einDoc: { buffer: pdfBuffer } });
+   * ```
+   */
+  businessUpgrade;
   http;
   config;
   /**
@@ -4004,6 +4187,7 @@ var Sendly = class {
     this.contacts = new ContactsResource(this.http);
     this.media = new MediaResource(this.http);
     this.enterprise = new EnterpriseResource(this.http);
+    this.businessUpgrade = new BusinessUpgradeResource(this.http);
   }
   /**
    * Check if the client is using a test API key