@unboundcx/sdk 4.5.0 → 4.6.1

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/services/triggers.js

@@ -0,0 +1,245 @@
+/**
+ * Triggers Service — object-change automations (workflow or outbound webhook).
+ *
+ * Watch create/update/delete on a trigger-enabled object, filter on the
+ * current row and/or the field that changed, then run a workflow session
+ * or POST to a URL.
+ *
+ * @example
+ * const { results } = await sdk.triggers.list({ objectName: 'people' });
+ *
+ * @example
+ * await sdk.triggers.create({
+ *   name: 'Hot lead',
+ *   objectName: 'people',
+ *   actions: ['update'],
+ *   recordFilter: { type: { op: 'eq', value: 'lead' } },
+ *   changeFilters: [{
+ *     field: 'leadScore',
+ *     previous: { op: 'lt', value: 20 },
+ *     updated: { op: 'gt', value: 100 },
+ *   }],
+ *   actionType: 'workflow',
+ *   actionConfig: { workflowVersionId: '052…' },
+ * });
+ */
+export class TriggersService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List objects that may have triggers (`objectMetaData.triggersEnabled`).
+   *
+   * @returns {Promise<{results: Array<{id: string, name: string}>}>}
+   *
+   * @example
+   * const { results } = await sdk.triggers.listObjects();
+   */
+  async listObjects() {
+    return this.sdk._fetch('/triggers/objects', 'GET', {});
+  }
+
+  /**
+   * List triggers for the account.
+   *
+   * @param {object} [args]
+   * @param {string} [args.objectName] - Filter to one object (e.g. `'people'`)
+   * @param {('enabled'|'paused'|'disabled')} [args.status]
+   * @param {number} [args.limit=200]
+   * @returns {Promise<{results: object[]}>}
+   *
+   * @example
+   * await sdk.triggers.list({ objectName: 'people', status: 'enabled' });
+   */
+  async list({ objectName, status, limit } = {}) {
+    const query = {};
+    if (objectName) query.objectName = objectName;
+    if (status) query.status = status;
+    if (limit) query.limit = limit;
+    return this.sdk._fetch('/triggers/', 'GET', { query });
+  }
+
+  /**
+   * Get a trigger by id.
+   *
+   * @param {string} id
+   * @returns {Promise<object>}
+   *
+   * @example
+   * const trigger = await sdk.triggers.get('173…');
+   */
+  async get(id) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    return this.sdk._fetch(`/triggers/${id}`, 'GET', {});
+  }
+
+  /**
+   * Create a trigger.
+   *
+   * @param {object} args
+   * @param {string} args.name
+   * @param {string} [args.description]
+   * @param {string} args.objectName - Must have `triggersEnabled` (people, company, opportunities, projects, or custom `__c`)
+   * @param {Array<'create'|'update'|'delete'>} args.actions
+   * @param {('enabled'|'paused'|'disabled')} [args.status='enabled']
+   * @param {Object<string, {op: string, value: *}|*>} [args.recordFilter] - Current-row match (new row on create/update, old on delete)
+   * @param {Array<{field: string, previous?: {op: string, value: *}, updated?: {op: string, value: *}}>} [args.changeFilters] - Field must be in `changedFields`; optional previous/updated checks
+   * @param {('workflow'|'webhook')} args.actionType
+   * @param {object} args.actionConfig
+   * @param {string} [args.actionConfig.workflowVersionId] - Required when `actionType` is `'workflow'`
+   * @param {string} [args.actionConfig.workflowId]
+   * @param {string[]} [args.actionConfig.includeValues] - Field values to include (previous + updated). Empty = names only. `['*']` = every non-encrypted field. Encrypted columns are never sent.
+   * @param {string} [args.actionConfig.primaryUrl] - Required when `actionType` is `'webhook'`; must be `https://`
+   * @param {string} [args.actionConfig.secondaryUrl] - Failover URL; must be `https://` if set
+   * @param {string} [args.actionConfig.credentialId] - Stored webhook authorization id
+   * @param {number} [args.timeoutMinutes=15] - Queued-fire TTL, 1–1440
+   * @param {number} [args.retries=3] - Webhook retries, 0–5
+   * @returns {Promise<object>} Created trigger
+   *
+   * @example
+   * await sdk.triggers.create({
+   *   name: 'Notify CRM',
+   *   objectName: 'people',
+   *   actions: ['update'],
+   *   actionType: 'webhook',
+   *   actionConfig: {
+   *     primaryUrl: 'https://example.com/hooks/lead',
+   *     secondaryUrl: 'https://backup.example.com/hooks/lead',
+   *     includeValues: ['leadScore', 'email'],
+   *   },
+   *   timeoutMinutes: 15,
+   *   retries: 3,
+   * });
+   */
+  async create({
+    name,
+    description,
+    objectName,
+    actions,
+    status,
+    recordFilter,
+    changeFilters,
+    actionType,
+    actionConfig,
+    timeoutMinutes,
+    retries,
+    recordTypeId,
+  }) {
+    const body = {
+      name,
+      description,
+      objectName,
+      actions,
+      status,
+      recordFilter,
+      changeFilters,
+      actionType,
+      actionConfig,
+      timeoutMinutes,
+      retries,
+      recordTypeId,
+    };
+
+    this.sdk.validateParams(
+      { name, objectName, actions, actionType, actionConfig },
+      {
+        name: { type: 'string', required: true },
+        objectName: { type: 'string', required: true },
+        actions: { type: 'object', required: true },
+        actionType: { type: 'string', required: true },
+        actionConfig: { type: 'object', required: true },
+      },
+    );
+
+    return this.sdk._fetch('/triggers/', 'POST', { body });
+  }
+
+  /**
+   * Update a trigger. Only provided fields are changed.
+   *
+   * @param {string} id
+   * @param {object} args - Same shape as {@link TriggersService#create}; all keys optional
+   * @returns {Promise<object>} Updated trigger
+   *
+   * @example
+   * await sdk.triggers.update('173…', { status: 'paused' });
+   */
+  async update(id, args = {}) {
+    this.sdk.validateParams(
+      { id, args },
+      {
+        id: { type: 'string', required: true },
+        args: { type: 'object', required: true },
+      },
+    );
+    return this.sdk._fetch(`/triggers/${id}`, 'PUT', { body: args });
+  }
+
+  /**
+   * Soft-delete a trigger.
+   *
+   * @param {string} id
+   * @returns {Promise<{id: string, deleted: boolean}>}
+   *
+   * @example
+   * await sdk.triggers.delete('173…');
+   */
+  async delete(id) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    return this.sdk._fetch(`/triggers/${id}`, 'DELETE', {});
+  }
+
+  /**
+   * Alias of {@link TriggersService#delete}.
+   *
+   * @param {string} id
+   * @returns {Promise<{id: string, deleted: boolean}>}
+   */
+  async remove(id) {
+    return this.delete(id);
+  }
+
+  /**
+   * Set trigger status without a full update.
+   *
+   * @param {string} id
+   * @param {('enabled'|'paused'|'disabled')} status
+   * @param {object} [opts]
+   * @param {string} [opts.pausedReason] - Stored when `status` is `'paused'`
+   * @returns {Promise<object>} Updated trigger
+   *
+   * @example
+   * await sdk.triggers.setStatus('173…', 'paused', { pausedReason: 'rate limit' });
+   */
+  async setStatus(id, status, { pausedReason } = {}) {
+    this.sdk.validateParams(
+      { id, status },
+      {
+        id: { type: 'string', required: true },
+        status: { type: 'string', required: true },
+      },
+    );
+    return this.sdk._fetch(`/triggers/${id}/status`, 'POST', {
+      body: { status, pausedReason },
+    });
+  }
+
+  /**
+   * Recent execution log for a trigger (queued / fired / dropped / rejected / timeout).
+   *
+   * @param {string} id
+   * @param {object} [opts]
+   * @param {number} [opts.limit=50]
+   * @returns {Promise<{results: object[]}>}
+   *
+   * @example
+   * const { results } = await sdk.triggers.listFires('173…', { limit: 20 });
+   */
+  async listFires(id, { limit } = {}) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    const query = {};
+    if (limit) query.limit = limit;
+    return this.sdk._fetch(`/triggers/${id}/fires`, 'GET', { query });
+  }
+}

package/test-complete-coverage.js

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