quickbase-js 2.1.0 → 2.2.1

package/dist/xml/users.js

@@ -0,0 +1,166 @@
+/**
+ * XML API User Management
+ *
+ * Endpoints for managing users and user-related operations.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import { checkError } from './errors.js';
+import { buildRequest, escapeXml, parseBaseResponse, getTagContent, parseXmlBool, } from './request.js';
+/**
+ * Get user information by email.
+ *
+ * Returns user ID, name, and other details for a registered QuickBase user.
+ * If no email is provided, returns info for the current user.
+ *
+ * @see https://help.quickbase.com/docs/api-getuserinfo
+ *
+ * @example
+ * ```typescript
+ * // Get info for specific user
+ * const user = await getUserInfo(caller, 'user@example.com');
+ * console.log(`User ID: ${user.id}, Name: ${user.firstName} ${user.lastName}`);
+ *
+ * // Get info for current user
+ * const me = await getUserInfo(caller);
+ * ```
+ */
+export async function getUserInfo(caller, email) {
+    let inner = '';
+    if (email) {
+        inner = `<email>${escapeXml(email)}</email>`;
+    }
+    const body = buildRequest(inner);
+    const xml = await caller.doXml('main', 'API_GetUserInfo', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    // Parse user element
+    const userMatch = xml.match(/<user[^>]*id="([^"]*)"[^>]*>([\s\S]*?)<\/user>/);
+    if (!userMatch || !userMatch[1]) {
+        throw new Error('Invalid API_GetUserInfo response: no user element');
+    }
+    const userXml = userMatch[0];
+    const id = userMatch[1];
+    const firstName = getTagContent(userXml, 'firstName');
+    const lastName = getTagContent(userXml, 'lastName');
+    const login = getTagContent(userXml, 'login') || undefined;
+    const userEmail = getTagContent(userXml, 'email') || undefined;
+    const screenName = getTagContent(userXml, 'screenName') || undefined;
+    const isVerifiedStr = getTagContent(userXml, 'isVerified');
+    const isVerified = isVerifiedStr ? parseXmlBool(isVerifiedStr) : undefined;
+    const externalAuthStr = getTagContent(userXml, 'externalAuth');
+    const externalAuth = externalAuthStr ? parseXmlBool(externalAuthStr) : undefined;
+    return {
+        id,
+        firstName,
+        lastName,
+        login,
+        email: userEmail,
+        screenName,
+        isVerified,
+        externalAuth,
+    };
+}
+/**
+ * Create a new unregistered user and add them to an application.
+ *
+ * This is for users who are NOT yet registered with QuickBase.
+ * For existing users, use getUserInfo + addUserToRole + sendInvitation.
+ *
+ * After provisioning, call sendInvitation to email the user.
+ *
+ * @see https://help.quickbase.com/docs/api-provisionuser
+ *
+ * @example
+ * ```typescript
+ * const result = await provisionUser(caller, 'bqxyz123', 'new@example.com', 'John', 'Doe', 11);
+ * console.log(`Created user: ${result.userId}`);
+ *
+ * // Now send invitation
+ * await sendInvitation(caller, 'bqxyz123', result.userId, 'Welcome to our app!');
+ * ```
+ */
+export async function provisionUser(caller, appId, email, firstName, lastName, roleId) {
+    let inner = `<email>${escapeXml(email)}</email>` +
+        `<fname>${escapeXml(firstName)}</fname>` +
+        `<lname>${escapeXml(lastName)}</lname>`;
+    if (roleId !== undefined) {
+        inner += `<roleid>${roleId}</roleid>`;
+    }
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_ProvisionUser', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    const userId = getTagContent(xml, 'userid');
+    if (!userId) {
+        throw new Error('Invalid API_ProvisionUser response: no userid element');
+    }
+    return { userId };
+}
+/**
+ * Send an invitation email to a user.
+ *
+ * Use after adding a user to a role (via addUserToRole or provisionUser).
+ *
+ * @see https://help.quickbase.com/docs/api-sendinvitation
+ *
+ * @example
+ * ```typescript
+ * await sendInvitation(caller, 'bqxyz123', '112149.bhsv', 'Welcome to our team app!');
+ * ```
+ */
+export async function sendInvitation(caller, appId, userId, userText) {
+    let inner = `<userid>${escapeXml(userId)}</userid>`;
+    if (userText) {
+        inner += `<usertext>${escapeXml(userText)}</usertext>`;
+    }
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_SendInvitation', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+/**
+ * Change the application manager.
+ *
+ * Requires account admin or realm admin permissions.
+ *
+ * @see https://help.quickbase.com/docs/api-changemanager
+ *
+ * @example
+ * ```typescript
+ * await changeManager(caller, 'bqxyz123', 'newmanager@example.com');
+ * ```
+ */
+export async function changeManager(caller, appId, newManagerEmail) {
+    const inner = `<newmgr>${escapeXml(newManagerEmail)}</newmgr>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(appId, 'API_ChangeManager', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+/**
+ * Change the owner of a record.
+ *
+ * Transfers ownership from the current record owner to another user.
+ * Requires Full Administration rights on the application.
+ *
+ * @see https://help.quickbase.com/docs/api-changerecordowner
+ *
+ * @param newOwner - The new owner's QuickBase username or email address
+ *
+ * @example
+ * ```typescript
+ * // By record ID
+ * await changeRecordOwner(caller, 'bqtable123', 42, 'newowner@example.com');
+ * ```
+ */
+export async function changeRecordOwner(caller, tableId, recordId, newOwner) {
+    const inner = `<rid>${recordId}</rid>` +
+        `<newowner>${escapeXml(newOwner)}</newowner>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_ChangeRecordOwner', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+//# sourceMappingURL=users.js.map

package/dist/xml/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/xml/users.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,YAAY,GACb,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAiB,EACjB,KAAc;IAEd,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,KAAK,EAAE,CAAC;QACV,KAAK,GAAG,UAAU,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;IAC/C,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEhE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,qBAAqB;IACrB,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;IAC9E,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,SAAS,CAAC;IAC3D,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,SAAS,CAAC;IAC/D,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,SAAS,CAAC;IACrE,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,MAAM,eAAe,GAAG,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEjF,OAAO;QACL,EAAE;QACF,SAAS;QACT,QAAQ;QACR,KAAK;QACL,KAAK,EAAE,SAAS;QAChB,UAAU;QACV,UAAU;QACV,YAAY;KACb,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAiB,EACjB,KAAa,EACb,KAAa,EACb,SAAiB,EACjB,QAAgB,EAChB,MAAe;IAEf,IAAI,KAAK,GACP,UAAU,SAAS,CAAC,KAAK,CAAC,UAAU;QACpC,UAAU,SAAS,CAAC,SAAS,CAAC,UAAU;QACxC,UAAU,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC;IAE1C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,KAAK,IAAI,WAAW,MAAM,WAAW,CAAC;IACxC,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAEjE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAiB,EACjB,KAAa,EACb,MAAc,EACd,QAAiB;IAEjB,IAAI,KAAK,GAAG,WAAW,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC;IACpD,IAAI,QAAQ,EAAE,CAAC;QACb,KAAK,IAAI,aAAa,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC;IACzD,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;IAElE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAiB,EACjB,KAAa,EACb,eAAuB;IAEvB,MAAM,KAAK,GAAG,WAAW,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC;IAC/D,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAEjE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAiB,EACjB,OAAe,EACf,QAAgB,EAChB,QAAgB;IAEhB,MAAM,KAAK,GACT,QAAQ,QAAQ,QAAQ;QACxB,aAAa,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC;IAChD,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,CAAC,CAAC;IAEvE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC"}

package/dist/xml/webhooks.d.ts

@@ -0,0 +1,98 @@
+/**
+ * XML API Webhooks
+ *
+ * Endpoints for managing webhooks.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import type { XmlCaller, WebhooksCreateOptions, WebhooksEditOptions } from './types.js';
+/**
+ * Create a webhook.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-create
+ *
+ * @example
+ * ```typescript
+ * await webhooksCreate(caller, 'bqtable123', {
+ *   label: 'Notify on new records',
+ *   webhookUrl: 'https://example.com/webhook',
+ *   workflowWhen: 'a',
+ *   messageFormat: 'JSON',
+ *   headers: [{ key: 'Content-Type', value: 'application/json' }],
+ * });
+ * ```
+ */
+export declare function webhooksCreate(caller: XmlCaller, tableId: string, options: WebhooksCreateOptions): Promise<void>;
+/**
+ * Edit a webhook.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-edit
+ *
+ * @example
+ * ```typescript
+ * await webhooksEdit(caller, 'bqtable123', '15', {
+ *   label: 'Updated webhook name',
+ *   webhookUrl: 'https://example.com/new-endpoint',
+ *   messageFormat: 'JSON',
+ * });
+ * ```
+ */
+export declare function webhooksEdit(caller: XmlCaller, tableId: string, actionId: string, options: WebhooksEditOptions): Promise<void>;
+/**
+ * Delete webhooks.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-delete
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksDelete(caller, 'bqtable123', ['15', '16']);
+ * console.log(`Deleted ${result.numChanged} webhooks`);
+ * ```
+ */
+export declare function webhooksDelete(caller: XmlCaller, tableId: string, actionIds: string[]): Promise<{
+    numChanged: number;
+}>;
+/**
+ * Activate webhooks.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-activate
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksActivate(caller, 'bqtable123', ['15']);
+ * console.log(`Activated ${result.numChanged} webhooks`);
+ * ```
+ */
+export declare function webhooksActivate(caller: XmlCaller, tableId: string, actionIds: string[]): Promise<{
+    numChanged: number;
+}>;
+/**
+ * Deactivate webhooks.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-deactivate
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksDeactivate(caller, 'bqtable123', ['15']);
+ * console.log(`Deactivated ${result.numChanged} webhooks`);
+ * ```
+ */
+export declare function webhooksDeactivate(caller: XmlCaller, tableId: string, actionIds: string[]): Promise<{
+    numChanged: number;
+}>;
+/**
+ * Copy a webhook.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-copy
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksCopy(caller, 'bqtable123', '15');
+ * console.log(`Created webhook copy with ID: ${result.actionId}`);
+ * ```
+ */
+export declare function webhooksCopy(caller: XmlCaller, tableId: string, actionId: string): Promise<{
+    actionId: string;
+}>;
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/xml/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/xml/webhooks.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAsEpB;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAcjC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAcjC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAcjC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAW/B"}

package/dist/xml/webhooks.js

@@ -0,0 +1,202 @@
+/**
+ * XML API Webhooks
+ *
+ * Endpoints for managing webhooks.
+ *
+ * XML-API: Remove this file when QuickBase discontinues the XML API.
+ * To find all XML API code, search for: XML-API
+ */
+import { checkError } from './errors.js';
+import { buildRequest, escapeXml, parseBaseResponse, getTagContent, parseXmlNumber, } from './request.js';
+/**
+ * Build webhook XML from create options
+ */
+function buildWebhookCreateXml(options) {
+    let inner = `<label>${escapeXml(options.label)}</label>`;
+    inner += `<WebhookURL>${escapeXml(options.webhookUrl)}</WebhookURL>`;
+    if (options.description) {
+        inner += `<Description>${escapeXml(options.description)}</Description>`;
+    }
+    if (options.query) {
+        inner += `<Query>${escapeXml(options.query)}</Query>`;
+    }
+    if (options.workflowWhen) {
+        inner += `<WorkflowWhen>${escapeXml(options.workflowWhen)}</WorkflowWhen>`;
+    }
+    if (options.headers && options.headers.length > 0) {
+        inner += `<WebhookHeaderCount>${options.headers.length}</WebhookHeaderCount>`;
+        options.headers.forEach((h, i) => {
+            inner += `<WebhookHeaderKey${i + 1}>${escapeXml(h.key)}</WebhookHeaderKey${i + 1}>`;
+            inner += `<WebhookHeaderValue${i + 1}>${escapeXml(h.value)}</WebhookHeaderValue${i + 1}>`;
+        });
+    }
+    if (options.message) {
+        inner += `<WebhookMessage>${escapeXml(options.message)}</WebhookMessage>`;
+    }
+    if (options.messageFormat) {
+        inner += `<WebhookMessageFormat>${options.messageFormat}</WebhookMessageFormat>`;
+    }
+    if (options.httpVerb) {
+        inner += `<WebhookHTTPVerb>${options.httpVerb}</WebhookHTTPVerb>`;
+    }
+    if (options.triggerFields && options.triggerFields.length > 0) {
+        inner += '<tfidsWhich>TRUE</tfidsWhich>';
+        for (const fid of options.triggerFields) {
+            inner += `<tfids>${fid}</tfids>`;
+        }
+    }
+    return inner;
+}
+/**
+ * Build webhook XML from edit options
+ */
+function buildWebhookEditXml(actionId, options) {
+    let inner = `<actionId>${escapeXml(actionId)}</actionId>`;
+    inner += buildWebhookCreateXml(options);
+    // Handle clearing trigger fields
+    if (options.clearTriggerFields) {
+        // Remove any tfidsWhich/tfids we just added and replace with clear
+        inner = inner.replace(/<tfidsWhich>TRUE<\/tfidsWhich>/, '');
+        inner = inner.replace(/<tfids>\d+<\/tfids>/g, '');
+        inner += '<tfidsWhich>tfidsAny</tfidsWhich>';
+    }
+    return inner;
+}
+/**
+ * Create a webhook.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-create
+ *
+ * @example
+ * ```typescript
+ * await webhooksCreate(caller, 'bqtable123', {
+ *   label: 'Notify on new records',
+ *   webhookUrl: 'https://example.com/webhook',
+ *   workflowWhen: 'a',
+ *   messageFormat: 'JSON',
+ *   headers: [{ key: 'Content-Type', value: 'application/json' }],
+ * });
+ * ```
+ */
+export async function webhooksCreate(caller, tableId, options) {
+    const inner = buildWebhookCreateXml(options);
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_Webhooks_Create', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+/**
+ * Edit a webhook.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-edit
+ *
+ * @example
+ * ```typescript
+ * await webhooksEdit(caller, 'bqtable123', '15', {
+ *   label: 'Updated webhook name',
+ *   webhookUrl: 'https://example.com/new-endpoint',
+ *   messageFormat: 'JSON',
+ * });
+ * ```
+ */
+export async function webhooksEdit(caller, tableId, actionId, options) {
+    const inner = buildWebhookEditXml(actionId, options);
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_Webhooks_Edit', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+}
+/**
+ * Delete webhooks.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-delete
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksDelete(caller, 'bqtable123', ['15', '16']);
+ * console.log(`Deleted ${result.numChanged} webhooks`);
+ * ```
+ */
+export async function webhooksDelete(caller, tableId, actionIds) {
+    if (actionIds.length === 0) {
+        throw new Error('actionIds array cannot be empty');
+    }
+    const inner = `<actionIDList>${actionIds.join(',')}</actionIDList>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_Webhooks_Delete', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return {
+        numChanged: parseXmlNumber(getTagContent(xml, 'numChanged')),
+    };
+}
+/**
+ * Activate webhooks.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-activate
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksActivate(caller, 'bqtable123', ['15']);
+ * console.log(`Activated ${result.numChanged} webhooks`);
+ * ```
+ */
+export async function webhooksActivate(caller, tableId, actionIds) {
+    if (actionIds.length === 0) {
+        throw new Error('actionIds array cannot be empty');
+    }
+    const inner = `<actionIDList>${actionIds.join(',')}</actionIDList>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_Webhooks_Activate', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return {
+        numChanged: parseXmlNumber(getTagContent(xml, 'numChanged')),
+    };
+}
+/**
+ * Deactivate webhooks.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-deactivate
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksDeactivate(caller, 'bqtable123', ['15']);
+ * console.log(`Deactivated ${result.numChanged} webhooks`);
+ * ```
+ */
+export async function webhooksDeactivate(caller, tableId, actionIds) {
+    if (actionIds.length === 0) {
+        throw new Error('actionIds array cannot be empty');
+    }
+    const inner = `<actionIDList>${actionIds.join(',')}</actionIDList>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_Webhooks_Deactivate', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return {
+        numChanged: parseXmlNumber(getTagContent(xml, 'numChanged')),
+    };
+}
+/**
+ * Copy a webhook.
+ *
+ * @see https://help.quickbase.com/docs/api-webhooks-copy
+ *
+ * @example
+ * ```typescript
+ * const result = await webhooksCopy(caller, 'bqtable123', '15');
+ * console.log(`Created webhook copy with ID: ${result.actionId}`);
+ * ```
+ */
+export async function webhooksCopy(caller, tableId, actionId) {
+    const inner = `<actionId>${escapeXml(actionId)}</actionId>`;
+    const body = buildRequest(inner);
+    const xml = await caller.doXml(tableId, 'API_Webhooks_Copy', body);
+    const base = parseBaseResponse(xml);
+    checkError(base);
+    return {
+        actionId: getTagContent(xml, 'actionId'),
+    };
+}
+//# sourceMappingURL=webhooks.js.map

package/dist/xml/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/xml/webhooks.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB;;GAEG;AACH,SAAS,qBAAqB,CAAC,OAA8B;IAC3D,IAAI,KAAK,GAAG,UAAU,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IACzD,KAAK,IAAI,eAAe,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC;IAErE,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,KAAK,IAAI,gBAAgB,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC;IAC1E,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,KAAK,IAAI,UAAU,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IACxD,CAAC;IACD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,KAAK,IAAI,iBAAiB,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC;IAC7E,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,IAAI,uBAAuB,OAAO,CAAC,OAAO,CAAC,MAAM,uBAAuB,CAAC;QAC9E,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/B,KAAK,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC;YACpF,KAAK,IAAI,sBAAsB,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,CAAC,GAAG,CAAC;QAC5F,CAAC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,KAAK,IAAI,mBAAmB,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAC5E,CAAC;IACD,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,KAAK,IAAI,yBAAyB,OAAO,CAAC,aAAa,yBAAyB,CAAC;IACnF,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,IAAI,oBAAoB,OAAO,CAAC,QAAQ,oBAAoB,CAAC;IACpE,CAAC;IACD,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9D,KAAK,IAAI,+BAA+B,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACxC,KAAK,IAAI,UAAU,GAAG,UAAU,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAC,QAAgB,EAAE,OAA4B;IACzE,IAAI,KAAK,GAAG,aAAa,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC1D,KAAK,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAExC,iCAAiC;IACjC,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QAC/B,mEAAmE;QACnE,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,gCAAgC,EAAE,EAAE,CAAC,CAAC;QAC5D,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QAClD,KAAK,IAAI,mCAAmC,CAAC;IAC/C,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAiB,EACjB,OAAe,EACf,OAA8B;IAE9B,MAAM,KAAK,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,CAAC,CAAC;IAErE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAiB,EACjB,OAAe,EACf,QAAgB,EAChB,OAA4B;IAE5B,MAAM,KAAK,GAAG,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAEnE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAiB,EACjB,OAAe,EACf,SAAmB;IAEnB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACpE,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,CAAC,CAAC;IAErE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO;QACL,UAAU,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAiB,EACjB,OAAe,EACf,SAAmB;IAEnB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACpE,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,CAAC,CAAC;IAEvE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO;QACL,UAAU,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAiB,EACjB,OAAe,EACf,SAAmB;IAEnB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACpE,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,yBAAyB,EAAE,IAAI,CAAC,CAAC;IAEzE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO;QACL,UAAU,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAiB,EACjB,OAAe,EACf,QAAgB;IAEhB,MAAM,KAAK,GAAG,aAAa,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC5D,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAEnE,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEjB,OAAO;QACL,QAAQ,EAAE,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC;KACzC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickbase-js",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "TypeScript/JavaScript client for the QuickBase JSON RESTful API",
   "type": "module",
   "main": "dist/index.js",
@@ -14,8 +14,12 @@
       "browser": "./dist/quickbase.min.js"
     }
   },
+  "bin": {
+    "quickbase-js": "./bin/quickbase-js.js"
+  },
   "files": [
     "dist",
+    "bin",
     "README.md",
     "LICENSE"
   ],
@@ -64,7 +68,7 @@
     "node": ">=18.0.0"
   },
   "devDependencies": {
-    "@types/node": "^20.0.0",
+    "@types/node": "^24.10.1",
     "dotenv": "^17.2.3",
     "esbuild": "^0.27.0",
     "tsx": "^4.7.0",