@unboundcx/sdk 4.4.0 → 4.6.0

package/services/objects.js

@@ -30,6 +30,8 @@ export class ObjectsService {
    * re-subscribe, revoked teardown).
    *
    * sdk.objects.liveQuery({ socket, object, filter, fields, recordTypeId, onEvent, onStateChange })
+   * sdk.objects.liveQuery({ socket, uoql, onEvent, onStateChange }) // uoql is mutually
+   *   exclusive with object/filter/fields/recordTypeId
    * -> Promise<{ subscriptionId, mode, unsubscribe() }>
    */
   liveQuery(args) {
@@ -209,25 +211,27 @@ export class ObjectsService {
    * Update an object record by ID
    *
    * Preferred usage (new signature):
-   * sdk.objects.updateById({ object: 'users', id: 'userId', update: { name: 'Jane' } })
+   * sdk.objects.updateById({ object: 'users', id: 'userId', update: { name: 'Jane' }, skipTriggers: true })
    *
    * Legacy usage (deprecated, but supported):
    * sdk.objects.updateById('users', 'userId', { name: 'Jane' })
    *
    * @param {object} args - Update parameters
+   * @param {boolean} [args.skipTriggers=false] - Skip trigger execution for this write
    * @returns {Promise} Updated object data
    */
   async updateById(...args) {
-    // New signature: updateById({ object, id, update })
+    // New signature: updateById({ object, id, update, skipTriggers })
     if (args.length === 1 && typeof args[0] === 'object' && args[0].object) {
-      const { object, id, update } = args[0];
+      const { object, id, update, skipTriggers = false } = args[0];
 
       this.sdk.validateParams(
-        { object, id, update },
+        { object, id, update, skipTriggers },
         {
           object: { type: 'string', required: true },
           id: { type: 'string', required: true },
           update: { type: 'object', required: true },
+          skipTriggers: { type: 'boolean', required: false },
         },
       );
 
@@ -237,6 +241,7 @@ export class ObjectsService {
           update,
         },
       };
+      if (skipTriggers) params.query = { skipTriggers: true };
 
       return await this.sdk._fetch(`/object/${object}`, 'PUT', params);
     }
@@ -267,13 +272,32 @@ export class ObjectsService {
     throw new Error('Invalid arguments for updateById method');
   }
 
-  async update({ object, where, update }) {
+  /**
+   * Update records matching a where clause.
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {object} args.where
+   * @param {object} args.update
+   * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @returns {Promise} Update result
+   *
+   * @example
+   * await sdk.objects.update({
+   *   object: 'people',
+   *   where: { id: '013…' },
+   *   update: { leadScore: 200 },
+   *   skipTriggers: true,
+   * });
+   */
+  async update({ object, where, update, skipTriggers = false }) {
     this.sdk.validateParams(
-      { object, where, update },
+      { object, where, update, skipTriggers },
       {
         object: { type: 'string', required: true },
         where: { type: 'object', required: true },
         update: { type: 'object', required: true },
+        skipTriggers: { type: 'boolean', required: false },
       },
     );
 
@@ -283,6 +307,7 @@ export class ObjectsService {
         update,
       },
     };
+    if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await this.sdk._fetch(`/object/${object}`, 'PUT', params);
     return result;
@@ -292,28 +317,31 @@ export class ObjectsService {
    * Create a new object record
    *
    * Preferred usage (new signature):
-   * sdk.objects.create({ object: 'users', body: { name: 'John', email: 'john@example.com' } })
+   * sdk.objects.create({ object: 'users', body: { name: 'John', email: 'john@example.com' }, skipTriggers: true })
    *
    * Legacy usage (deprecated, but supported):
    * sdk.objects.create('users', { name: 'John', email: 'john@example.com' })
    *
    * @param {object} args - Creation parameters
+   * @param {boolean} [args.skipTriggers=false] - Skip trigger execution for this write
    * @returns {Promise} Created object data
    */
   async create(...args) {
-    // New signature: create({ object, body })
+    // New signature: create({ object, body, skipTriggers })
     if (args.length === 1 && typeof args[0] === 'object' && args[0].object) {
-      const { object, body } = args[0];
+      const { object, body, skipTriggers = false } = args[0];
 
       this.sdk.validateParams(
-        { object, body },
+        { object, body, skipTriggers },
         {
           object: { type: 'string', required: true },
           body: { type: 'object', required: true },
+          skipTriggers: { type: 'boolean', required: false },
         },
       );
 
       const params = { body };
+      if (skipTriggers) params.query = { skipTriggers: true };
       return await this.sdk._fetch(`/object/${object}`, 'POST', params);
     }
 
@@ -336,12 +364,29 @@ export class ObjectsService {
     throw new Error('Invalid arguments for create method');
   }
 
-  async delete({ object, where }) {
+  /**
+   * Delete records matching a where clause.
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {object} args.where
+   * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @returns {Promise} Delete result
+   *
+   * @example
+   * await sdk.objects.delete({
+   *   object: 'people',
+   *   where: { id: '013…' },
+   *   skipTriggers: true,
+   * });
+   */
+  async delete({ object, where, skipTriggers = false }) {
     this.sdk.validateParams(
-      { object, where },
+      { object, where, skipTriggers },
       {
         object: { type: 'string', required: true },
         where: { type: 'object', required: true },
+        skipTriggers: { type: 'boolean', required: false },
       },
     );
 
@@ -350,17 +395,31 @@ export class ObjectsService {
         where,
       },
     };
+    if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await this.sdk._fetch(`/object/${object}`, 'DELETE', params);
     return result;
   }
 
-  async deleteById({ object, id }) {
+  /**
+   * Delete a record by id.
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {string} args.id
+   * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @returns {Promise} Delete result
+   *
+   * @example
+   * await sdk.objects.deleteById({ object: 'people', id: '013…', skipTriggers: true });
+   */
+  async deleteById({ object, id, skipTriggers = false }) {
     this.sdk.validateParams(
-      { object, id },
+      { object, id, skipTriggers },
       {
         object: { type: 'string', required: true },
         id: { type: 'string', required: true },
+        skipTriggers: { type: 'boolean', required: false },
       },
     );
 
@@ -371,6 +430,7 @@ export class ObjectsService {
         },
       },
     };
+    if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await this.sdk._fetch(`/object/${object}`, 'DELETE', params);
     return result;
@@ -940,4 +1000,83 @@ export class ObjectsService {
     );
     return result;
   }
+
+  /**
+   * List Google Ads customer IDs for an OAuth connection.
+   *
+   * @param {object} args
+   * @param {string} args.connectionId
+   * @returns {Promise<{results: object[], warning?: string|null}>}
+   */
+  async listGoogleAdAccounts({ connectionId }) {
+    this.sdk.validateParams(
+      { connectionId },
+      { connectionId: { type: 'string', required: true } },
+    );
+    return this.sdk._fetch('/object/ad-catalog/google/accounts', 'GET', {
+      query: { connectionId },
+    });
+  }
+
+  /**
+   * List Google Ads campaigns for a customer.
+   *
+   * @param {object} args
+   * @param {string} args.connectionId
+   * @param {string} args.customerId
+   * @param {string} [args.loginCustomerId]
+   * @returns {Promise<{results: object[]}>}
+   */
+  async listGoogleAdCampaigns({ connectionId, customerId, loginCustomerId }) {
+    this.sdk.validateParams(
+      { connectionId, customerId },
+      {
+        connectionId: { type: 'string', required: true },
+        customerId: { type: 'string', required: true },
+      },
+    );
+    const query = { connectionId, customerId };
+    if (loginCustomerId) query.loginCustomerId = loginCustomerId;
+    return this.sdk._fetch('/object/ad-catalog/google/campaigns', 'GET', {
+      query,
+    });
+  }
+
+  /**
+   * List Meta ad accounts for an OAuth connection.
+   *
+   * @param {object} args
+   * @param {string} args.connectionId
+   * @returns {Promise<{results: object[]}>}
+   */
+  async listMetaAdAccounts({ connectionId }) {
+    this.sdk.validateParams(
+      { connectionId },
+      { connectionId: { type: 'string', required: true } },
+    );
+    return this.sdk._fetch('/object/ad-catalog/meta/accounts', 'GET', {
+      query: { connectionId },
+    });
+  }
+
+  /**
+   * List Meta campaigns for an ad account.
+   *
+   * @param {object} args
+   * @param {string} args.connectionId
+   * @param {string} args.adAccountId
+   * @returns {Promise<{results: object[]}>}
+   */
+  async listMetaAdCampaigns({ connectionId, adAccountId }) {
+    this.sdk.validateParams(
+      { connectionId, adAccountId },
+      {
+        connectionId: { type: 'string', required: true },
+        adAccountId: { type: 'string', required: true },
+      },
+    );
+    return this.sdk._fetch('/object/ad-catalog/meta/campaigns', 'GET', {
+      query: { connectionId, adAccountId },
+    });
+  }
 }

package/services/permissions.js

@@ -374,4 +374,115 @@ export class PermissionsService {
     const result = await this.sdk._fetch('/permissions/scope-catalog', 'GET');
     return result;
   }
+
+  /**
+   * Catalog of group-settable configuration keys, plus the never-settable list.
+   * @returns {Promise<Object>} { groupSettable: [{key,label,type,pillar,...}], neverSettable: [] }
+   */
+  async getSettingsCatalog() {
+    return this.sdk._fetch('/permissions/settings/catalog', 'GET');
+  }
+
+  /**
+   * Configuration values set at group level.
+   * @param {string|number} groupId - Group ID (required)
+   * @returns {Promise<Object>} { results: [{settingKey, value, updatedAt}] }
+   */
+  async listGroupSettings(groupId) {
+    groupId = String(groupId);
+    this.sdk.validateParams({ groupId }, { groupId: { type: 'string', required: true } });
+    return this.sdk._fetch(`/permissions/groups/${groupId}/settings`, 'GET');
+  }
+
+  /** Set one configuration value on a group. */
+  async setGroupSetting(groupId, settingKey, value) {
+    groupId = String(groupId);
+    settingKey = String(settingKey);
+    this.sdk.validateParams(
+      { groupId, settingKey },
+      {
+        groupId: { type: 'string', required: true },
+        settingKey: { type: 'string', required: true },
+      },
+    );
+    return this.sdk._fetch(
+      `/permissions/groups/${groupId}/settings/${settingKey}`,
+      'PUT',
+      { value },
+    );
+  }
+
+  /** Unset one configuration value on a group (members revert to the next tier). */
+  async deleteGroupSetting(groupId, settingKey) {
+    groupId = String(groupId);
+    settingKey = String(settingKey);
+    this.sdk.validateParams(
+      { groupId, settingKey },
+      {
+        groupId: { type: 'string', required: true },
+        settingKey: { type: 'string', required: true },
+      },
+    );
+    return this.sdk._fetch(
+      `/permissions/groups/${groupId}/settings/${settingKey}`,
+      'DELETE',
+    );
+  }
+
+  /**
+   * Rank groups for same-key conflict resolution; first entry wins.
+   * @param {Array<string|number>} order - Group IDs, highest priority first
+   */
+  async setGroupPriority(order) {
+    this.sdk.validateParams({ order }, { order: { type: 'array', required: true } });
+    return this.sdk._fetch('/permissions/groups/priority', 'PUT', {
+      order: order.map(String),
+    });
+  }
+
+  /**
+   * Resolved configuration for a user: value, where it came from, and any
+   * losing group values for the same key.
+   * @returns {Promise<Object>} { [key]: { value, source: {tier, groupId, groupName}, conflicts: [] } }
+   */
+  async getUserSettings(userId) {
+    userId = String(userId);
+    this.sdk.validateParams({ userId }, { userId: { type: 'string', required: true } });
+    return this.sdk._fetch(`/permissions/users/${userId}/settings`, 'GET');
+  }
+
+  /** Override one configuration value for a single user. */
+  async setUserSetting(userId, settingKey, value) {
+    userId = String(userId);
+    settingKey = String(settingKey);
+    this.sdk.validateParams(
+      { userId, settingKey },
+      {
+        userId: { type: 'string', required: true },
+        settingKey: { type: 'string', required: true },
+      },
+    );
+    return this.sdk._fetch(
+      `/permissions/users/${userId}/settings/${settingKey}`,
+      'PUT',
+      { value },
+    );
+  }
+
+  /** Clear a user's override, reverting to the inherited value. */
+  async deleteUserSetting(userId, settingKey) {
+    userId = String(userId);
+    settingKey = String(settingKey);
+    this.sdk.validateParams(
+      { userId, settingKey },
+      {
+        userId: { type: 'string', required: true },
+        settingKey: { type: 'string', required: true },
+      },
+    );
+    return this.sdk._fetch(
+      `/permissions/users/${userId}/settings/${settingKey}`,
+      'DELETE',
+    );
+  }
 }

package/services/storage.js

@@ -463,7 +463,7 @@ Response:
    * @param {string} [config.convertTo] - Convert uploaded file to this format before storing. Supported: 'pdf', 'tiff'. Input must be PDF, DOC, or DOCX.
    * @param {Object} [config.convertOptions] - Options for file conversion (used with convertTo)
    * @param {('fine'|'normal')} [config.convertOptions.resolution='fine'] - Fax resolution: 'fine' (204x196) or 'normal' (204x98)
-   * @param {('letter'|'a4')} [config.convertOptions.paperSize='letter'] - Paper size for conversion
+   * @param {('letter'|'legal'|'a4')} [config.convertOptions.paperSize='letter'] - Paper size for conversion
    * @param {('g4'|'g3')} [config.convertOptions.compression='g4'] - TIFF compression: 'g4' (default) or 'g3' for older fax machines
    * @param {Function} [config.onProgress] - Progress callback for browser uploads
    * @param {Object} [config._options] - Internal options
@@ -1005,7 +1005,7 @@ Response:
    * @param {string} config.convertTo - Target format: 'pdf' or 'tiff' (required)
    * @param {Object} [config.convertOptions] - Options controlling the conversion output
    * @param {('fine'|'normal')} [config.convertOptions.resolution='fine'] - Fax resolution: 'fine' (204x196 DPI) or 'normal' (204x98 DPI)
-   * @param {('letter'|'a4')} [config.convertOptions.paperSize='letter'] - Paper size for conversion
+   * @param {('letter'|'legal'|'a4')} [config.convertOptions.paperSize='letter'] - Paper size for conversion
    * @param {('g4'|'g3')} [config.convertOptions.compression='g4'] - TIFF compression: 'g4' (modern, default) or 'g3' (legacy fax machines)
    * @param {string} [config.classification] - Storage classification for the new file. Defaults to source file's classification.
    * @param {string} [config.folder] - Folder path for the new file. Defaults to source file's folder.

package/test-complete-coverage.js

@@ -41,6 +41,7 @@ async function testPublicSDKCompleteness() {
     'phoneNumbers',
     'recordTypes',
     'generateId',
+    'documents',
   ];
 
   console.log(`📊 Checking ${publicServices.length} public services...`);