@sendly/node 3.30.0 → 3.33.0

package/README.md

@@ -185,8 +185,8 @@ const preview = await sendly.messages.previewBatch({
     { to: '+447700900123', text: 'Hello UK!' }
   ]
 });
-console.log(`Total credits needed: ${preview.totalCredits}`);
-console.log(`Valid: ${preview.valid}, Invalid: ${preview.invalid}`);
+console.log(`Credits needed: ${preview.creditsNeeded}`);
+console.log(`Will send: ${preview.willSend}, Blocked: ${preview.blocked}`);
 ```
 
 ### Rate Limit Information
@@ -233,7 +233,7 @@ const webhook = await sendly.webhooks.create({
 });
 
 console.log(`Webhook ID: ${webhook.id}`);
-console.log(`Secret: ${webhook.secret}`); // Store this securely!
+console.log(`Secret: ${webhook.secret}`); // Only returned at creation - store securely!
 
 // List all webhooks
 const webhooks = await sendly.webhooks.list();
@@ -275,10 +275,11 @@ const webhooks = new Webhooks('your_webhook_secret');
 // In your webhook handler
 app.post('/webhooks/sendly', (req, res) => {
   const signature = req.headers['x-sendly-signature'];
+  const timestamp = req.headers['x-sendly-timestamp'];
   const payload = req.body;
 
   try {
-    const event = webhooks.verifyAndParse(payload, signature);
+    const event = webhooks.parse(payload, signature, timestamp);
     
     switch (event.type) {
       case 'message.delivered':
@@ -311,13 +312,13 @@ console.log(`Reserved (scheduled): ${credits.reservedBalance} credits`);
 console.log(`Total: ${credits.balance} credits`);
 
 // View credit transaction history
-const { data: transactions } = await sendly.account.getCreditTransactions();
+const transactions = await sendly.account.getCreditTransactions();
 for (const tx of transactions) {
   console.log(`${tx.type}: ${tx.amount} credits - ${tx.description}`);
 }
 
 // List API keys
-const { data: keys } = await sendly.account.listApiKeys();
+const keys = await sendly.account.listApiKeys();
 for (const key of keys) {
   console.log(`${key.name}: ${key.prefix}*** (${key.type})`);
 }
@@ -328,12 +329,9 @@ console.log(`Messages sent: ${usage.messagesSent}`);
 console.log(`Credits used: ${usage.creditsUsed}`);
 
 // Create a new API key
-const newKey = await sendly.account.createApiKey({
-  name: 'Production Key',
-  type: 'live',
-  scopes: ['sms:send', 'sms:read']
-});
-console.log(`New key: ${newKey.key}`); // Only shown once!
+const { apiKey, key } = await sendly.account.createApiKey('Production Key');
+console.log(`New key: ${key}`); // Only shown once!
+console.log(`Key ID: ${apiKey.id}`);
 
 // Revoke an API key
 await sendly.account.revokeApiKey('key_xxx');
@@ -525,11 +523,11 @@ List scheduled messages.
 
 Get a scheduled message by ID.
 
-#### `cancelScheduled(id: string): Promise<CancelScheduledMessageResponse>`
+#### `cancelScheduled(id: string): Promise<CancelledMessageResponse>`
 
 Cancel a scheduled message and refund credits.
 
-#### `sendBatch(request: SendBatchRequest): Promise<BatchMessageResponse>`
+#### `sendBatch(request: BatchMessageRequest): Promise<BatchMessageResponse>`
 
 Send multiple messages in one API call.
 
@@ -543,9 +541,9 @@ List all batches.
 
 ### `sendly.webhooks`
 
-#### `create(request: CreateWebhookRequest): Promise<Webhook>`
+#### `create(options: CreateWebhookOptions): Promise<WebhookCreatedResponse>`
 
-Create a new webhook endpoint.
+Create a new webhook endpoint. The returned object includes a one-time `secret`.
 
 #### `list(): Promise<Webhook[]>`
 
@@ -555,7 +553,7 @@ List all webhooks.
 
 Get a webhook by ID.
 
-#### `update(id: string, request: UpdateWebhookRequest): Promise<Webhook>`
+#### `update(id: string, options: UpdateWebhookOptions): Promise<Webhook>`
 
 Update a webhook.
 
@@ -589,11 +587,11 @@ Get account information.
 
 Get credit balance.
 
-#### `getCreditTransactions(): Promise<CreditTransactionListResponse>`
+#### `getCreditTransactions(options?: { limit?: number; offset?: number }): Promise<CreditTransaction[]>`
 
 Get credit transaction history.
 
-#### `listApiKeys(): Promise<ApiKeyListResponse>`
+#### `listApiKeys(): Promise<ApiKey[]>`
 
 List API keys.
 
@@ -662,25 +660,27 @@ await client.enterprise.workspaces.delete('ws_xxx');
 // Submit full verification
 await client.enterprise.workspaces.submitVerification('ws_xxx', {
   businessName: 'Acme Insurance LLC',
-  businessType: 'llc',
-  ein: '12-3456789',
-  address: '100 Main St',
-  city: 'Austin',
-  state: 'TX',
-  zip: '78701',
+  website: 'https://acme.com',
+  entityType: 'PRIVATE_PROFIT',
+  brn: '12-3456789',
+  brnType: 'EIN',
+  brnCountry: 'US',
+  address: { street: '100 Main St', city: 'Austin', state: 'TX', zip: '78701', country: 'US' },
+  contact: { firstName: 'Jane', lastName: 'Doe', email: 'jane@acme.com', phone: '+15551234567' },
   useCase: 'Policy renewal reminders',
-  sampleMessages: ['Your policy renews on 3/15.']
+  sampleMessages: 'Your policy renews on 3/15.'
 });
 
-// Inherit from verified workspace
+// Inherit from verified workspace (shares toll-free number)
 await client.enterprise.workspaces.inheritVerification('ws_new', {
   sourceWorkspaceId: 'ws_verified'
 });
 
-// Inherit with new number
-await client.enterprise.workspaces.inheritVerification('ws_new', {
+// Inherit + new number: use provision() with inheritWithNewNumber instead
+await client.enterprise.provision({
+  name: 'Acme Insurance - Austin',
   sourceWorkspaceId: 'ws_verified',
-  purchaseNewNumber: true
+  inheritWithNewNumber: true
 });
 ```
 

package/dist/index.d.mts

@@ -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;
     /**