@knocklabs/node 1.32.0 → 1.34.0

package/src/resources/users/bulk.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as BulkOperationsAPI from '../bulk-operations';
+import * as Shared from '../shared';
 import * as PreferencesAPI from '../recipients/preferences';
 import * as UsersAPI from './users';
 import { APIPromise } from '../../core/api-promise';
@@ -60,7 +61,6 @@ export class Bulk extends APIResource {
    * const bulkOperation =
    *   await client.users.bulk.setPreferences({
    *     preferences: {
-   *       __persistence_strategy__: 'merge',
    *       categories: {
    *         marketing: false,
    *         transactional: { channel_types: { email: false } },
@@ -79,6 +79,7 @@ export class Bulk extends APIResource {
    *         'aef6e715-df82-4ab6-b61e-b743e249f7b6': true,
    *       },
    *       commercial_subscribed: true,
+   *       id: 'default',
    *       workflows: {
    *         'dinosaurs-loose': {
    *           channel_types: { email: false },
@@ -113,9 +114,10 @@ export interface BulkIdentifyParams {
 
 export interface BulkSetPreferencesParams {
   /**
-   * A request to set a preference set for a recipient.
+   * A preference set to apply in a bulk operation. Always replaces existing
+   * preferences for the specified set.
    */
-  preferences: PreferencesAPI.PreferenceSetRequest;
+  preferences: BulkSetPreferencesParams.Preferences;
 
   /**
    * A list of user IDs.
@@ -123,6 +125,91 @@ export interface BulkSetPreferencesParams {
   user_ids: Array<string>;
 }
 
+export namespace BulkSetPreferencesParams {
+  /**
+   * A preference set to apply in a bulk operation. Always replaces existing
+   * preferences for the specified set.
+   */
+  export interface Preferences {
+    /**
+     * Identifier for the preference set to update. Can be `default` or a tenant ID.
+     */
+    id?: string;
+
+    /**
+     * An object where the key is the category and the values are the preference
+     * settings for that category.
+     */
+    categories?: { [key: string]: boolean | Preferences.PreferenceSetWorkflowCategorySettingObject } | null;
+
+    /**
+     * Channel type preferences.
+     */
+    channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+    /**
+     * Channel preferences.
+     */
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
+    /**
+     * Whether the recipient is subscribed to commercial communications. When false,
+     * the recipient will not receive commercial workflow notifications.
+     */
+    commercial_subscribed?: boolean | null;
+
+    /**
+     * An object where the key is the workflow key and the values are the preference
+     * settings for that workflow.
+     */
+    workflows?: { [key: string]: boolean | Preferences.PreferenceSetWorkflowCategorySettingObject } | null;
+  }
+
+  export namespace Preferences {
+    /**
+     * The settings object for a workflow or category, where you can specify channel
+     * types or conditions.
+     */
+    export interface PreferenceSetWorkflowCategorySettingObject {
+      /**
+       * Channel type preferences.
+       */
+      channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+      /**
+       * Channel preferences.
+       */
+      channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
+      /**
+       * A list of conditions to apply to a channel type.
+       */
+      conditions?: Array<Shared.Condition> | null;
+    }
+
+    /**
+     * The settings object for a workflow or category, where you can specify channel
+     * types or conditions.
+     */
+    export interface PreferenceSetWorkflowCategorySettingObject {
+      /**
+       * Channel type preferences.
+       */
+      channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+      /**
+       * Channel preferences.
+       */
+      channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
+      /**
+       * A list of conditions to apply to a channel type.
+       */
+      conditions?: Array<Shared.Condition> | null;
+    }
+  }
+}
+
 export declare namespace Bulk {
   export {
     type BulkDeleteParams as BulkDeleteParams,

package/src/resources/workflows.ts

@@ -58,6 +58,7 @@ export class Workflows extends APIResource {
    *     severity: 'critical',
    *     system_status: 'fences_failing',
    *   },
+   *   settings: { sandbox_mode: true, skip_delay: true },
    *   tenant: 'ingen_isla_nublar',
    * });
    * ```
@@ -84,11 +85,11 @@ export interface WorkflowTriggerResponse {
 
 export interface WorkflowCancelParams {
   /**
-   * An optional key that is used to reference a specific workflow trigger request
-   * when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-   * request. Must be provided while triggering a workflow in order to enable
-   * subsequent cancellation. Should be unique across trigger requests to avoid
-   * unintentional cancellations.
+   * A key that is used to reference a specific workflow trigger request when issuing
+   * a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+   * be provided while triggering a workflow in order to enable subsequent
+   * cancellation. Should be unique across trigger requests to avoid unintentional
+   * cancellations.
    */
   cancellation_key: string;
 
@@ -114,11 +115,11 @@ export interface WorkflowTriggerParams {
   actor?: RecipientsAPI.RecipientRequest | null;
 
   /**
-   * An optional key that is used to reference a specific workflow trigger request
-   * when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-   * request. Must be provided while triggering a workflow in order to enable
-   * subsequent cancellation. Should be unique across trigger requests to avoid
-   * unintentional cancellations.
+   * A key that is used to reference a specific workflow trigger request when issuing
+   * a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+   * be provided while triggering a workflow in order to enable subsequent
+   * cancellation. Should be unique across trigger requests to avoid unintentional
+   * cancellations.
    */
   cancellation_key?: string | null;
 
@@ -130,12 +131,37 @@ export interface WorkflowTriggerParams {
    */
   data?: { [key: string]: unknown } | null;
 
+  /**
+   * Optional settings that control how this workflow trigger is executed.
+   */
+  settings?: WorkflowTriggerParams.Settings | null;
+
   /**
    * An request to set a tenant inline.
    */
   tenant?: TenantsAPI.InlineTenantRequest | null;
 }
 
+export namespace WorkflowTriggerParams {
+  /**
+   * Optional settings that control how this workflow trigger is executed.
+   */
+  export interface Settings {
+    /**
+     * When set to true, overrides the sandbox mode for all channels in this workflow
+     * run, messages are not delivered to the underlying providers. If false or not
+     * set, the workflow delivers messages normally.
+     */
+    sandbox_mode?: boolean | null;
+
+    /**
+     * When set to true, skips all delay steps in the workflow for this trigger
+     * request. If false or not set, delay steps execute normally.
+     */
+    skip_delay?: boolean | null;
+  }
+}
+
 export declare namespace Workflows {
   export {
     type WorkflowTriggerResponse as WorkflowTriggerResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.32.0'; // x-release-please-version
+export const VERSION = '1.34.0'; // x-release-please-version

package/uploads.d.mts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/uploads.d.ts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.js";
 //# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}

package/uploads.mjs

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.32.0";
+export declare const VERSION = "1.34.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.32.0";
+export declare const VERSION = "1.34.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.32.0'; // x-release-please-version
+exports.VERSION = '1.34.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.32.0'; // x-release-please-version
+export const VERSION = '1.34.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map